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
sType
must beSTRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO
pNext
must beNULL
descriptorPool
must be a validVkDescriptorPool
handlepSetLayouts
must be a pointer to an array ofdescriptorSetCount
validVkDescriptorSetLayout
handlesdescriptorSetCount
must be greater than 0- Each of
descriptorPool
and the elements ofpSetLayouts
must have been created, allocated or retrieved from the sameVkDevice
descriptorSetCount
must not be greater than the number of sets that are currently available for allocation indescriptorPool
descriptorPool
must 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_INFO
pNext
– 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 class
VkDescriptorSetAllocateInfo.Buffer
An array ofVkDescriptorSetAllocateInfo
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 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 and 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, MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDescriptorSetAllocateInfo
callocStack(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 ornull
if the address isNULL
.static VkDescriptorSetAllocateInfo.Buffer
create(long address, int capacity)
Create aVkDescriptorSetAllocateInfo.Buffer
instance at the specified memory.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, MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkDescriptorSetAllocateInfo
mallocStack(MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo
instance allocated on the specifiedMemoryStack
.VkDescriptorSetAllocateInfo
nset(long struct)
Unsafe version ofset
.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()
Returns thesizeof(struct)
.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)
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 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()
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.
-
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.
-
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 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 ornull
if the address isNULL
.
-
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
-
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(MemoryStack stack)
Returns a newVkDescriptorSetAllocateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDescriptorSetAllocateInfo callocStack(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, 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, 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
-
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
-
-