Vulkan.Core10.Enums.CompareOp

VkCompareOp - Comparison operator for depth, stencil, and sampler operations

Description

• COMPARE_OP_NEVER specifies that the comparison always evaluates false.

• COMPARE_OP_LESS specifies that the comparison evaluates reference < test.

• COMPARE_OP_EQUAL specifies that the comparison evaluates reference = test.

• COMPARE_OP_LESS_OR_EQUAL specifies that the comparison evaluates reference ≤ test.

• COMPARE_OP_GREATER specifies that the comparison evaluates reference > test.

• COMPARE_OP_NOT_EQUAL specifies that the comparison evaluates reference ≠ test.

• COMPARE_OP_GREATER_OR_EQUAL specifies that the comparison evaluates reference ≥ test.

• COMPARE_OP_ALWAYS specifies that the comparison always evaluates true.

Comparison operators are used for:

• The Depth Compare Operation operator for a sampler, specified by SamplerCreateInfo::compareOp.

• The stencil comparison operator for the stencil test, specified by cmdSetStencilOp::compareOp or StencilOpState::compareOp.

• The Depth Comparison operator for the depth test, specified by cmdSetDepthCompareOp::depthCompareOp or PipelineDepthStencilStateCreateInfo::depthCompareOp.

Each such use describes how the reference and test values for that comparison are determined.

See Also

VK_VERSION_1_0, PipelineDepthStencilStateCreateInfo, SamplerCreateInfo, StencilOpState, cmdSetDepthCompareOp, cmdSetDepthCompareOp, cmdSetStencilOp, cmdSetStencilOp