Class VkBindBufferMemoryDeviceGroupInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkBindBufferMemoryDeviceGroupInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkBindBufferMemoryDeviceGroupInfoKHR
public class VkBindBufferMemoryDeviceGroupInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying device within a group to bind to.Description
If the
pNextchain ofVkBindBufferMemoryInfoincludes aVkBindBufferMemoryDeviceGroupInfostructure, then that structure determines how memory is bound to buffers across multiple devices in a device group.If
deviceIndexCountis greater than zero, then on device indexithe buffer is attached to the instance ofmemoryon the physical device with device indexpDeviceIndices[i].If
deviceIndexCountis zero andmemorycomes from a memory heap with theMEMORY_HEAP_MULTI_INSTANCE_BITbit set, then it is as ifpDeviceIndicescontains 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 ofmemory.If
deviceIndexCountis zero andmemorycomes from a memory heap without theMEMORY_HEAP_MULTI_INSTANCE_BITbit set, then it is as ifpDeviceIndicescontains 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 { VkStructureTypesType(); void const *pNext(); uint32_tdeviceIndexCount(); uint32_t const *pDeviceIndices(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkBindBufferMemoryDeviceGroupInfo.BufferAn array ofVkBindBufferMemoryDeviceGroupInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intDEVICEINDEXCOUNT
PDEVICEINDICES
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkBindBufferMemoryDeviceGroupInfo(java.nio.ByteBuffer container)Creates aVkBindBufferMemoryDeviceGroupInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkBindBufferMemoryDeviceGroupInfocalloc()Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated withmemCalloc.static VkBindBufferMemoryDeviceGroupInfo.Buffercalloc(int capacity)Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated withmemCalloc.static VkBindBufferMemoryDeviceGroupInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBindBufferMemoryDeviceGroupInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBindBufferMemoryDeviceGroupInfocallocStack()Deprecated.static VkBindBufferMemoryDeviceGroupInfo.BuffercallocStack(int capacity)Deprecated.static VkBindBufferMemoryDeviceGroupInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkBindBufferMemoryDeviceGroupInfocallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkBindBufferMemoryDeviceGroupInfocreate()Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated withBufferUtils.static VkBindBufferMemoryDeviceGroupInfo.Buffercreate(int capacity)Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated withBufferUtils.static VkBindBufferMemoryDeviceGroupInfocreate(long address)Returns a newVkBindBufferMemoryDeviceGroupInfoinstance for the specified memory address.static VkBindBufferMemoryDeviceGroupInfo.Buffercreate(long address, int capacity)Create aVkBindBufferMemoryDeviceGroupInfo.Bufferinstance at the specified memory.static VkBindBufferMemoryDeviceGroupInfocreateSafe(long address)static VkBindBufferMemoryDeviceGroupInfo.BuffercreateSafe(long address, int capacity)intdeviceIndexCount()the number of elements inpDeviceIndices.static VkBindBufferMemoryDeviceGroupInfomalloc()Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated withmemAlloc.static VkBindBufferMemoryDeviceGroupInfo.Buffermalloc(int capacity)Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated withmemAlloc.static VkBindBufferMemoryDeviceGroupInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkBindBufferMemoryDeviceGroupInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated on the specifiedMemoryStack.static VkBindBufferMemoryDeviceGroupInfomallocStack()Deprecated.static VkBindBufferMemoryDeviceGroupInfo.BuffermallocStack(int capacity)Deprecated.static VkBindBufferMemoryDeviceGroupInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkBindBufferMemoryDeviceGroupInfomallocStack(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 java.nio.IntBuffernpDeviceIndices(long struct)Unsafe version ofpDeviceIndices.static voidnpDeviceIndices(long struct, java.nio.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.java.nio.IntBufferpDeviceIndices()a pointer to an array of device indices.VkBindBufferMemoryDeviceGroupInfopDeviceIndices(java.nio.IntBuffer value)Sets the address of the specifiedIntBufferto thepDeviceIndices()field.longpNext()NULLor a pointer to a structure extending this structure.VkBindBufferMemoryDeviceGroupInfopNext(long value)Sets the specified value to thepNext()field.VkBindBufferMemoryDeviceGroupInfoset(int sType, long pNext, java.nio.IntBuffer pDeviceIndices)Initializes this struct with the specified values.VkBindBufferMemoryDeviceGroupInfoset(VkBindBufferMemoryDeviceGroupInfo src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkBindBufferMemoryDeviceGroupInfosType(int value)Sets the specified value to thesType()field.VkBindBufferMemoryDeviceGroupInfosType$Default()Sets theSTRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFOvalue to thesType()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
VkBindBufferMemoryDeviceGroupInfo
public VkBindBufferMemoryDeviceGroupInfo(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of 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
@Nullable public java.nio.IntBuffer pDeviceIndices()
a pointer to an array of device indices.
-
sType
public VkBindBufferMemoryDeviceGroupInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkBindBufferMemoryDeviceGroupInfo sType$Default()
Sets theSTRUCTURE_TYPE_BIND_BUFFER_MEMORY_DEVICE_GROUP_INFOvalue to thesType()field.
-
pNext
public VkBindBufferMemoryDeviceGroupInfo pNext(long value)
Sets the specified value to thepNext()field.
-
pDeviceIndices
public VkBindBufferMemoryDeviceGroupInfo pDeviceIndices(@Nullable java.nio.IntBuffer value)
Sets the address of the specifiedIntBufferto thepDeviceIndices()field.
-
set
public VkBindBufferMemoryDeviceGroupInfo set(int sType, long pNext, @Nullable java.nio.IntBuffer pDeviceIndices)
Initializes this struct with the specified values.
-
set
public VkBindBufferMemoryDeviceGroupInfo set(VkBindBufferMemoryDeviceGroupInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkBindBufferMemoryDeviceGroupInfo malloc()
Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkBindBufferMemoryDeviceGroupInfo calloc()
Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkBindBufferMemoryDeviceGroupInfo create()
Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated withBufferUtils.
-
create
public static VkBindBufferMemoryDeviceGroupInfo create(long address)
Returns a newVkBindBufferMemoryDeviceGroupInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkBindBufferMemoryDeviceGroupInfo createSafe(long address)
-
malloc
public static VkBindBufferMemoryDeviceGroupInfo.Buffer malloc(int capacity)
Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkBindBufferMemoryDeviceGroupInfo.Buffer calloc(int capacity)
Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkBindBufferMemoryDeviceGroupInfo.Buffer create(int capacity)
Returns a newVkBindBufferMemoryDeviceGroupInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkBindBufferMemoryDeviceGroupInfo.Buffer create(long address, int capacity)
Create aVkBindBufferMemoryDeviceGroupInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkBindBufferMemoryDeviceGroupInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkBindBufferMemoryDeviceGroupInfo mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkBindBufferMemoryDeviceGroupInfo 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 public static VkBindBufferMemoryDeviceGroupInfo.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkBindBufferMemoryDeviceGroupInfo.Buffer callocStack(int capacity)
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
public static VkBindBufferMemoryDeviceGroupInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkBindBufferMemoryDeviceGroupInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkBindBufferMemoryDeviceGroupInfo calloc(org.lwjgl.system.MemoryStack stack)
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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
@Nullable public static java.nio.IntBuffer npDeviceIndices(long struct)
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
public static void npDeviceIndices(long struct, @Nullable java.nio.IntBuffer value)Unsafe version ofpDeviceIndices.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-