Depth stencil state description. More...

#include <DepthStencilState.h>

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

Public Attributes
Bool	DepthEnable = True

Bool	DepthWriteEnable = True
	Enable or disable writes to a depth buffer. Default value: True.

COMPARISON_FUNCTION	DepthFunc = COMPARISON_FUNC_LESS

Bool	StencilEnable = False
	Enable stencil operations. Default value: False.

Uint8	StencilReadMask = 0xFF

Uint8	StencilWriteMask = 0xFF

StencilOpDesc	FrontFace
	Identify stencil operations for the front-facing triangles, see Diligent::StencilOpDesc.

StencilOpDesc	BackFace
	Identify stencil operations for the back-facing triangles, see Diligent::StencilOpDesc.

Detailed Description

Depth stencil state description.

This structure describes the depth stencil state and is part of the GraphicsPipelineDesc. The structure generally mirrors D3D11_DEPTH_STENCIL_DESC/D3D12_DEPTH_STENCIL_DESC structure.

Member Data Documentation

◆ DepthEnable

Bool Diligent::DepthStencilStateDesc::DepthEnable = True

Enable depth-stencil operations. When it is set to False, depth test always passes, depth writes are disabled, and no stencil operations are performed. Default value: True.

◆ DepthFunc

COMPARISON_FUNCTION Diligent::DepthStencilStateDesc::DepthFunc = COMPARISON_FUNC_LESS

A function that compares depth data against existing depth data. See Diligent::COMPARISON_FUNCTION for details. Default value: Diligent::COMPARISON_FUNC_LESS.

◆ StencilReadMask

Uint8 Diligent::DepthStencilStateDesc::StencilReadMask = 0xFF

Identify which bits of the depth-stencil buffer are accessed when reading stencil data. Default value: 0xFF.

◆ StencilWriteMask

Uint8 Diligent::DepthStencilStateDesc::StencilWriteMask = 0xFF

Identify which bits of the depth-stencil buffer are accessed when writing stencil data. Default value: 0xFF.