Vulkan-Docs/doc/specs/vulkan/man/vkResetDescriptorPool.txt

59 lines
1.4 KiB
Plaintext

// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/
vkResetDescriptorPool(3)
========================
Name
----
vkResetDescriptorPool - Resets a descriptor pool object.
C Specification
---------------
// refBegin vkResetDescriptorPool Resets a descriptor pool object.
To return all descriptor sets allocated from a given pool to the pool,
rather than freeing individual descriptor sets, call:
include::../protos/vkResetDescriptorPool.txt[]
Parameters
----------
* pname:device is the logical device that owns the descriptor pool.
* pname:descriptorPool is the descriptor pool to be reset.
* pname: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.
include::../validity/protos/vkResetDescriptorPool.txt[]
See Also
--------
slink:VkDescriptorPool, elink:VkDescriptorPoolResetFlags, slink: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.
include::footer.txt[]