Package org.lwjgl.vulkan
Class VkDescriptorPoolCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDescriptorPoolCreateInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkDescriptorPoolCreateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about how a descriptor pool should be created.
Valid Usage
sTypemust beSTRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFOpNextmust beNULLflagsmust be a valid combination ofVkDescriptorPoolCreateFlagBitsvaluespPoolSizesmust be a pointer to an array ofpoolSizeCountvalidVkDescriptorPoolSizestructurespoolSizeCountmust be greater than 0maxSetsmust be greater than 0
Member documentation
sType– the type of this structure. Must be:STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFOpNext– reserved for use by extensionsflags– specifies certain supported operations on the poolmaxSets– the maximum number of descriptor sets that can be allocated from the poolpoolSizeCount– the number of elements inpPoolSizespPoolSizes– a pointer to an array ofVkDescriptorPoolSizestructures, each containing a descriptor type and number of descriptors of that type to be allocated in the pool
Layout
struct VkDescriptorPoolCreateInfo { VkStructureType sType; const void * pNext; VkDescriptorPoolCreateFlags flags; uint32_t maxSets; uint32_t poolSizeCount; const VkDescriptorPoolSize * pPoolSizes; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classVkDescriptorPoolCreateInfo.BufferAn array ofVkDescriptorPoolCreateInfostructs.-
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 VkDescriptorPoolCreateInfo(java.nio.ByteBuffer container)Creates aVkDescriptorPoolCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkDescriptorPoolCreateInfocalloc()Returns a newVkDescriptorPoolCreateInfoinstance allocated withmemCalloc.static VkDescriptorPoolCreateInfo.Buffercalloc(int capacity)Returns a newVkDescriptorPoolCreateInfo.Bufferinstance allocated withmemCalloc.static VkDescriptorPoolCreateInfocallocStack()Returns a newVkDescriptorPoolCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDescriptorPoolCreateInfo.BuffercallocStack(int capacity)Returns a newVkDescriptorPoolCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDescriptorPoolCreateInfo.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkDescriptorPoolCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDescriptorPoolCreateInfocallocStack(MemoryStack stack)Returns a newVkDescriptorPoolCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDescriptorPoolCreateInfocreate()Returns a newVkDescriptorPoolCreateInfoinstance allocated withBufferUtils.static VkDescriptorPoolCreateInfo.Buffercreate(int capacity)Returns a newVkDescriptorPoolCreateInfo.Bufferinstance allocated withBufferUtils.static VkDescriptorPoolCreateInfocreate(long address)Returns a newVkDescriptorPoolCreateInfoinstance for the specified memory address ornullif the address isNULL.static VkDescriptorPoolCreateInfo.Buffercreate(long address, int capacity)Create aVkDescriptorPoolCreateInfo.Bufferinstance at the specified memory.intflags()Returns the value of theflagsfield.VkDescriptorPoolCreateInfoflags(int value)Sets the specified value to theflagsfield.static VkDescriptorPoolCreateInfomalloc()Returns a newVkDescriptorPoolCreateInfoinstance allocated withmemAlloc.static VkDescriptorPoolCreateInfo.Buffermalloc(int capacity)Returns a newVkDescriptorPoolCreateInfo.Bufferinstance allocated withmemAlloc.static VkDescriptorPoolCreateInfomallocStack()Returns a newVkDescriptorPoolCreateInfoinstance allocated on the thread-localMemoryStack.static VkDescriptorPoolCreateInfo.BuffermallocStack(int capacity)Returns a newVkDescriptorPoolCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkDescriptorPoolCreateInfo.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkDescriptorPoolCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkDescriptorPoolCreateInfomallocStack(MemoryStack stack)Returns a newVkDescriptorPoolCreateInfoinstance allocated on the specifiedMemoryStack.intmaxSets()Returns the value of themaxSetsfield.VkDescriptorPoolCreateInfomaxSets(int value)Sets the specified value to themaxSetsfield.VkDescriptorPoolCreateInfonset(long struct)Unsafe version ofset.longpNext()Returns the value of thepNextfield.VkDescriptorPoolCreateInfopNext(long value)Sets the specified value to thepNextfield.intpoolSizeCount()Returns the value of thepoolSizeCountfield.VkDescriptorPoolSize.BufferpPoolSizes()Returns aVkDescriptorPoolSize.Bufferview of the struct array pointed to by thepPoolSizesfield.VkDescriptorPoolCreateInfopPoolSizes(VkDescriptorPoolSize.Buffer value)Sets the address of the specifiedVkDescriptorPoolSize.Bufferto thepPoolSizesfield.VkDescriptorPoolCreateInfoset(int sType, long pNext, int flags, int maxSets, VkDescriptorPoolSize.Buffer pPoolSizes)Initializes this struct with the specified values.VkDescriptorPoolCreateInfoset(VkDescriptorPoolCreateInfo src)Copies the specified struct data to this struct.intsizeof()Returns thesizeof(struct).intsType()Returns the value of thesTypefield.VkDescriptorPoolCreateInfosType(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)CallsVkDescriptorPoolCreateInfo.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
-
VkDescriptorPoolCreateInfo
public VkDescriptorPoolCreateInfo(java.nio.ByteBuffer container)
Creates aVkDescriptorPoolCreateInfoinstance 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.
-
flags
public int flags()
Returns the value of theflagsfield.
-
maxSets
public int maxSets()
Returns the value of themaxSetsfield.
-
poolSizeCount
public int poolSizeCount()
Returns the value of thepoolSizeCountfield.
-
pPoolSizes
public VkDescriptorPoolSize.Buffer pPoolSizes()
Returns aVkDescriptorPoolSize.Bufferview of the struct array pointed to by thepPoolSizesfield.
-
sType
public VkDescriptorPoolCreateInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkDescriptorPoolCreateInfo pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkDescriptorPoolCreateInfo flags(int value)
Sets the specified value to theflagsfield.
-
maxSets
public VkDescriptorPoolCreateInfo maxSets(int value)
Sets the specified value to themaxSetsfield.
-
pPoolSizes
public VkDescriptorPoolCreateInfo pPoolSizes(VkDescriptorPoolSize.Buffer value)
Sets the address of the specifiedVkDescriptorPoolSize.Bufferto thepPoolSizesfield.
-
set
public VkDescriptorPoolCreateInfo set(int sType, long pNext, int flags, int maxSets, VkDescriptorPoolSize.Buffer pPoolSizes)
Initializes this struct with the specified values.
-
nset
public VkDescriptorPoolCreateInfo nset(long struct)
Unsafe version ofset.
-
set
public VkDescriptorPoolCreateInfo set(VkDescriptorPoolCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkDescriptorPoolCreateInfo malloc()
Returns a newVkDescriptorPoolCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkDescriptorPoolCreateInfo calloc()
Returns a newVkDescriptorPoolCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkDescriptorPoolCreateInfo create()
Returns a newVkDescriptorPoolCreateInfoinstance allocated withBufferUtils.
-
create
public static VkDescriptorPoolCreateInfo create(long address)
Returns a newVkDescriptorPoolCreateInfoinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkDescriptorPoolCreateInfo.Buffer malloc(int capacity)
Returns a newVkDescriptorPoolCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkDescriptorPoolCreateInfo.Buffer calloc(int capacity)
Returns a newVkDescriptorPoolCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkDescriptorPoolCreateInfo.Buffer create(int capacity)
Returns a newVkDescriptorPoolCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkDescriptorPoolCreateInfo.Buffer create(long address, int capacity)
Create aVkDescriptorPoolCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkDescriptorPoolCreateInfo mallocStack()
Returns a newVkDescriptorPoolCreateInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkDescriptorPoolCreateInfo callocStack()
Returns a newVkDescriptorPoolCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkDescriptorPoolCreateInfo mallocStack(MemoryStack stack)
Returns a newVkDescriptorPoolCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkDescriptorPoolCreateInfo callocStack(MemoryStack stack)
Returns a newVkDescriptorPoolCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkDescriptorPoolCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkDescriptorPoolCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkDescriptorPoolCreateInfo.Buffer callocStack(int capacity)
Returns a newVkDescriptorPoolCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkDescriptorPoolCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorPoolCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkDescriptorPoolCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorPoolCreateInfo.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)CallsVkDescriptorPoolCreateInfo.validate(long)for each struct contained in the specified struct array.- Parameters:
array- the struct array to validatecount- the number of structs inarray
-
-