vkCreateDescriptorPool(3)

Name

vkCreateDescriptorPool - Creates a descriptor pool object

C Specification

To create a descriptor pool object, call:

// Provided by VK_VERSION_1_0
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 a VkDescriptorPoolCreateInfo structure specifying the state of the descriptor pool object.
pAllocator controls host memory allocation as described in the Memory Allocation chapter.
pDescriptorPool is a pointer to a VkDescriptorPool handle in which the resulting descriptor pool object is returned.

Description

The created descriptor pool is returned in pDescriptorPool.

Valid Usage (Implicit)

VUID-vkCreateDescriptorPool-device-parameter
device must be a valid VkDevice handle
VUID-vkCreateDescriptorPool-pCreateInfo-parameter
pCreateInfo must be a valid pointer to a valid VkDescriptorPoolCreateInfo structure
VUID-vkCreateDescriptorPool-pAllocator-parameter
If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
VUID-vkCreateDescriptorPool-pDescriptorPool-parameter
pDescriptorPool must be a valid pointer to a VkDescriptorPool handle
VUID-vkCreateDescriptorPool-device-queuecount
The device must have been created with at least 1 queue

Return Codes

Success

VK_SUCCESS

Failure

VK_ERROR_FRAGMENTATION_EXT
VK_ERROR_OUT_OF_DEVICE_MEMORY
VK_ERROR_OUT_OF_HOST_MEMORY
VK_ERROR_UNKNOWN
VK_ERROR_VALIDATION_FAILED

Document Notes

For more information, see the Vulkan Specification.

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