VKCREATEDESCRIPTORPO(3)

NAME
vkCreateDescriptorPool - Creates a descriptor pool object

C SPECIFICATION

To create a descriptor pool object, call:

    VkResult vkCreateDescriptorPool(
        VkDevice                                    device,
        const VkDescriptorPoolCreateInfo*           pCreateInfo,
        const VkAllocationCallbacks*                pAllocator,
        VkDescriptorPool*                           pDescriptorPool);

PARAMETERS

    • device is the logical device that creates the descriptor pool.

    • pCreateInfo is a pointer to an instance of the VkDescriptorPoolCreateInfo structure specifying the state of the descriptor pool object.

    • pAllocator controls host memory allocation as described in the Memory Allocation chapter.

    • pDescriptorPool points to a VkDescriptorPool handle in which the resulting descriptor pool object is returned.

DESCRIPTION

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

The created descriptor pool is returned in pDescriptorPool. Valid Usage (Implicit)

    • device must be a valid VkDevice handle

    • pCreateInfo must be a pointer to a valid VkDescriptorPoolCreateInfo structure

    • If pAllocator is not NULL, pAllocator must be a pointer to a valid VkAllocationCallbacks structure

    • pDescriptorPool must be a pointer to a VkDescriptorPool handle
Return Codes

On success, this command returns

        • VK_SUCCESS

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

SEE ALSO

VkAllocationCallbacks, VkDescriptorPool, VkDescriptorPoolCreateInfo, VkDevice

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCreateDescriptorPool

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification,not directly.

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.