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

69 lines
1.7 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/
vkResetCommandPool(3)
=====================
Name
----
vkResetCommandPool - Reset a command pool.
C Specification
---------------
// refBegin vkResetCommandPool Reset a command pool.
To reset a command pool, call:
include::../api/protos/vkResetCommandPool.txt[]
Parameters
----------
* pname:device is the logical device that owns the command pool.
* pname:commandPool is the command pool to reset.
* pname:flags contains additional flags controlling the behavior of the
reset. Bits which can: be set include:
+
--
// refBegin VkCommandPoolResetFlagBits - Bitmask controlling behavior of a command pool reset
include::../api/enums/VkCommandPoolResetFlagBits.txt[]
--
+
If pname:flags includes ename:VK_COMMAND_POOL_RESET_RELEASE_RESOURCES_BIT,
resetting a command pool recycles all of the resources from the command pool
back to the system.
Description
-----------
Resetting a command pool recycles all of the resources from all of the
command buffers allocated from the command pool back to the command pool.
All command buffers that have been allocated from the command pool are put
in the initial state.
include::../validity/protos/vkResetCommandPool.txt[]
See Also
--------
slink:VkCommandPool, elink:VkCommandPoolResetFlags, 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#vkResetCommandPool
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]