D3D12_COMPARISON_FUNC enumeration (d3d12.h)

Specifies comparison options.

Syntax

typedef enum D3D12_COMPARISON_FUNC {
  D3D12_COMPARISON_FUNC_NONE,
  D3D12_COMPARISON_FUNC_NEVER = 1,
  D3D12_COMPARISON_FUNC_LESS = 2,
  D3D12_COMPARISON_FUNC_EQUAL = 3,
  D3D12_COMPARISON_FUNC_LESS_EQUAL = 4,
  D3D12_COMPARISON_FUNC_GREATER = 5,
  D3D12_COMPARISON_FUNC_NOT_EQUAL = 6,
  D3D12_COMPARISON_FUNC_GREATER_EQUAL = 7,
  D3D12_COMPARISON_FUNC_ALWAYS = 8
} ;

Constants

D3D12_COMPARISON_FUNC_NEVER Value: 1 Never pass the comparison.
D3D12_COMPARISON_FUNC_LESS Value: 2 If the source data is less than the destination data, the comparison passes.
D3D12_COMPARISON_FUNC_EQUAL Value: 3 If the source data is equal to the destination data, the comparison passes.
D3D12_COMPARISON_FUNC_LESS_EQUAL Value: 4 If the source data is less than or equal to the destination data, the comparison passes.
D3D12_COMPARISON_FUNC_GREATER Value: 5 If the source data is greater than the destination data, the comparison passes.
D3D12_COMPARISON_FUNC_NOT_EQUAL Value: 6 If the source data is not equal to the destination data, the comparison passes.
D3D12_COMPARISON_FUNC_GREATER_EQUAL Value: 7 If the source data is greater than or equal to the destination data, the comparison passes.
D3D12_COMPARISON_FUNC_ALWAYS Value: 8 Always pass the comparison.

Remarks

A comparison option determines 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 (D3D12_DEPTH_STENCIL_DESC)
• depth-stencil operations (D3D12_DEPTH_STENCILOP_DESC)
• sampler state (D3D12_SAMPLER_DESC)

Requirements

Requirement	Value
Header	d3d12.h

See also

CD3DX12_DEPTH_STENCIL_DESC

Core Enumerations