SPARK  0.1.0
A general purpose game engine written in C++.
Loading...
Searching...
No Matches
spark::render::DepthStencilState Class Referencefinal

Stores the depth/stencil state of a see IRasterizer. More...

#include <DepthStencilState.h>

Classes

struct  DepthBias
 Describes the rasterizer depth bias. More...
 
struct  DepthState
 Describes the depth test state. More...
 
struct  Impl
 
struct  StencilState
 Describes the rasterizer stencil state. More...
 
struct  StencilTest
 Describes a stencil test for either front or back faces. More...
 

Public Member Functions

 DepthStencilState () noexcept
 Initializes a new rasterizer depth/stencil empty state.
 
 DepthStencilState (const DepthState &depth_state, const DepthBias &depth_bias, const StencilState &stencil_state) noexcept
 Initializes a new rasterizer depth/stencil state.
 
 DepthStencilState (const DepthStencilState &other)
 
 DepthStencilState (DepthStencilState &&other) noexcept
 
DepthStencilStateoperator= (const DepthStencilState &other)
 
DepthStencilStateoperator= (DepthStencilState &&other) noexcept
 
DepthStatedepthState () const noexcept
 Gets the depth state of the rasterizer.
 
DepthBiasdepthBias () const noexcept
 Gets the depth bias of the rasterizer.
 
StencilStatestencilState () const noexcept
 Gets the stencil state of the rasterizer.
 

Detailed Description

Stores the depth/stencil state of a see IRasterizer.

Constructor & Destructor Documentation

◆ DepthStencilState()

spark::render::DepthStencilState::DepthStencilState ( const DepthState & depth_state,
const DepthBias & depth_bias,
const StencilState & stencil_state )
explicitnoexcept

Initializes a new rasterizer depth/stencil state.

Parameters
depth_stateThe depth state of the rasterizer.
depth_biasThe depth bias of the rasterizer.
stencil_stateThe stencil state of the rasterizer.

Member Function Documentation

◆ depthBias()

DepthStencilState::DepthBias & spark::render::DepthStencilState::depthBias ( ) const
nodiscardnoexcept

Gets the depth bias of the rasterizer.

Returns
The DepthBias of the rasterizer.

◆ depthState()

DepthStencilState::DepthState & spark::render::DepthStencilState::depthState ( ) const
nodiscardnoexcept

Gets the depth state of the rasterizer.

Returns
The DepthState of the rasterizer.

◆ stencilState()

DepthStencilState::StencilState & spark::render::DepthStencilState::stencilState ( ) const
nodiscardnoexcept

Gets the stencil state of the rasterizer.

Returns
The StencilState of the rasterizer.