Class VkBindBufferMemoryInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBindBufferMemoryInfo>

org.lwjgl.vulkan.VkBindBufferMemoryInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkBindBufferMemoryInfoKHR

public class VkBindBufferMemoryInfo
extends Struct<VkBindBufferMemoryInfo>
implements NativeResource

struct VkBindBufferMemoryInfo {
    VkStructureType sType;
    void const * pNext;
    VkBuffer buffer;
    VkDeviceMemory memory;
    VkDeviceSize memoryOffset;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkBindBufferMemoryInfo.Buffer	An array of VkBindBufferMemoryInfo structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	BUFFER	The struct member offsets.
static final int	MEMORY	The struct member offsets.
static final int	MEMORYOFFSET	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkBindBufferMemoryInfo(ByteBuffer container)	Creates a VkBindBufferMemoryInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
long	buffer()
VkBindBufferMemoryInfo	buffer(long value)	Sets the specified value to the buffer field.
static VkBindBufferMemoryInfo	calloc()	Returns a new VkBindBufferMemoryInfo instance allocated with memCalloc.
static VkBindBufferMemoryInfo.Buffer	calloc(int capacity)	Returns a new VkBindBufferMemoryInfo.Buffer instance allocated with memCalloc.
static VkBindBufferMemoryInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkBindBufferMemoryInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBindBufferMemoryInfo	calloc(MemoryStack stack)	Returns a new VkBindBufferMemoryInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBindBufferMemoryInfo	create()	Returns a new VkBindBufferMemoryInfo instance allocated with BufferUtils.
static VkBindBufferMemoryInfo.Buffer	create(int capacity)	Returns a new VkBindBufferMemoryInfo.Buffer instance allocated with BufferUtils.
static VkBindBufferMemoryInfo	create(long address)	Returns a new VkBindBufferMemoryInfo instance for the specified memory address.
static VkBindBufferMemoryInfo.Buffer	create(long address, int capacity)	Create a VkBindBufferMemoryInfo.Buffer instance at the specified memory.
static @Nullable VkBindBufferMemoryInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkBindBufferMemoryInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkBindBufferMemoryInfo	malloc()	Returns a new VkBindBufferMemoryInfo instance allocated with memAlloc.
static VkBindBufferMemoryInfo.Buffer	malloc(int capacity)	Returns a new VkBindBufferMemoryInfo.Buffer instance allocated with memAlloc.
static VkBindBufferMemoryInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkBindBufferMemoryInfo.Buffer instance allocated on the specified MemoryStack.
static VkBindBufferMemoryInfo	malloc(MemoryStack stack)	Returns a new VkBindBufferMemoryInfo instance allocated on the specified MemoryStack.
long	memory()
VkBindBufferMemoryInfo	memory(long value)	Sets the specified value to the memory field.
long	memoryOffset()
VkBindBufferMemoryInfo	memoryOffset(long value)	Sets the specified value to the memoryOffset field.
static long	nbuffer(long struct)	Unsafe version of buffer().
static void	nbuffer(long struct, long value)	Unsafe version of buffer.
static long	nmemory(long struct)	Unsafe version of memory().
static void	nmemory(long struct, long value)	Unsafe version of memory.
static long	nmemoryOffset(long struct)	Unsafe version of memoryOffset().
static void	nmemoryOffset(long struct, long value)	Unsafe version of memoryOffset.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()
VkBindBufferMemoryInfo	pNext(long value)	Sets the specified value to the pNext field.
VkBindBufferMemoryInfo	pNext(VkBindBufferMemoryDeviceGroupInfo value)	Prepends the specified VkBindBufferMemoryDeviceGroupInfo value to the pNext chain.
VkBindBufferMemoryInfo	pNext(VkBindBufferMemoryDeviceGroupInfoKHR value)	Prepends the specified VkBindBufferMemoryDeviceGroupInfoKHR value to the pNext chain.
VkBindBufferMemoryInfo	pNext(VkBindMemoryStatus value)	Prepends the specified VkBindMemoryStatus value to the pNext chain.
VkBindBufferMemoryInfo	pNext(VkBindMemoryStatusKHR value)	Prepends the specified VkBindMemoryStatusKHR value to the pNext chain.
VkBindBufferMemoryInfo	set(int sType, long pNext, long buffer, long memory, long memoryOffset)	Initializes this struct with the specified values.
VkBindBufferMemoryInfo	set(VkBindBufferMemoryInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkBindBufferMemoryInfo	sType(int value)	Sets the specified value to the sType field.
VkBindBufferMemoryInfo	sType$Default()	Sets the STRUCTURE_TYPE_BIND_BUFFER_MEMORY_INFO value to the sType field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

BUFFER

public static final int BUFFER

The struct member offsets.

MEMORY

public static final int MEMORY

The struct member offsets.

MEMORYOFFSET

public static final int MEMORYOFFSET

The struct member offsets.

Constructor Details

VkBindBufferMemoryInfo

public VkBindBufferMemoryInfo(ByteBuffer container)

Creates a VkBindBufferMemoryInfo instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkBindBufferMemoryInfo>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

buffer

@NativeType("VkBuffer")
public long buffer()

Returns:

the value of the buffer field.

memory

@NativeType("VkDeviceMemory")
public long memory()

Returns:

the value of the memory field.

memoryOffset

@NativeType("VkDeviceSize")
public long memoryOffset()

Returns:

the value of the memoryOffset field.

sType

public VkBindBufferMemoryInfo sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkBindBufferMemoryInfo sType$Default()

Sets the STRUCTURE_TYPE_BIND_BUFFER_MEMORY_INFO value to the sType field.

pNext

public VkBindBufferMemoryInfo pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

pNext

public VkBindBufferMemoryInfo pNext(VkBindBufferMemoryDeviceGroupInfo value)

Prepends the specified VkBindBufferMemoryDeviceGroupInfo value to the pNext chain.

pNext

public VkBindBufferMemoryInfo pNext(VkBindBufferMemoryDeviceGroupInfoKHR value)

Prepends the specified VkBindBufferMemoryDeviceGroupInfoKHR value to the pNext chain.

pNext

public VkBindBufferMemoryInfo pNext(VkBindMemoryStatus value)

Prepends the specified VkBindMemoryStatus value to the pNext chain.

pNext

public VkBindBufferMemoryInfo pNext(VkBindMemoryStatusKHR value)

Prepends the specified VkBindMemoryStatusKHR value to the pNext chain.

buffer

public VkBindBufferMemoryInfo buffer(@NativeType("VkBuffer")
 long value)

Sets the specified value to the buffer field.

memory

public VkBindBufferMemoryInfo memory(@NativeType("VkDeviceMemory")
 long value)

Sets the specified value to the memory field.

memoryOffset

public VkBindBufferMemoryInfo memoryOffset(@NativeType("VkDeviceSize")
 long value)

Sets the specified value to the memoryOffset field.

set

public VkBindBufferMemoryInfo set(int sType,
 long pNext,
 long buffer,
 long memory,
 long memoryOffset)

Initializes this struct with the specified values.

set

public VkBindBufferMemoryInfo set(VkBindBufferMemoryInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkBindBufferMemoryInfo malloc()

Returns a new VkBindBufferMemoryInfo instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkBindBufferMemoryInfo calloc()

Returns a new VkBindBufferMemoryInfo instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkBindBufferMemoryInfo create()

Returns a new VkBindBufferMemoryInfo instance allocated with BufferUtils.

create

public static VkBindBufferMemoryInfo create(long address)

Returns a new VkBindBufferMemoryInfo instance for the specified memory address.

createSafe

public static @Nullable VkBindBufferMemoryInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkBindBufferMemoryInfo.Buffer malloc(int capacity)

Returns a new VkBindBufferMemoryInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkBindBufferMemoryInfo.Buffer calloc(int capacity)

Returns a new VkBindBufferMemoryInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkBindBufferMemoryInfo.Buffer create(int capacity)

Returns a new VkBindBufferMemoryInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkBindBufferMemoryInfo.Buffer create(long address,
 int capacity)

Create a VkBindBufferMemoryInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkBindBufferMemoryInfo.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkBindBufferMemoryInfo malloc(MemoryStack stack)

Returns a new VkBindBufferMemoryInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkBindBufferMemoryInfo calloc(MemoryStack stack)

Returns a new VkBindBufferMemoryInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkBindBufferMemoryInfo.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new VkBindBufferMemoryInfo.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkBindBufferMemoryInfo.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkBindBufferMemoryInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nbuffer

public static long nbuffer(long struct)

Unsafe version of buffer().

nmemory

public static long nmemory(long struct)

Unsafe version of memory().

nmemoryOffset

public static long nmemoryOffset(long struct)

Unsafe version of memoryOffset().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nbuffer

public static void nbuffer(long struct,
 long value)

Unsafe version of buffer.

nmemory

public static void nmemory(long struct,
 long value)

Unsafe version of memory.

nmemoryOffset

public static void nmemoryOffset(long struct,
 long value)

Unsafe version of memoryOffset.