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.NativeResource
Structure specifying the allocation parameters for descriptor sets.Valid Usage
- Each element of
pSetLayouts
must not have been created withDESCRIPTOR_SET_LAYOUT_CREATE_PUSH_DESCRIPTOR_BIT_KHR
set - If any element of
pSetLayouts
was created with theDESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT_EXT
bit set,descriptorPool
must have been created with theDESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT
flag set
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO
pNext
must beNULL
or a pointer to a valid instance ofVkDescriptorSetVariableDescriptorCountAllocateInfoEXT
descriptorPool
must be a validVkDescriptorPool
handlepSetLayouts
must be a valid pointer to an array ofdescriptorSetCount
validVkDescriptorSetLayout
handlesdescriptorSetCount
must be greater than 0- Both of
descriptorPool
, and the elements ofpSetLayouts
must have been created, allocated, or retrieved from the sameVkDevice
See Also
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.descriptorPool
– the pool which the sets will be allocated from.descriptorSetCount
– determines the number of descriptor sets to be allocated from the pool.pSetLayouts
– an array of descriptor set layouts, with each member specifying how the corresponding descriptor set is allocated.
Layout
struct VkDescriptorSetAllocateInfo { VkStructureType sType; void const * pNext; VkDescriptorPool descriptorPool; uint32_t descriptorSetCount; VkDescriptorSetLayout const * pSetLayouts; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkDescriptorSetAllocateInfo.Buffer
An array ofVkDescriptorSetAllocateInfo
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
DESCRIPTORPOOL
DESCRIPTORSETCOUNT
PNEXT
PSETLAYOUTSThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
The struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkDescriptorSetAllocateInfo(java.nio.ByteBuffer container)
Creates aVkDescriptorSetAllocateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkDescriptorSetAllocateInfo
calloc()
Returns a newVkDescriptorSetAllocateInfo
instance allocated withmemCalloc
.static VkDescriptorSetAllocateInfo.Buffer
calloc(int capacity)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated withmemCalloc
.static VkDescriptorSetAllocateInfo
callocStack()
Returns a newVkDescriptorSetAllocateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDescriptorSetAllocateInfo.Buffer
callocStack(int capacity)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDescriptorSetAllocateInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDescriptorSetAllocateInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDescriptorSetAllocateInfo
create()
Returns a newVkDescriptorSetAllocateInfo
instance allocated withBufferUtils
.static VkDescriptorSetAllocateInfo.Buffer
create(int capacity)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated withBufferUtils
.static VkDescriptorSetAllocateInfo
create(long address)
Returns a newVkDescriptorSetAllocateInfo
instance for the specified memory address.static VkDescriptorSetAllocateInfo.Buffer
create(long address, int capacity)
Create aVkDescriptorSetAllocateInfo.Buffer
instance at the specified memory.static VkDescriptorSetAllocateInfo
createSafe(long address)
static VkDescriptorSetAllocateInfo.Buffer
createSafe(long address, int capacity)
long
descriptorPool()
Returns the value of thedescriptorPool
field.VkDescriptorSetAllocateInfo
descriptorPool(long value)
Sets the specified value to thedescriptorPool
field.int
descriptorSetCount()
Returns the value of thedescriptorSetCount
field.static VkDescriptorSetAllocateInfo
malloc()
Returns a newVkDescriptorSetAllocateInfo
instance allocated withmemAlloc
.static VkDescriptorSetAllocateInfo.Buffer
malloc(int capacity)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated withmemAlloc
.static VkDescriptorSetAllocateInfo
mallocStack()
Returns a newVkDescriptorSetAllocateInfo
instance allocated on the thread-localMemoryStack
.static VkDescriptorSetAllocateInfo.Buffer
mallocStack(int capacity)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkDescriptorSetAllocateInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkDescriptorSetAllocateInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo
instance allocated on the specifiedMemoryStack
.static long
ndescriptorPool(long struct)
Unsafe version ofdescriptorPool()
.static void
ndescriptorPool(long struct, long value)
Unsafe version ofdescriptorPool
.static int
ndescriptorSetCount(long struct)
Unsafe version ofdescriptorSetCount()
.static void
ndescriptorSetCount(long struct, int value)
Sets the specified value to thedescriptorSetCount
field of the specifiedstruct
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static java.nio.LongBuffer
npSetLayouts(long struct)
Unsafe version ofpSetLayouts
.static void
npSetLayouts(long struct, java.nio.LongBuffer value)
Unsafe version ofpSetLayouts
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.long
pNext()
Returns the value of thepNext
field.VkDescriptorSetAllocateInfo
pNext(long value)
Sets the specified value to thepNext
field.java.nio.LongBuffer
pSetLayouts()
Returns aLongBuffer
view of the data pointed to by thepSetLayouts
field.VkDescriptorSetAllocateInfo
pSetLayouts(java.nio.LongBuffer value)
Sets the address of the specifiedLongBuffer
to thepSetLayouts
field.VkDescriptorSetAllocateInfo
set(int sType, long pNext, long descriptorPool, java.nio.LongBuffer pSetLayouts)
Initializes this struct with the specified values.VkDescriptorSetAllocateInfo
set(VkDescriptorSetAllocateInfo src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkDescriptorSetAllocateInfo
sType(int value)
Sets the specified value to thesType
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkDescriptorSetAllocateInfo
public VkDescriptorSetAllocateInfo(java.nio.ByteBuffer container)
Creates aVkDescriptorSetAllocateInfo
instance at the current position of the specifiedByteBuffer
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
descriptorPool
public long descriptorPool()
Returns the value of thedescriptorPool
field.
-
descriptorSetCount
public int descriptorSetCount()
Returns the value of thedescriptorSetCount
field.
-
pSetLayouts
public java.nio.LongBuffer pSetLayouts()
Returns aLongBuffer
view of the data pointed to by thepSetLayouts
field.
-
sType
public VkDescriptorSetAllocateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkDescriptorSetAllocateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
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 specifiedLongBuffer
to 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 newVkDescriptorSetAllocateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDescriptorSetAllocateInfo calloc()
Returns a newVkDescriptorSetAllocateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDescriptorSetAllocateInfo create()
Returns a newVkDescriptorSetAllocateInfo
instance allocated withBufferUtils
.
-
create
public static VkDescriptorSetAllocateInfo create(long address)
Returns a newVkDescriptorSetAllocateInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkDescriptorSetAllocateInfo createSafe(long address)
-
malloc
public static VkDescriptorSetAllocateInfo.Buffer malloc(int capacity)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDescriptorSetAllocateInfo.Buffer calloc(int capacity)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDescriptorSetAllocateInfo.Buffer create(int capacity)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDescriptorSetAllocateInfo.Buffer create(long address, int capacity)
Create aVkDescriptorSetAllocateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkDescriptorSetAllocateInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkDescriptorSetAllocateInfo mallocStack()
Returns a newVkDescriptorSetAllocateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDescriptorSetAllocateInfo callocStack()
Returns a newVkDescriptorSetAllocateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDescriptorSetAllocateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDescriptorSetAllocateInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDescriptorSetAllocateInfo.Buffer mallocStack(int capacity)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDescriptorSetAllocateInfo.Buffer callocStack(int capacity)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDescriptorSetAllocateInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDescriptorSetAllocateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
and 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 thedescriptorSetCount
field 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
-
validate
public static void validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-