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, NativeResource, Pointer
public class VkDescriptorSetAllocateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about how a descriptor set should be allocated.
Valid Usage
sTypemust beSTRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFOpNextmust beNULLdescriptorPoolmust be a validVkDescriptorPoolhandlepSetLayoutsmust be a pointer to an array ofdescriptorSetCountvalidVkDescriptorSetLayouthandlesdescriptorSetCountmust be greater than 0- Each of
descriptorPooland the elements ofpSetLayoutsmust have been created, allocated or retrieved from the sameVkDevice descriptorSetCountmust not be greater than the number of sets that are currently available for allocation indescriptorPooldescriptorPoolmust have enough free descriptor capacity remaining to allocate the descriptor sets of the specified layouts
Member documentation
sType– the type of this structure. Must be:STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFOpNext– reserved for use by extensionsdescriptorPool– the pool which the sets will be allocated fromdescriptorSetCount– the number of descriptor sets to be allocated from the poolpSetLayouts– an array of descriptor set layouts, with each member specifying how the corresponding descriptor set is allocated
Layout
struct VkDescriptorSetAllocateInfo { VkStructureType sType; const void * pNext; VkDescriptorPool descriptorPool; uint32_t descriptorSetCount; const VkDescriptorSetLayout * pSetLayouts; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkDescriptorSetAllocateInfo.BufferAn array ofVkDescriptorSetAllocateInfostructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and 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 Modifier and Type Method and Description static VkDescriptorSetAllocateInfocalloc()Returns a newVkDescriptorSetAllocateInfoinstance allocated withmemCalloc.static VkDescriptorSetAllocateInfo.Buffercalloc(int capacity)Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated withmemCalloc.static VkDescriptorSetAllocateInfocallocStack()Returns a newVkDescriptorSetAllocateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDescriptorSetAllocateInfo.BuffercallocStack(int capacity)Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDescriptorSetAllocateInfo.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDescriptorSetAllocateInfocallocStack(MemoryStack stack)Returns a newVkDescriptorSetAllocateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.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 ornullif the address isNULL.static VkDescriptorSetAllocateInfo.Buffercreate(long address, int capacity)Create aVkDescriptorSetAllocateInfo.Bufferinstance at the specified memory.longdescriptorPool()Returns the value of thedescriptorPoolfield.VkDescriptorSetAllocateInfodescriptorPool(long value)Sets the specified value to thedescriptorPoolfield.intdescriptorSetCount()Returns the value of thedescriptorSetCountfield.static VkDescriptorSetAllocateInfomalloc()Returns a newVkDescriptorSetAllocateInfoinstance allocated withmemAlloc.static VkDescriptorSetAllocateInfo.Buffermalloc(int capacity)Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated withmemAlloc.static VkDescriptorSetAllocateInfomallocStack()Returns a newVkDescriptorSetAllocateInfoinstance allocated on the thread-localMemoryStack.static VkDescriptorSetAllocateInfo.BuffermallocStack(int capacity)Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkDescriptorSetAllocateInfo.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkDescriptorSetAllocateInfomallocStack(MemoryStack stack)Returns a newVkDescriptorSetAllocateInfoinstance allocated on the specifiedMemoryStack.VkDescriptorSetAllocateInfonset(long struct)Unsafe version ofset.longpNext()Returns the value of thepNextfield.VkDescriptorSetAllocateInfopNext(long value)Sets the specified value to thepNextfield.java.nio.LongBufferpSetLayouts()Returns aLongBufferview of the data pointed to by thepSetLayoutsfield.VkDescriptorSetAllocateInfopSetLayouts(java.nio.LongBuffer value)Sets the address of the specifiedLongBufferto thepSetLayoutsfield.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()Returns thesizeof(struct).intsType()Returns the value of thesTypefield.VkDescriptorSetAllocateInfosType(int value)Sets the specified value to thesTypefield.static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(long array, int count)CallsVkDescriptorSetAllocateInfo.validate(long)for each struct contained in the specified struct array.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
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()
Description copied from class:StructReturns thesizeof(struct).
-
sType
public int sType()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
descriptorPool
public long descriptorPool()
Returns the value of thedescriptorPoolfield.
-
descriptorSetCount
public int descriptorSetCount()
Returns the value of thedescriptorSetCountfield.
-
pSetLayouts
public java.nio.LongBuffer pSetLayouts()
Returns aLongBufferview of the data pointed to by thepSetLayoutsfield.
-
sType
public VkDescriptorSetAllocateInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkDescriptorSetAllocateInfo pNext(long value)
Sets the specified value to thepNextfield.
-
descriptorPool
public VkDescriptorSetAllocateInfo descriptorPool(long value)
Sets the specified value to thedescriptorPoolfield.
-
pSetLayouts
public VkDescriptorSetAllocateInfo pSetLayouts(java.nio.LongBuffer value)
Sets the address of the specifiedLongBufferto thepSetLayoutsfield.
-
set
public VkDescriptorSetAllocateInfo set(int sType, long pNext, long descriptorPool, java.nio.LongBuffer pSetLayouts)
Initializes this struct with the specified values.
-
nset
public VkDescriptorSetAllocateInfo nset(long struct)
Unsafe version ofset.
-
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 ornullif the address isNULL.
-
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
-
mallocStack
public static VkDescriptorSetAllocateInfo mallocStack()
Returns a newVkDescriptorSetAllocateInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkDescriptorSetAllocateInfo callocStack()
Returns a newVkDescriptorSetAllocateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkDescriptorSetAllocateInfo mallocStack(MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkDescriptorSetAllocateInfo callocStack(MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfoinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkDescriptorSetAllocateInfo.Buffer callocStack(int capacity)
Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkDescriptorSetAllocateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkDescriptorSetAllocateInfo.Buffer callocStack(int capacity, 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
-
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)CallsVkDescriptorSetAllocateInfo.validate(long)for each struct contained in the specified struct array.- Parameters:
array- the struct array to validatecount- the number of structs inarray
-
-