D3D11_COMPARISON_FUNC Enumeration

Comparison options.

Syntax

typedef enum D3D11_COMPARISON_FUNC
{
    D3D11_COMPARISON_NEVER = 1,
    D3D11_COMPARISON_LESS = 2,
    D3D11_COMPARISON_EQUAL = 3,
    D3D11_COMPARISON_LESS_EQUAL = 4,
    D3D11_COMPARISON_GREATER = 5,
    D3D11_COMPARISON_NOT_EQUAL = 6,
    D3D11_COMPARISON_GREATER_EQUAL = 7,
    D3D11_COMPARISON_ALWAYS = 8
} D3D11_COMPARISON_FUNC;  

Constants

Constant Description
D3D11_COMPARISON_NEVER Never pass the comparison.
D3D11_COMPARISON_LESS If the source data is less than the destination data, the comparison passes.
D3D11_COMPARISON_EQUAL If the source data is equal to the destination data, the comparison passes.
D3D11_COMPARISON_LESS_EQUAL If the source data is less than or equal to the destination data, the comparison passes.
D3D11_COMPARISON_GREATER If the source data is greater than the destination data, the comparison passes.
D3D11_COMPARISON_NOT_EQUAL If the source data is not equal to the destination data, the comparison passes.
D3D11_COMPARISON_GREATER_EQUAL If the source data is greater than or equal to the destination data, the comparison passes.
D3D11_COMPARISON_ALWAYS Always pass the comparison.

Remarks

A comparison option determines whether how the runtime compares source (new) data against destination (existing) data before storing the new data. The comparison option is declared in a description before an object is created. The API allows you to set a comparison option for a depth-stencil buffer (see D3D11_DEPTH_STENCIL_DESC), depth-stencil operations (see D3D11_DEPTH_STENCILOP_DESC), or sampler state (see D3D11_SAMPLER_DESC).

Requirements

Header: Declared in d3d11_x.h (d3d11.h on other Windows platforms).