vkResetDescriptorPool(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:

// Provided by VK_VERSION_1_0VkResult 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 thedescriptor sets allocated from the descriptor pool back to the descriptorpool, and the descriptor sets are implicitly freed.

Valid Usage

VUID-vkResetDescriptorPool-descriptorPool-00313
All uses ofdescriptorPool (via any allocated descriptor sets)must have completed execution

Valid Usage (Implicit)

VUID-vkResetDescriptorPool-device-parameter
devicemust be a validVkDevice handle
VUID-vkResetDescriptorPool-descriptorPool-parameter
descriptorPoolmust be a validVkDescriptorPool handle
VUID-vkResetDescriptorPool-flags-zerobitmask
flagsmust be0
VUID-vkResetDescriptorPool-descriptorPool-parent
descriptorPoolmust have been created, allocated, or retrieved fromdevice

Host Synchronization

Host access todescriptorPoolmust be externally synchronized
Host access to anyVkDescriptorSet objects allocated fromdescriptorPoolmust be externally synchronized

Return Codes

Success

VK_SUCCESS

Failure

Document Notes

For more information, see theVulkan Specification.

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

Movatterモバイル変換