VkCompareOp(3)

# VkCompareOp(3) Manual Page

## Name

VkCompareOp - Stencil comparison function

Loading... please wait.

## 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 evaluates to false.

- `VK_COMPARE_OP_LESS` specifies that the test evaluates A < B.

- `VK_COMPARE_OP_EQUAL` specifies that the test evaluates A = B.

- `VK_COMPARE_OP_LESS_OR_EQUAL` specifies that the test evaluates A ≤ B.

- `VK_COMPARE_OP_GREATER` specifies that the test evaluates A > B.

- `VK_COMPARE_OP_NOT_EQUAL` specifies that the test evaluates A ≠ B.

- `VK_COMPARE_OP_GREATER_OR_EQUAL` specifies that the test evaluates A ≥ B.

- `VK_COMPARE_OP_ALWAYS` specifies that the test evaluates to true.

## See Also

VkPipelineDepthStencilStateCreateInfo, VkSamplerCreateInfo, VkStencilOpState

## Document Notes

For more information, see the Vulkan Specification

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

## Copyright

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