VkDescriptorPoolCreateInfo (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkDescriptorPoolCreateInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkDescriptorPoolCreateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters of a newly created descriptor pool.
Description

If multiple VkDescriptorPoolSize structures appear in the pPoolSizes array then the pool will be created with enough storage for the total number of descriptors of each type.

Fragmentation of a descriptor pool is possible and may lead to descriptor set allocation failures. A failure due to fragmentation is defined as failing a descriptor set allocation despite the sum of all outstanding descriptor set allocations from the pool plus the requested allocation requiring no more than the total number of descriptors requested at pool creation. Implementations provide certain guarantees of when fragmentation must not cause allocation failure, as described below.

If a descriptor pool has not had any descriptor sets freed since it was created or most recently reset then fragmentation must not cause an allocation failure (note that this is always the case for a pool created without the DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT bit set). Additionally, if all sets allocated from the pool since it was created or most recently reset use the same number of descriptors (of each type) and the requested allocation also uses that same number of descriptors (of each type), then fragmentation must not cause an allocation failure.

If an allocation failure occurs due to fragmentation, an application can create an additional descriptor pool to perform further descriptor set allocations.

If flags has the DESCRIPTOR_POOL_CREATE_UPDATE_AFTER_BIND_BIT_EXT bit set, descriptor pool creation may fail with the error ERROR_FRAGMENTATION_EXT if the total number of descriptors across all pools (including this one) created with this bit set exceeds maxUpdateAfterBindDescriptorsInAllPools, or if fragmentation of the underlying hardware resources occurs.

Valid Usage
- maxSets must be greater than 0
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO
- pNext must be NULL or a pointer to a valid instance of VkDescriptorPoolInlineUniformBlockCreateInfoEXT
- flags must be a valid combination of VkDescriptorPoolCreateFlagBits values
- pPoolSizes must be a valid pointer to an array of poolSizeCount valid VkDescriptorPoolSize structures
- poolSizeCount must be greater than 0
See Also

VkDescriptorPoolSize, CreateDescriptorPool

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- flags – a bitmask of VkDescriptorPoolCreateFlagBits specifying certain supported operations on the pool.
- maxSets – the maximum number of descriptor sets that can be allocated from the pool.
- poolSizeCount – the number of elements in pPoolSizes.
- pPoolSizes – a pointer to an array of VkDescriptorPoolSize structures, each containing a descriptor type and number of descriptors of that type to be allocated in the pool.
Layout
```
 struct VkDescriptorPoolCreateInfo {
     VkStructureType sType;
     void const * pNext;
     VkDescriptorPoolCreateFlags flags;
     uint32_t maxSets;
     uint32_t poolSizeCount;
     VkDescriptorPoolSize const * pPoolSizes;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkDescriptorPoolCreateInfo.Buffer
An array of VkDescriptorPoolCreateInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkDescriptorPoolCreateInfo.Buffer` An array of `VkDescriptorPoolCreateInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FLAGS` The struct member offsets.
`static int`	`MAXSETS` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`POOLSIZECOUNT` The struct member offsets.
`static int`	`PPOOLSIZES` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkDescriptorPoolCreateInfo(java.nio.ByteBuffer container)` Creates a `VkDescriptorPoolCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkDescriptorPoolCreateInfo`	`calloc()` Returns a new `VkDescriptorPoolCreateInfo` instance allocated with `memCalloc`.
`static VkDescriptorPoolCreateInfo.Buffer`	`calloc(int capacity)` Returns a new `VkDescriptorPoolCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkDescriptorPoolCreateInfo`	`callocStack()` Returns a new `VkDescriptorPoolCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorPoolCreateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkDescriptorPoolCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorPoolCreateInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorPoolCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorPoolCreateInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorPoolCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorPoolCreateInfo`	`create()` Returns a new `VkDescriptorPoolCreateInfo` instance allocated with `BufferUtils`.
`static VkDescriptorPoolCreateInfo.Buffer`	`create(int capacity)` Returns a new `VkDescriptorPoolCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkDescriptorPoolCreateInfo`	`create(long address)` Returns a new `VkDescriptorPoolCreateInfo` instance for the specified memory address.
`static VkDescriptorPoolCreateInfo.Buffer`	`create(long address, int capacity)` Create a `VkDescriptorPoolCreateInfo.Buffer` instance at the specified memory.
`static VkDescriptorPoolCreateInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDescriptorPoolCreateInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VkDescriptorPoolCreateInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`static VkDescriptorPoolCreateInfo`	`malloc()` Returns a new `VkDescriptorPoolCreateInfo` instance allocated with `memAlloc`.
`static VkDescriptorPoolCreateInfo.Buffer`	`malloc(int capacity)` Returns a new `VkDescriptorPoolCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkDescriptorPoolCreateInfo`	`mallocStack()` Returns a new `VkDescriptorPoolCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkDescriptorPoolCreateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkDescriptorPoolCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDescriptorPoolCreateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorPoolCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDescriptorPoolCreateInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorPoolCreateInfo` instance allocated on the specified `MemoryStack`.
`int`	`maxSets()` Returns the value of the `maxSets` field.
`VkDescriptorPoolCreateInfo`	`maxSets(int value)` Sets the specified value to the `maxSets` field.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static int`	`nmaxSets(long struct)` Unsafe version of `maxSets()`.
`static void`	`nmaxSets(long struct, int value)` Unsafe version of `maxSets`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`npoolSizeCount(long struct)` Unsafe version of `poolSizeCount()`.
`static void`	`npoolSizeCount(long struct, int value)` Sets the specified value to the `poolSizeCount` field of the specified `struct`.
`static VkDescriptorPoolSize.Buffer`	`npPoolSizes(long struct)` Unsafe version of `pPoolSizes()`.
`static void`	`npPoolSizes(long struct, VkDescriptorPoolSize.Buffer value)` Unsafe version of `pPoolSizes`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkDescriptorPoolCreateInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`int`	`poolSizeCount()` Returns the value of the `poolSizeCount` field.
`VkDescriptorPoolSize.Buffer`	`pPoolSizes()` Returns a `VkDescriptorPoolSize.Buffer` view of the struct array pointed to by the `pPoolSizes` field.
`VkDescriptorPoolCreateInfo`	`pPoolSizes(VkDescriptorPoolSize.Buffer value)` Sets the address of the specified `VkDescriptorPoolSize.Buffer` to the `pPoolSizes` 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()`
`int`	`sType()` Returns the value of the `sType` field.
`VkDescriptorPoolCreateInfo`	`sType(int value)` Sets the specified value to the `sType` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - FLAGS
```
public static final int FLAGS
```
    The struct member offsets.
  - MAXSETS
```
public static final int MAXSETS
```
    The struct member offsets.
  - POOLSIZECOUNT
```
public static final int POOLSIZECOUNT
```
    The struct member offsets.
  - PPOOLSIZES
```
public static final int PPOOLSIZES
```
    The struct member offsets.
- Constructor Detail
  - VkDescriptorPoolCreateInfo
```
public VkDescriptorPoolCreateInfo(java.nio.ByteBuffer container)
```
    Creates a VkDescriptorPoolCreateInfo instance at the current position of the specified ByteBuffer 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - maxSets
```
public int maxSets()
```
    Returns the value of the maxSets field.
  - poolSizeCount
```
public int poolSizeCount()
```
    Returns the value of the poolSizeCount field.
  - pPoolSizes
```
public VkDescriptorPoolSize.Buffer pPoolSizes()
```
    Returns a VkDescriptorPoolSize.Buffer view of the struct array pointed to by the pPoolSizes field.
  - sType
```
public VkDescriptorPoolCreateInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkDescriptorPoolCreateInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkDescriptorPoolCreateInfo flags(int value)
```
    Sets the specified value to the flags field.
  - maxSets
```
public VkDescriptorPoolCreateInfo maxSets(int value)
```
    Sets the specified value to the maxSets field.
  - pPoolSizes
```
public VkDescriptorPoolCreateInfo pPoolSizes(VkDescriptorPoolSize.Buffer value)
```
    Sets the address of the specified VkDescriptorPoolSize.Buffer to the pPoolSizes field.
  - set
```
public VkDescriptorPoolCreateInfo set(int sType,
                                      long pNext,
                                      int flags,
                                      int maxSets,
                                      VkDescriptorPoolSize.Buffer pPoolSizes)
```
    Initializes this struct with the specified values.
  - 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 new VkDescriptorPoolCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkDescriptorPoolCreateInfo calloc()
```
    Returns a new VkDescriptorPoolCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkDescriptorPoolCreateInfo create()
```
    Returns a new VkDescriptorPoolCreateInfo instance allocated with BufferUtils.
  - create
```
public static VkDescriptorPoolCreateInfo create(long address)
```
    Returns a new VkDescriptorPoolCreateInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkDescriptorPoolCreateInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkDescriptorPoolCreateInfo.Buffer malloc(int capacity)
```
    Returns a new VkDescriptorPoolCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkDescriptorPoolCreateInfo.Buffer calloc(int capacity)
```
    Returns a new VkDescriptorPoolCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDescriptorPoolCreateInfo.Buffer create(int capacity)
```
    Returns a new VkDescriptorPoolCreateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDescriptorPoolCreateInfo.Buffer create(long address,
                                                       int capacity)
```
    Create a VkDescriptorPoolCreateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkDescriptorPoolCreateInfo.Buffer createSafe(long address,
                                                                     int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkDescriptorPoolCreateInfo mallocStack()
```
    Returns a new VkDescriptorPoolCreateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDescriptorPoolCreateInfo callocStack()
```
    Returns a new VkDescriptorPoolCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDescriptorPoolCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorPoolCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDescriptorPoolCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorPoolCreateInfo instance allocated on the specified MemoryStack 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 new VkDescriptorPoolCreateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDescriptorPoolCreateInfo.Buffer callocStack(int capacity)
```
    Returns a new VkDescriptorPoolCreateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDescriptorPoolCreateInfo.Buffer mallocStack(int capacity,
                                                            org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorPoolCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDescriptorPoolCreateInfo.Buffer callocStack(int capacity,
                                                            org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorPoolCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - nmaxSets
```
public static int nmaxSets(long struct)
```
    Unsafe version of maxSets().
  - npoolSizeCount
```
public static int npoolSizeCount(long struct)
```
    Unsafe version of poolSizeCount().
  - npPoolSizes
```
public static VkDescriptorPoolSize.Buffer npPoolSizes(long struct)
```
    Unsafe version of pPoolSizes().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - nmaxSets
```
public static void nmaxSets(long struct,
                            int value)
```
    Unsafe version of maxSets.
  - npoolSizeCount
```
public static void npoolSizeCount(long struct,
                                  int value)
```
    Sets the specified value to the poolSizeCount field of the specified struct.
  - npPoolSizes
```
public static void npPoolSizes(long struct,
                               VkDescriptorPoolSize.Buffer value)
```
    Unsafe version of pPoolSizes.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkDescriptorPoolCreateInfo

Description

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

FLAGS

MAXSETS

POOLSIZECOUNT

PPOOLSIZES

Constructor Detail

VkDescriptorPoolCreateInfo

Method Detail

sizeof

sType

pNext

flags

maxSets

poolSizeCount

pPoolSizes

sType

pNext

flags

maxSets

pPoolSizes

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

nmaxSets

npoolSizeCount

npPoolSizes

nsType

npNext

nflags

nmaxSets

npoolSizeCount

npPoolSizes

validate

validate