LiteFX 0.3.1.2022
Computer Graphics Engine
LiteFX::Rendering::DepthStencilState::StencilState Struct Reference

Describes the rasterizer stencil state. More...

#include <rendering_api.hpp>

Public Attributes

bool Enable { false }
 Specifies, if stencil state should be used (default: false). More...
 
Byte WriteMask { 0xFF }
 Specifies the bits to write to the stencil state (default: 0xFF). More...
 
Byte ReadMask { 0xFF }
 Specifies the bits to read from the stencil state (default: 0xFF). More...
 
StencilTest FrontFace {}
 Describes the stencil test for faces that point towards the camera. More...
 
StencilTest BackFace {}
 Describes the stencil test for faces that point away from the camera. More...
 

Detailed Description

Describes the rasterizer stencil state.

Member Data Documentation

◆ BackFace

StencilTest LiteFX::Rendering::DepthStencilState::StencilState::BackFace {}

Describes the stencil test for faces that point away from the camera.

◆ Enable

bool LiteFX::Rendering::DepthStencilState::StencilState::Enable { false }

Specifies, if stencil state should be used (default: false).

◆ FrontFace

StencilTest LiteFX::Rendering::DepthStencilState::StencilState::FrontFace {}

Describes the stencil test for faces that point towards the camera.

◆ ReadMask

Byte LiteFX::Rendering::DepthStencilState::StencilState::ReadMask { 0xFF }

Specifies the bits to read from the stencil state (default: 0xFF).

◆ WriteMask

Byte LiteFX::Rendering::DepthStencilState::StencilState::WriteMask { 0xFF }

Specifies the bits to write to the stencil state (default: 0xFF).