Class VkBindBufferMemoryDeviceGroupInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkBindBufferMemoryDeviceGroupInfoKHR
Description
If the pNext chain of VkBindBufferMemoryInfo includes a VkBindBufferMemoryDeviceGroupInfo structure, then that structure determines how memory is bound to buffers across multiple devices in a device group.
If deviceIndexCount is greater than zero, then on device index i the buffer is attached to the instance of memory on the physical device with device index pDeviceIndices[i].
If deviceIndexCount is zero and memory comes from a memory heap with the MEMORY_HEAP_MULTI_INSTANCE_BIT bit set, then it is as if pDeviceIndices contains consecutive indices from zero to the number of physical devices in the logical device, minus one. In other words, by default each physical device attaches to its own instance of memory.
If deviceIndexCount is zero and memory comes from a memory heap without the MEMORY_HEAP_MULTI_INSTANCE_BIT bit set, then it is as if pDeviceIndices contains an array of zeros. In other words, by default each physical device attaches to instance zero.
Valid Usage
deviceIndexCountmust either be zero or equal to the number of physical devices in the logical device- All elements of
pDeviceIndicesmust be valid device indices
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFO- If
deviceIndexCountis not 0,pDeviceIndicesmust be a valid pointer to an array ofdeviceIndexCountuint32_tvalues
Layout
struct VkBindBufferMemoryDeviceGroupInfo {
VkStructureType sType();
void const * pNext();
uint32_t deviceIndexCount();
uint32_t const * pDeviceIndices();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkBindBufferMemoryDeviceGroupInfostructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkBindBufferMemoryDeviceGroupInfo(ByteBuffer container) Creates aVkBindBufferMemoryDeviceGroupInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkBindBufferMemoryDeviceGroupInfoinstance for the specified memory address.create(long address, int capacity) Create aVkBindBufferMemoryDeviceGroupInfo.Bufferinstance at the specified memory.static @Nullable VkBindBufferMemoryDeviceGroupInfocreateSafe(long address) static @Nullable VkBindBufferMemoryDeviceGroupInfo.BuffercreateSafe(long address, int capacity) intthe number of elements inpDeviceIndices.malloc()Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intndeviceIndexCount(long struct) Unsafe version ofdeviceIndexCount().static voidndeviceIndexCount(long struct, int value) Sets the specified value to thedeviceIndexCountfield of the specifiedstruct.static @Nullable IntBuffernpDeviceIndices(long struct) Unsafe version ofpDeviceIndices.static voidnpDeviceIndices(long struct, @Nullable IntBuffer value) Unsafe version ofpDeviceIndices.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.@Nullable IntBuffera pointer to an array of device indices.pDeviceIndices(@Nullable IntBuffer value) Sets the address of the specifiedIntBufferto thepDeviceIndices()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFOvalue to thesType()field.static voidvalidate(long struct) Validates pointer members that should not beNULL.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
DEVICEINDEXCOUNT
public static final int DEVICEINDEXCOUNTThe struct member offsets. -
PDEVICEINDICES
public static final int PDEVICEINDICESThe struct member offsets.
-
-
Constructor Details
-
VkBindBufferMemoryDeviceGroupInfo
Creates aVkBindBufferMemoryDeviceGroupInfoinstance at the current position of the specifiedByteBuffercontainer. 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()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkBindBufferMemoryDeviceGroupInfo>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
deviceIndexCount
public int deviceIndexCount()the number of elements inpDeviceIndices. -
pDeviceIndices
a pointer to an array of device indices. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pDeviceIndices
Sets the address of the specifiedIntBufferto thepDeviceIndices()field. -
set
public VkBindBufferMemoryDeviceGroupInfo set(int sType, long pNext, @Nullable IntBuffer pDeviceIndices) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated withBufferUtils. -
create
Returns a newVkBindBufferMemoryDeviceGroupInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkBindBufferMemoryDeviceGroupInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkBindBufferMemoryDeviceGroupInfo.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
@Deprecated public static VkBindBufferMemoryDeviceGroupInfo mallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
@Deprecated public static VkBindBufferMemoryDeviceGroupInfo callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkBindBufferMemoryDeviceGroupInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkBindBufferMemoryDeviceGroupInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkBindBufferMemoryDeviceGroupInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkBindBufferMemoryDeviceGroupInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
ndeviceIndexCount
public static int ndeviceIndexCount(long struct) Unsafe version ofdeviceIndexCount(). -
npDeviceIndices
Unsafe version ofpDeviceIndices. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
ndeviceIndexCount
public static void ndeviceIndexCount(long struct, int value) Sets the specified value to thedeviceIndexCountfield of the specifiedstruct. -
npDeviceIndices
Unsafe version ofpDeviceIndices. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-