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

64 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/
VkStencilOpState(3)
===================
Name
----
VkStencilOpState - Structure specifying stencil operation state
C Specification
---------------
// refBegin VkStencilOpState - Structure specifying stencil operation state
The sname:VkStencilOpState structure is defined as:
include::../api/structs/VkStencilOpState.txt[]
Members
-------
* pname:failOp is the action performed on samples that fail the stencil
test.
* pname:passOp is the action performed on samples that pass both the depth
and stencil tests.
* pname:depthFailOp is the action performed on samples that pass the
stencil test and fail the depth test.
* pname:compareOp is the comparison operator used in the stencil test.
* pname:compareMask selects the bits of the unsigned integer stencil
values participating in the stencil test.
* pname:writeMask selects the bits of the unsigned integer stencil values
updated by the stencil test in the stencil framebuffer attachment.
* pname:reference is an integer reference value that is used in the
unsigned stencil comparison.
Description
-----------
include::../validity/structs/VkStencilOpState.txt[]
See Also
--------
elink:VkCompareOp, slink:VkPipelineDepthStencilStateCreateInfo, elink:VkStencilOp
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkStencilOpState
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]