70 lines
2.0 KiB
Plaintext
70 lines
2.0 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/
|
|
|
|
vkCmdSetStencilCompareMask(3)
|
|
=============================
|
|
|
|
Name
|
|
----
|
|
vkCmdSetStencilCompareMask - Set the stencil compare mask dynamic state.
|
|
|
|
C Specification
|
|
---------------
|
|
|
|
// refBegin vkCmdSetStencilCompareMask Set the stencil compare mask dynamic state.
|
|
|
|
If the pipeline state object is created with the
|
|
ename:VK_DYNAMIC_STATE_STENCIL_COMPARE_MASK dynamic state enabled, then to
|
|
dynamically set the stencil compare mask call:
|
|
|
|
include::../api/protos/vkCmdSetStencilCompareMask.txt[]
|
|
|
|
|
|
Parameters
|
|
----------
|
|
|
|
* pname:commandBuffer is the command buffer into which the command will be
|
|
recorded.
|
|
* pname:faceMask is a bitmask specifying the set of stencil state for
|
|
which to update the compare mask. Bits which can: be set include:
|
|
+
|
|
--
|
|
// refBegin VkStencilFaceFlagBits - Bitmask specifying sets of stencil state for which to update the compare mask
|
|
include::../api/enums/VkStencilFaceFlagBits.txt[]
|
|
--
|
|
** ename:VK_STENCIL_FACE_FRONT_BIT indicates that only the front set of
|
|
stencil state is updated.
|
|
** ename:VK_STENCIL_FACE_BACK_BIT indicates that only the back set of
|
|
stencil state is updated.
|
|
** ename:VK_STENCIL_FRONT_AND_BACK is the combination of
|
|
ename:VK_STENCIL_FACE_FRONT_BIT and ename:VK_STENCIL_FACE_BACK_BIT and
|
|
indicates that both sets of stencil state are updated.
|
|
* pname:compareMask is the new value to use as the stencil compare mask.
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
include::../validity/protos/vkCmdSetStencilCompareMask.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#vkCmdSetStencilCompareMask
|
|
|
|
This page is extracted from the Vulkan Specification.
|
|
Fixes and changes should be made to the Specification,not directly.
|
|
|
|
include::footer.txt[]
|
|
|