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

66 lines
1.6 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/
vkResetCommandBuffer(3)
=======================
Name
----
vkResetCommandBuffer - Reset a command buffer.
C Specification
---------------
// refBegin vkResetCommandBuffer Reset a command buffer.
To reset command buffers, call:
include::../protos/vkResetCommandBuffer.txt[]
Parameters
----------
* pname:commandBuffer is the command buffer to reset. The command buffer
can: be in any state, and is put in the initial state.
* pname:flags is a bitmask controlling the reset operation. Bits which
can: be set include:
+
--
// refBegin VkCommandBufferResetFlagBits - Bitmask controlling behavior of a command buffer reset
include::../enums/VkCommandBufferResetFlagBits.txt[]
--
+
If pname:flags includes ename:VK_COMMAND_BUFFER_RESET_RELEASE_RESOURCES_BIT,
then most or all memory resources currently owned by the command buffer
should: be returned to the parent command pool. If this flag is not set,
then the command buffer may: hold onto memory resources and reuse them when
recording commands.
Description
-----------
include::../validity/protos/vkResetCommandBuffer.txt[]
See Also
--------
slink:VkCommandBuffer, elink:VkCommandBufferResetFlags
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkResetCommandBuffer
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]