VKSTENCILOPSTATE(3)

NAME
VkStencilOpState - Structure specifying stencil operation state

C SPECIFICATION

The VkStencilOpState structure is defined as:

    typedef struct VkStencilOpState {
        VkStencilOp    failOp;
        VkStencilOp    passOp;
        VkStencilOp    depthFailOp;
        VkCompareOp    compareOp;
        uint32_t       compareMask;
        uint32_t       writeMask;
        uint32_t       reference;
    } VkStencilOpState;

MEMBERS

    • failOp is the action performed on samples that fail the stencil test.

    • passOp is the action performed on samples that pass both the depth and stencil tests.

    • depthFailOp is the action performed on samples that pass the stencil test and fail the depth test.

    • compareOp is the comparison operator used in the stencil test.

    • compareMask selects the bits of the unsigned integer stencil values participating in the stencil test.

    • writeMask selects the bits of the unsigned integer stencil values updated by the stencil test in the stencil framebuffer attachment.

    • reference is an integer reference value that is used in the unsigned stencil comparison.

DESCRIPTION
Valid Usage (Implicit)

    • failOp must be a valid VkStencilOp value

    • passOp must be a valid VkStencilOp value

    • depthFailOp must be a valid VkStencilOp value

    • compareOp must be a valid VkCompareOp value

SEE ALSO

VkCompareOp, VkPipelineDepthStencilStateCreateInfo, 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.

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.