VKDESTROYDESCRIPTORP(3)

NAME
vkDestroyDescriptorPool - Destroy a descriptor pool object

C SPECIFICATION

    void vkDestroyDescriptorPool(
        VkDevice                                    device,
        VkDescriptorPool                            descriptorPool,
        const VkAllocationCallbacks*                pAllocator);

PARAMETERS

device
    Logical device which owns the object.

descriptorPool
    The handle of the descriptor pool to destroy.

DESCRIPTION

vkDestroyDescriptorPool destroys the descriptor pool object whose handle is specified in descriptorPool. descriptorPool must be a valid handle to descriptor pool object created through a successful call to vkCreateDescriptorPool on device. Attempts to destroy VK_NULL_HANDLE are silently ignored. After a descriptor pool object has been destroyed, its handle becomes invalid and must not be accessed again.

Any descriptor sets allocated from the pool should be freed before the pool is destroyed. Not returning descriptor sets to the pool before destroying the pool may cause a resource leak.

VALID USAGE

    • device must be a valid VkDevice handle

    • If descriptorPool is not VK_NULL_HANDLE, descriptorPool must be a valid VkDescriptorPool handle

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

    • If descriptorPool is a valid handle, it must have been created, allocated or retrieved from device

    • Each of device and descriptorPool that are valid handles must have been created, allocated or retrieved from the same VkPhysicalDevice

    • All submitted commands that refer to descriptorPool (via any allocated descriptor sets) must have completed execution

    • If VkAllocationCallbacks were provided when descriptorPool was created, a compatible set of callbacks must be provided here

    • If no VkAllocationCallbacks were provided when descriptorPool was created, pAllocator must be NULL

HOST SYNCHRONIZATION

    • Host access to descriptorPool must be externally synchronized

SEE ALSO

vkCreateDescriptorPool

COPYRIGHT

Copyright © 2014-2016 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

AUTHOR

Khronos Group
    Author.