D3D12XBOX_HISTENCIL_COMPARE_STATE Structure

Stores the state of comparison, to control how the comparison is done.

Syntax

typedef struct D3D12XBOX_HISTENCIL_COMPARE_STATE {
    D3D12XBOX_HISTENCIL_COMPARE_FUNCTION CompareFunction : 4;
    UINT CompareValue : 8;
    UINT CompareMask : 12;
    BOOL Enabled : 8;
} D3D12XBOX_HISTENCIL_COMPARE_STATE;  

Members

CompareFunction
The comparison function criterion to use, as a D3D12XBOX_HISTENCIL_COMPARE_FUNCTION enumeration constant, such as for “less than” or “equal to”.

CompareValue
The 8-bit reference value for the comparison function.

CompareMask
The comparison mask. D3D12XBOX_HISTENCIL_COMPARE_STATE matches a hardware register, so this field is padded out to match the location of the bits in the register. The value in this field is 8-bits.

Enabled
Whether 1-bit Hi-Stencil is enabled. D3D12XBOX_HISTENCIL_COMPARE_STATE matches a hardware register, so this field is padded out to match the location of the bits in the register. The value in this field is 1-bit.

Remarks

This structure is a component of the D3D12XBOX_HISTENCIL_CONTROL structure, which is a parameter of ID3D12GraphicsCommandList::SetHiStencilControlX.

Requirements

Header: Declared in d3d12_x.h.

See also

D3D12XBOX_HISTENCIL_COMPARE_FUNCTION