VKRESETDESCRIPTORPOO(3)

NAME
vkResetDescriptorPool - Resets a descriptor pool object.

C SPECIFICATION

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

PARAMETERS

device
    Handle to the logical device which owns the descriptor pool object.

descriptorPool
    Handle to the descriptor pool object which needs to be reset.

DESCRIPTION

vkResetDescriptorPool returns all descriptor sets allocated from descriptorPool to the pool. This returns the pool to its initial state. device must be the handle to the device that owns the pool.

VALID USAGE

    • 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

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

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

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

vkCreateDescriptorPool, vkAllocateDescriptorSets, vkFreeDescriptorSets

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.