Class VkDescriptorPoolCreateInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class VkDescriptorPoolCreateInfo
    extends Struct
    implements 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)
    See Also

    VkDescriptorPoolSize, CreateDescriptorPool

    Member documentation

    • sType – the type of this structure.
    • pNextNULL 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;
     }