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
sType
must beSTRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO
pNext
must beNULL
flags
must be a valid combination ofVkDescriptorPoolCreateFlagBits
valuespPoolSizes
must be a pointer to an array ofpoolSizeCount
validVkDescriptorPoolSize
structurespoolSizeCount
must be greater than 0maxSets
must be greater than 0
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO
pNext
– 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 inpPoolSizes
pPoolSizes
– a pointer to an array ofVkDescriptorPoolSize
structures, 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 class
VkDescriptorPoolCreateInfo.Buffer
An array ofVkDescriptorPoolCreateInfo
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The 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 aVkDescriptorPoolCreateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkDescriptorPoolCreateInfo
calloc()
Returns a newVkDescriptorPoolCreateInfo
instance allocated withmemCalloc
.static VkDescriptorPoolCreateInfo.Buffer
calloc(int capacity)
Returns a newVkDescriptorPoolCreateInfo.Buffer
instance allocated withmemCalloc
.static VkDescriptorPoolCreateInfo
callocStack()
Returns a newVkDescriptorPoolCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDescriptorPoolCreateInfo.Buffer
callocStack(int capacity)
Returns a newVkDescriptorPoolCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDescriptorPoolCreateInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorPoolCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDescriptorPoolCreateInfo
callocStack(MemoryStack stack)
Returns a newVkDescriptorPoolCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDescriptorPoolCreateInfo
create()
Returns a newVkDescriptorPoolCreateInfo
instance allocated withBufferUtils
.static VkDescriptorPoolCreateInfo.Buffer
create(int capacity)
Returns a newVkDescriptorPoolCreateInfo.Buffer
instance allocated withBufferUtils
.static VkDescriptorPoolCreateInfo
create(long address)
Returns a newVkDescriptorPoolCreateInfo
instance for the specified memory address ornull
if the address isNULL
.static VkDescriptorPoolCreateInfo.Buffer
create(long address, int capacity)
Create aVkDescriptorPoolCreateInfo.Buffer
instance at the specified memory.int
flags()
Returns the value of theflags
field.VkDescriptorPoolCreateInfo
flags(int value)
Sets the specified value to theflags
field.static VkDescriptorPoolCreateInfo
malloc()
Returns a newVkDescriptorPoolCreateInfo
instance allocated withmemAlloc
.static VkDescriptorPoolCreateInfo.Buffer
malloc(int capacity)
Returns a newVkDescriptorPoolCreateInfo.Buffer
instance allocated withmemAlloc
.static VkDescriptorPoolCreateInfo
mallocStack()
Returns a newVkDescriptorPoolCreateInfo
instance allocated on the thread-localMemoryStack
.static VkDescriptorPoolCreateInfo.Buffer
mallocStack(int capacity)
Returns a newVkDescriptorPoolCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkDescriptorPoolCreateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorPoolCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkDescriptorPoolCreateInfo
mallocStack(MemoryStack stack)
Returns a newVkDescriptorPoolCreateInfo
instance allocated on the specifiedMemoryStack
.int
maxSets()
Returns the value of themaxSets
field.VkDescriptorPoolCreateInfo
maxSets(int value)
Sets the specified value to themaxSets
field.VkDescriptorPoolCreateInfo
nset(long struct)
Unsafe version ofset
.long
pNext()
Returns the value of thepNext
field.VkDescriptorPoolCreateInfo
pNext(long value)
Sets the specified value to thepNext
field.int
poolSizeCount()
Returns the value of thepoolSizeCount
field.VkDescriptorPoolSize.Buffer
pPoolSizes()
Returns aVkDescriptorPoolSize.Buffer
view of the struct array pointed to by thepPoolSizes
field.VkDescriptorPoolCreateInfo
pPoolSizes(VkDescriptorPoolSize.Buffer value)
Sets the address of the specifiedVkDescriptorPoolSize.Buffer
to thepPoolSizes
field.VkDescriptorPoolCreateInfo
set(int sType, long pNext, int flags, int maxSets, VkDescriptorPoolSize.Buffer pPoolSizes)
Initializes this struct with the specified values.VkDescriptorPoolCreateInfo
set(VkDescriptorPoolCreateInfo src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkDescriptorPoolCreateInfo
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)
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 aVkDescriptorPoolCreateInfo
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()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
maxSets
public int maxSets()
Returns the value of themaxSets
field.
-
poolSizeCount
public int poolSizeCount()
Returns the value of thepoolSizeCount
field.
-
pPoolSizes
public VkDescriptorPoolSize.Buffer pPoolSizes()
Returns aVkDescriptorPoolSize.Buffer
view of the struct array pointed to by thepPoolSizes
field.
-
sType
public VkDescriptorPoolCreateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkDescriptorPoolCreateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkDescriptorPoolCreateInfo flags(int value)
Sets the specified value to theflags
field.
-
maxSets
public VkDescriptorPoolCreateInfo maxSets(int value)
Sets the specified value to themaxSets
field.
-
pPoolSizes
public VkDescriptorPoolCreateInfo pPoolSizes(VkDescriptorPoolSize.Buffer value)
Sets the address of the specifiedVkDescriptorPoolSize.Buffer
to thepPoolSizes
field.
-
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 newVkDescriptorPoolCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDescriptorPoolCreateInfo calloc()
Returns a newVkDescriptorPoolCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDescriptorPoolCreateInfo create()
Returns a newVkDescriptorPoolCreateInfo
instance allocated withBufferUtils
.
-
create
public static VkDescriptorPoolCreateInfo create(long address)
Returns a newVkDescriptorPoolCreateInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkDescriptorPoolCreateInfo.Buffer malloc(int capacity)
Returns a newVkDescriptorPoolCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDescriptorPoolCreateInfo.Buffer calloc(int capacity)
Returns a newVkDescriptorPoolCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDescriptorPoolCreateInfo.Buffer create(int capacity)
Returns a newVkDescriptorPoolCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDescriptorPoolCreateInfo.Buffer create(long address, int capacity)
Create aVkDescriptorPoolCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkDescriptorPoolCreateInfo mallocStack()
Returns a newVkDescriptorPoolCreateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDescriptorPoolCreateInfo callocStack()
Returns a newVkDescriptorPoolCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDescriptorPoolCreateInfo mallocStack(MemoryStack stack)
Returns a newVkDescriptorPoolCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDescriptorPoolCreateInfo callocStack(MemoryStack stack)
Returns a newVkDescriptorPoolCreateInfo
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDescriptorPoolCreateInfo.Buffer callocStack(int capacity)
Returns a newVkDescriptorPoolCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDescriptorPoolCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkDescriptorPoolCreateInfo.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and 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
-
-