C Specification

Possible values of VkStencilOpState::compareOp, specifying the stencil comparison function, are:

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 specifies that the test never passes.

  • VK_COMPARE_OP_LESS specifies that the test passes when R < S.

  • VK_COMPARE_OP_EQUAL specifies that the test passes when R = S.

  • VK_COMPARE_OP_LESS_OR_EQUAL specifies that the test passes when R ≤ S.

  • VK_COMPARE_OP_GREATER specifies that the test passes when R > S.

  • VK_COMPARE_OP_NOT_EQUAL specifies that the test passes when R ≠ S.

  • VK_COMPARE_OP_GREATER_OR_EQUAL specifies that the test passes when R ≥ S.

  • VK_COMPARE_OP_ALWAYS specifies that the test always passes.

See Also

Document Notes

For more information, see the Vulkan Specification at URL

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

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