VKCOMPAREOP(3)

NAME
VkCompareOp - Stencil comparison function

C SPECIFICATION

compareOp is a symbolic constant that determines the stencil comparison function:

    typedef enum VkCompareOp {
        VK_COMPARE_OP_NEVER = 0,
        VK_COMPARE_OP_LESS = 1,
        VK_COMPARE_OP_EQUAL = 2,
        VK_COMPARE_OP_LESS_OR_EQUAL = 3,
        VK_COMPARE_OP_GREATER = 4,
        VK_COMPARE_OP_NOT_EQUAL = 5,
        VK_COMPARE_OP_GREATER_OR_EQUAL = 6,
        VK_COMPARE_OP_ALWAYS = 7,
    } VkCompareOp;

DESCRIPTION

    • VK_COMPARE_OP_NEVER: the test never passes.

    • VK_COMPARE_OP_LESS: the test passes when R < S.

    • VK_COMPARE_OP_EQUAL: the test passes when R = S.

    • VK_COMPARE_OP_LESS_OR_EQUAL: the test passes when R ≤ S.

    • VK_COMPARE_OP_GREATER: the test passes when R > S.

    • VK_COMPARE_OP_NOT_EQUAL: the test passes when R ≠ S.

    • VK_COMPARE_OP_GREATER_OR_EQUAL: the test passes when R ≥ S.

    • VK_COMPARE_OP_ALWAYS: the test always passes.

SEE ALSO

VkPipelineDepthStencilStateCreateInfo, VkSamplerCreateInfo, VkStencilOpState

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkCompareOp

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.