VKRESETDESCRIPTORPOO(3)

NAME
vkResetDescriptorPool - Resets a descriptor pool object

C SPECIFICATION

To return all descriptor sets allocated from a given pool to the pool, rather than freeing individual descriptor sets, call:

    VkResult vkResetDescriptorPool(
        VkDevice                                    device,
        VkDescriptorPool                            descriptorPool,
        VkDescriptorPoolResetFlags                  flags);

PARAMETERS

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

    • descriptorPool is the descriptor pool to be reset.

    • flags is reserved for future use.

DESCRIPTION

Resetting a descriptor pool recycles all of the resources from all of the descriptor sets allocated from the descriptor pool back to the descriptor pool, and the descriptor sets are implicitly freed. Valid Usage

    • All uses of descriptorPool (via any allocated descriptor sets) must have completed execution
Valid Usage (Implicit)

    • device must be a valid VkDevice handle

    • descriptorPool must be a valid VkDescriptorPool handle

    • flags must be 0

    • descriptorPool must have been created, allocated, or retrieved from device
Host Synchronization

    • Host access to descriptorPool must be externally synchronized

    • Host access to any VkDescriptorSet objects allocated from descriptorPool must be externally synchronized
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

VkDescriptorPool, VkDescriptorPoolResetFlags, VkDevice

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.