Diligent::DepthStencilStateDesc struct

Depth stencil state description.

Contents

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.

Public functions

auto operator==(const DepthStencilStateDesc& rhs) const -> bool
Tests if two structures are equivalent.

Public variables

Bool DepthEnable
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.
Bool DepthWriteEnable
Enable or disable writes to a depth buffer. Default value: True.
COMPARISON_FUNCTION DepthFunc
A function that compares depth data against existing depth data. See Diligent::COMPARISON_FUNCTION for details. Default value: Diligent::COMPARISON_FUNC_LESS.
Bool StencilEnable
Enable stencil opertaions. Default value: False.
Uint8 StencilReadMask
Identify which bits of the depth-stencil buffer are accessed when reading stencil data. Default value: 0xFF.
Uint8 StencilWriteMask
Identify which bits of the depth-stencil buffer are accessed when writing stencil data. Default value: 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.

Function documentation

bool Diligent::DepthStencilStateDesc::operator==(const DepthStencilStateDesc& rhs) const

Tests if two structures are equivalent.

Parameters
rhs in - reference to the structure to perform comparison with
Returns
  • True if all members of the two structures are equal.
  • False otherwise