Struct DepthStencilState

Struct Documentation

struct DepthStencilState

API agnostic struct to represent depth/stencil state.

Public Members

bool depthEnable = {false}

Depth testing is enabled.

api_types::DepthWriteMask depthWriteMask = {api_types::GPA_DEPTH_WRITE_MASK_ZERO}

Identifies a portion of the depth-stencil buffer that can be modified by depth data.

api_types::ComparisonFunc depthFunc = {api_types::GPA_COMPARISON_NEVER}

A function that compares depth data against existing depth data.

bool stencilEnable = {false}

Stencil testing is enabled.

uint8_t stencilReadMask = {0}

Identifies a portion of the depth-stencil buffer for reading stencil data.

uint8_t stencilWriteMask = {0}

Identifies a portion of the depth-stencil buffer for writing stencil data.

api_types::DepthStencilOp frontFace = {}

Identifies how to use the results of the depth test and the stencil test for pixels whose surface normal is facing towards the camera.

api_types::DepthStencilOp backFace = {}

Identify how to use the results of the depth test and the stencil test for pixels whose surface normal is facing away from the camera.

uint32_t stencilRefValue

the stencil reference value used in the depth-stencil test