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

59 lines
1.5 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/
vkCmdSetStencilWriteMask(3)
===========================
Name
----
vkCmdSetStencilWriteMask - Set the stencil write mask dynamic state.
C Specification
---------------
// refBegin vkCmdSetStencilWriteMask Set the stencil write mask dynamic state.
If the pipeline state object is created with the
ename:VK_DYNAMIC_STATE_STENCIL_WRITE_MASK dynamic state enabled, then to
dynamically set the stencil write mask call:
include::../api/protos/vkCmdSetStencilWriteMask.txt[]
Parameters
----------
* pname:commandBuffer is the command buffer into which the command will be
recorded.
* pname:faceMask is a bitmask of elink:VkStencilFaceFlagBits specifying
the set of stencil state for which to update the write mask, as
described above for flink:vkCmdSetStencilCompareMask.
* pname:writeMask is the new value to use as the stencil write mask.
Description
-----------
include::../validity/protos/vkCmdSetStencilWriteMask.txt[]
See Also
--------
slink:VkCommandBuffer, elink:VkStencilFaceFlags
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCmdSetStencilWriteMask
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]