Package org.lwjgl.vulkan
Class VkDescriptorPoolSize
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDescriptorPoolSize
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkDescriptorPoolSize extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying descriptor pool size.Description
Note
When creating a descriptor pool that will contain descriptors for combined image samplers of multi-planar formats, an application needs to account for non-trivial descriptor consumption when choosing the
descriptorCountvalue, as indicated byVkSamplerYcbcrConversionImageFormatProperties::combinedImageSamplerDescriptorCount.Valid Usage
descriptorCountmust be greater than 0- If
typeisDESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXTthendescriptorCountmust be a multiple of 4
Valid Usage (Implicit)
typemust be a validVkDescriptorTypevalue
See Also
Member documentation
type– the type of descriptor.descriptorCount– the number of descriptors of that type to allocate. IftypeisDESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXTthendescriptorCountis the number of bytes to allocate for descriptors of this type.
Layout
struct VkDescriptorPoolSize { VkDescriptorType type; uint32_t descriptorCount; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkDescriptorPoolSize.BufferAn array ofVkDescriptorPoolSizestructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intDESCRIPTORCOUNTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkDescriptorPoolSize(java.nio.ByteBuffer container)Creates aVkDescriptorPoolSizeinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkDescriptorPoolSizecalloc()Returns a newVkDescriptorPoolSizeinstance allocated withmemCalloc.static VkDescriptorPoolSize.Buffercalloc(int capacity)Returns a newVkDescriptorPoolSize.Bufferinstance allocated withmemCalloc.static VkDescriptorPoolSizecallocStack()Returns a newVkDescriptorPoolSizeinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDescriptorPoolSize.BuffercallocStack(int capacity)Returns a newVkDescriptorPoolSize.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDescriptorPoolSize.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorPoolSize.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDescriptorPoolSizecallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorPoolSizeinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDescriptorPoolSizecreate()Returns a newVkDescriptorPoolSizeinstance allocated withBufferUtils.static VkDescriptorPoolSize.Buffercreate(int capacity)Returns a newVkDescriptorPoolSize.Bufferinstance allocated withBufferUtils.static VkDescriptorPoolSizecreate(long address)Returns a newVkDescriptorPoolSizeinstance for the specified memory address.static VkDescriptorPoolSize.Buffercreate(long address, int capacity)Create aVkDescriptorPoolSize.Bufferinstance at the specified memory.static VkDescriptorPoolSizecreateSafe(long address)static VkDescriptorPoolSize.BuffercreateSafe(long address, int capacity)intdescriptorCount()Returns the value of thedescriptorCountfield.VkDescriptorPoolSizedescriptorCount(int value)Sets the specified value to thedescriptorCountfield.static VkDescriptorPoolSizemalloc()Returns a newVkDescriptorPoolSizeinstance allocated withmemAlloc.static VkDescriptorPoolSize.Buffermalloc(int capacity)Returns a newVkDescriptorPoolSize.Bufferinstance allocated withmemAlloc.static VkDescriptorPoolSizemallocStack()Returns a newVkDescriptorPoolSizeinstance allocated on the thread-localMemoryStack.static VkDescriptorPoolSize.BuffermallocStack(int capacity)Returns a newVkDescriptorPoolSize.Bufferinstance allocated on the thread-localMemoryStack.static VkDescriptorPoolSize.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorPoolSize.Bufferinstance allocated on the specifiedMemoryStack.static VkDescriptorPoolSizemallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkDescriptorPoolSizeinstance allocated on the specifiedMemoryStack.static intndescriptorCount(long struct)Unsafe version ofdescriptorCount().static voidndescriptorCount(long struct, int value)Unsafe version ofdescriptorCount.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.VkDescriptorPoolSizeset(int type, int descriptorCount)Initializes this struct with the specified values.VkDescriptorPoolSizeset(VkDescriptorPoolSize src)Copies the specified struct data to this struct.intsizeof()inttype()Returns the value of thetypefield.VkDescriptorPoolSizetype(int value)Sets the specified value to thetypefield.
-
-
-
Constructor Detail
-
VkDescriptorPoolSize
public VkDescriptorPoolSize(java.nio.ByteBuffer container)
Creates aVkDescriptorPoolSizeinstance 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()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
type
public int type()
Returns the value of thetypefield.
-
descriptorCount
public int descriptorCount()
Returns the value of thedescriptorCountfield.
-
type
public VkDescriptorPoolSize type(int value)
Sets the specified value to thetypefield.
-
descriptorCount
public VkDescriptorPoolSize descriptorCount(int value)
Sets the specified value to thedescriptorCountfield.
-
set
public VkDescriptorPoolSize set(int type, int descriptorCount)
Initializes this struct with the specified values.
-
set
public VkDescriptorPoolSize set(VkDescriptorPoolSize src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkDescriptorPoolSize malloc()
Returns a newVkDescriptorPoolSizeinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkDescriptorPoolSize calloc()
Returns a newVkDescriptorPoolSizeinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkDescriptorPoolSize create()
Returns a newVkDescriptorPoolSizeinstance allocated withBufferUtils.
-
create
public static VkDescriptorPoolSize create(long address)
Returns a newVkDescriptorPoolSizeinstance for the specified memory address.
-
createSafe
@Nullable public static VkDescriptorPoolSize createSafe(long address)
-
malloc
public static VkDescriptorPoolSize.Buffer malloc(int capacity)
Returns a newVkDescriptorPoolSize.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkDescriptorPoolSize.Buffer calloc(int capacity)
Returns a newVkDescriptorPoolSize.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkDescriptorPoolSize.Buffer create(int capacity)
Returns a newVkDescriptorPoolSize.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkDescriptorPoolSize.Buffer create(long address, int capacity)
Create aVkDescriptorPoolSize.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkDescriptorPoolSize.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkDescriptorPoolSize mallocStack()
Returns a newVkDescriptorPoolSizeinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkDescriptorPoolSize callocStack()
Returns a newVkDescriptorPoolSizeinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkDescriptorPoolSize mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorPoolSizeinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkDescriptorPoolSize callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorPoolSizeinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
mallocStack
public static VkDescriptorPoolSize.Buffer mallocStack(int capacity)
Returns a newVkDescriptorPoolSize.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkDescriptorPoolSize.Buffer callocStack(int capacity)
Returns a newVkDescriptorPoolSize.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkDescriptorPoolSize.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorPoolSize.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
callocStack
public static VkDescriptorPoolSize.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDescriptorPoolSize.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
ndescriptorCount
public static int ndescriptorCount(long struct)
Unsafe version ofdescriptorCount().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
ndescriptorCount
public static void ndescriptorCount(long struct, int value)Unsafe version ofdescriptorCount.
-
-