Package org.lwjgl.vulkan
Class VkDescriptorSetAllocateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDescriptorSetAllocateInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkDescriptorSetAllocateInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying the allocation parameters for descriptor sets.Valid Usage
- Each element of
pSetLayoutsmust not have been created withDESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHRset - If any element of
pSetLayoutswas created with theDESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BITbit set,descriptorPoolmust have been created with theDESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BITflag set - If any element of
pSetLayoutswas created with theDESCRIPTOR_SET_LAYOUT_CREATE_HOST_ONLY_POOL_BIT_VALVEbit set,descriptorPoolmust have been created with theDESCRIPTOR_POOL_CREATE_HOST_ONLY_BIT_VALVEflag set
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFOpNextmust beNULLor a pointer to a valid instance ofVkDescriptorSetVariableDescriptorCountAllocateInfo- The
sTypevalue of each struct in thepNextchain must be unique descriptorPoolmust be a validVkDescriptorPoolhandlepSetLayoutsmust be a valid pointer to an array ofdescriptorSetCountvalidVkDescriptorSetLayouthandlesdescriptorSetCountmust be greater than 0- Both of
descriptorPool, and the elements ofpSetLayoutsmust have been created, allocated, or retrieved from the sameVkDevice
See Also
Layout
struct VkDescriptorSetAllocateInfo { VkStructureTypesType(); void const *pNext(); VkDescriptorPooldescriptorPool(); uint32_tdescriptorSetCount(); VkDescriptorSetLayout const *pSetLayouts(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkDescriptorSetAllocateInfo.BufferAn array ofVkDescriptorSetAllocateInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intDESCRIPTORPOOL
DESCRIPTORSETCOUNT
PNEXT
PSETLAYOUTSThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkDescriptorSetAllocateInfo(java.nio.ByteBuffer container)Creates aVkDescriptorSetAllocateInfoinstance 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 VkDescriptorSetAllocateInfocalloc()Returns a newVkDescriptorSetAllocateInfoinstance allocated withmemCalloc.static VkDescriptorSetAllocateInfo.Buffercalloc(int capacity)Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated withmemCalloc.static VkDescriptorSetAllocateInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDescriptorSetAllocateInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorSetAllocateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDescriptorSetAllocateInfocallocStack()Deprecated.static VkDescriptorSetAllocateInfo.BuffercallocStack(int capacity)Deprecated.static VkDescriptorSetAllocateInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkDescriptorSetAllocateInfocallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkDescriptorSetAllocateInfocreate()Returns a newVkDescriptorSetAllocateInfoinstance allocated withBufferUtils.static VkDescriptorSetAllocateInfo.Buffercreate(int capacity)Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated withBufferUtils.static VkDescriptorSetAllocateInfocreate(long address)Returns a newVkDescriptorSetAllocateInfoinstance for the specified memory address.static VkDescriptorSetAllocateInfo.Buffercreate(long address, int capacity)Create aVkDescriptorSetAllocateInfo.Bufferinstance at the specified memory.static VkDescriptorSetAllocateInfocreateSafe(long address)static VkDescriptorSetAllocateInfo.BuffercreateSafe(long address, int capacity)longdescriptorPool()the pool which the sets will be allocated from.VkDescriptorSetAllocateInfodescriptorPool(long value)Sets the specified value to thedescriptorPool()field.intdescriptorSetCount()determines the number of descriptor sets to be allocated from the pool.static VkDescriptorSetAllocateInfomalloc()Returns a newVkDescriptorSetAllocateInfoinstance allocated withmemAlloc.static VkDescriptorSetAllocateInfo.Buffermalloc(int capacity)Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated withmemAlloc.static VkDescriptorSetAllocateInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkDescriptorSetAllocateInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorSetAllocateInfoinstance allocated on the specifiedMemoryStack.static VkDescriptorSetAllocateInfomallocStack()Deprecated.static VkDescriptorSetAllocateInfo.BuffermallocStack(int capacity)Deprecated.static VkDescriptorSetAllocateInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkDescriptorSetAllocateInfomallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static longndescriptorPool(long struct)Unsafe version ofdescriptorPool().static voidndescriptorPool(long struct, long value)Unsafe version ofdescriptorPool.static intndescriptorSetCount(long struct)Unsafe version ofdescriptorSetCount().static voidndescriptorSetCount(long struct, int value)Sets the specified value to thedescriptorSetCountfield of the specifiedstruct.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static java.nio.LongBuffernpSetLayouts(long struct)Unsafe version ofpSetLayouts.static voidnpSetLayouts(long struct, java.nio.LongBuffer value)Unsafe version ofpSetLayouts.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.VkDescriptorSetAllocateInfopNext(long value)Sets the specified value to thepNext()field.VkDescriptorSetAllocateInfopNext(VkDescriptorSetVariableDescriptorCountAllocateInfo value)Prepends the specifiedVkDescriptorSetVariableDescriptorCountAllocateInfovalue to thepNextchain.VkDescriptorSetAllocateInfopNext(VkDescriptorSetVariableDescriptorCountAllocateInfoEXT value)Prepends the specifiedVkDescriptorSetVariableDescriptorCountAllocateInfoEXTvalue to thepNextchain.java.nio.LongBufferpSetLayouts()a pointer to an array of descriptor set layouts, with each member specifying how the corresponding descriptor set is allocated.VkDescriptorSetAllocateInfopSetLayouts(java.nio.LongBuffer value)Sets the address of the specifiedLongBufferto thepSetLayouts()field.VkDescriptorSetAllocateInfoset(int sType, long pNext, long descriptorPool, java.nio.LongBuffer pSetLayouts)Initializes this struct with the specified values.VkDescriptorSetAllocateInfoset(VkDescriptorSetAllocateInfo src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkDescriptorSetAllocateInfosType(int value)Sets the specified value to thesType()field.VkDescriptorSetAllocateInfosType$Default()Sets theSTRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFOvalue to thesType()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
VkDescriptorSetAllocateInfo
public VkDescriptorSetAllocateInfo(java.nio.ByteBuffer container)
Creates aVkDescriptorSetAllocateInfoinstance 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.
-
descriptorPool
public long descriptorPool()
the pool which the sets will be allocated from.
-
descriptorSetCount
public int descriptorSetCount()
determines the number of descriptor sets to be allocated from the pool.
-
pSetLayouts
public java.nio.LongBuffer pSetLayouts()
a pointer to an array of descriptor set layouts, with each member specifying how the corresponding descriptor set is allocated.
-
sType
public VkDescriptorSetAllocateInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkDescriptorSetAllocateInfo sType$Default()
Sets theSTRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFOvalue to thesType()field.
-
pNext
public VkDescriptorSetAllocateInfo pNext(long value)
Sets the specified value to thepNext()field.
-
pNext
public VkDescriptorSetAllocateInfo pNext(VkDescriptorSetVariableDescriptorCountAllocateInfo value)
Prepends the specifiedVkDescriptorSetVariableDescriptorCountAllocateInfovalue to thepNextchain.
-
pNext
public VkDescriptorSetAllocateInfo pNext(VkDescriptorSetVariableDescriptorCountAllocateInfoEXT value)
Prepends the specifiedVkDescriptorSetVariableDescriptorCountAllocateInfoEXTvalue to thepNextchain.
-
descriptorPool
public VkDescriptorSetAllocateInfo descriptorPool(long value)
Sets the specified value to thedescriptorPool()field.
-
pSetLayouts
public VkDescriptorSetAllocateInfo pSetLayouts(java.nio.LongBuffer value)
Sets the address of the specifiedLongBufferto thepSetLayouts()field.
-
set
public VkDescriptorSetAllocateInfo set(int sType, long pNext, long descriptorPool, java.nio.LongBuffer pSetLayouts)
Initializes this struct with the specified values.
-
set
public VkDescriptorSetAllocateInfo set(VkDescriptorSetAllocateInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkDescriptorSetAllocateInfo malloc()
Returns a newVkDescriptorSetAllocateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkDescriptorSetAllocateInfo calloc()
Returns a newVkDescriptorSetAllocateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkDescriptorSetAllocateInfo create()
Returns a newVkDescriptorSetAllocateInfoinstance allocated withBufferUtils.
-
create
public static VkDescriptorSetAllocateInfo create(long address)
Returns a newVkDescriptorSetAllocateInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkDescriptorSetAllocateInfo createSafe(long address)
-
malloc
public static VkDescriptorSetAllocateInfo.Buffer malloc(int capacity)
Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkDescriptorSetAllocateInfo.Buffer calloc(int capacity)
Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkDescriptorSetAllocateInfo.Buffer create(int capacity)
Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkDescriptorSetAllocateInfo.Buffer create(long address, int capacity)
Create aVkDescriptorSetAllocateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkDescriptorSetAllocateInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkDescriptorSetAllocateInfo mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkDescriptorSetAllocateInfo callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkDescriptorSetAllocateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkDescriptorSetAllocateInfo callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkDescriptorSetAllocateInfo.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkDescriptorSetAllocateInfo.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkDescriptorSetAllocateInfo.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 VkDescriptorSetAllocateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkDescriptorSetAllocateInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkDescriptorSetAllocateInfo calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkDescriptorSetAllocateInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkDescriptorSetAllocateInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo.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().
-
ndescriptorPool
public static long ndescriptorPool(long struct)
Unsafe version ofdescriptorPool().
-
ndescriptorSetCount
public static int ndescriptorSetCount(long struct)
Unsafe version ofdescriptorSetCount().
-
npSetLayouts
public static java.nio.LongBuffer npSetLayouts(long struct)
Unsafe version ofpSetLayouts.
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
ndescriptorPool
public static void ndescriptorPool(long struct, long value)Unsafe version ofdescriptorPool.
-
ndescriptorSetCount
public static void ndescriptorSetCount(long struct, int value)Sets the specified value to thedescriptorSetCountfield of the specifiedstruct.
-
npSetLayouts
public static void npSetLayouts(long struct, java.nio.LongBuffer value)Unsafe version ofpSetLayouts.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-