Diligent::StencilOpDesc Struct Reference

Describes stencil operations that are performed based on the results of depth test. More...

#include <DepthStencilState.h>

Public Member Functions
constexpr bool	operator== (const StencilOpDesc &rhs) const
	Tests if two structures are equivalent.

Public Attributes
STENCIL_OP	StencilFailOp = STENCIL_OP_KEEP
STENCIL_OP	StencilDepthFailOp = STENCIL_OP_KEEP
STENCIL_OP	StencilPassOp = STENCIL_OP_KEEP
COMPARISON_FUNCTION	StencilFunc = COMPARISON_FUNC_ALWAYS

Detailed Description

Describes stencil operations that are performed based on the results of depth test.

The structure generally mirrors D3D11_DEPTH_STENCILOP_DESC/D3D12_DEPTH_STENCILOP_DESC structure. It is used by Diligent::DepthStencilStateDesc structure to describe the stencil operations for the front and back facing polygons.

Member Data Documentation

StencilDepthFailOp

STENCIL_OP Diligent::StencilOpDesc::StencilDepthFailOp = STENCIL_OP_KEEP

The stencil operation to perform when stencil testing passes and depth testing fails. Default value: Diligent::STENCIL_OP_KEEP.

StencilFailOp

STENCIL_OP Diligent::StencilOpDesc::StencilFailOp = STENCIL_OP_KEEP

The stencil operation to perform when stencil testing fails. Default value: Diligent::STENCIL_OP_KEEP.

StencilFunc

COMPARISON_FUNCTION Diligent::StencilOpDesc::StencilFunc = COMPARISON_FUNC_ALWAYS

A function that compares stencil data against existing stencil data. Default value: Diligent::COMPARISON_FUNC_ALWAYS. See Diligent::COMPARISON_FUNCTION.

StencilPassOp

STENCIL_OP Diligent::StencilOpDesc::StencilPassOp = STENCIL_OP_KEEP

The stencil operation to perform when stencil testing and depth testing both pass. Default value: Diligent::STENCIL_OP_KEEP.