Ritchie's Abstractions 0.2
Platform abstractions that make Toolbox work
Loading...
Searching...
No Matches
DepthStencilState Struct Reference

A structure defining how a GPU should perform depth testing and stencil testing. More...

Public Attributes

bool DepthTestEnabled
 Value indicating whether depth testing is enabled.
 
bool DepthWriteEnabled
 Value indicating whether the GPU should write depth information to the depth buffer.
 
DepthStencilFunction DepthFunction
 A DepthStencilFunction value indicating how the depth test should be performed.
 
bool StencilTestEnabled
 Value indicating whether to write to the stencil buffer.
 
byte StencilMask
 Value indicating the stencil buffer mask.
 
DepthStencilFunction StencilFunction
 A DepthStencilFunction value indicating how stencil testing should be performed.
 
int StencilReference
 ?????
 
StencilOperation StencilPassOperation
 A StencilOperation value indicating what to do if the stencil test passes.
 
StencilOperation DepthStencilPassOperation
 A StencilOperation value indicating what to do if both the depth and stencil tests pass.
 
StencilOperation StencilPassDepthFailOperation
 A StencilOperation indicating what to do if the stencil test passes but the depth test fails.
 

Static Public Attributes

static readonly DepthStencilState Default
 A DepthStencilState value representing default depth and stencil test settings.
 

Detailed Description

A structure defining how a GPU should perform depth testing and stencil testing.

Member Data Documentation

◆ Default

readonly DepthStencilState Default
static
Initial value:
= new()
{
}
DepthStencilFunction
Enum defining different kinds of depth/stencil buffer tests.
Definition DepthStencilFunction.cs:7
bool StencilTestEnabled
Value indicating whether to write to the stencil buffer.
Definition DepthStencilState.cs:26
DepthStencilFunction DepthFunction
A DepthStencilFunction value indicating how the depth test should be performed.
Definition DepthStencilState.cs:21
bool DepthWriteEnabled
Value indicating whether the GPU should write depth information to the depth buffer.
Definition DepthStencilState.cs:16
bool DepthTestEnabled
Value indicating whether depth testing is enabled.
Definition DepthStencilState.cs:11

A DepthStencilState value representing default depth and stencil test settings.


The documentation for this struct was generated from the following file: