ngf_depth_stencil_info Struct Reference

Data Fields
ngf_stencil_info	front_stencil
ngf_stencil_info	back_stencil
ngf_compare_op	depth_compare
bool	stencil_test
bool	depth_test
bool	depth_write

Detailed Description

A graphics pipeline's depth/stencil state description.

Field Documentation

back_stencil

ngf_stencil_info ngf_depth_stencil_info::back_stencil

Stencil test and actions for back-facing polys. This is ignored when stencil testing is disabled.

depth_compare

ngf_compare_op ngf_depth_stencil_info::depth_compare

The comparison function to use when performing the depth test. This is ignored when depth testing is disabled.

depth_test

bool ngf_depth_stencil_info::depth_test

Whether to enable depth test. When this is enabled, fragments that fail the test specified in ngf_depth_stencil_info::depth_compare, get discarded.

depth_write

bool ngf_depth_stencil_info::depth_write

Whether to enable writing to the depth buffer. When this is enabled, fragments that pass the depth test have their depth written into the depth buffer.

front_stencil

ngf_stencil_info ngf_depth_stencil_info::front_stencil

Stencil test and actions for front-facing polys. This is ignored when stencil testing is disabled.

stencil_test

bool ngf_depth_stencil_info::stencil_test

Whether to enable stencil testing. The exact procedure for the stencil test, and the actions to perform on success or failure can be specified separately for front- and back-facing polygons (see ngf_depth_stencil_info::front_stencil and ngf_depth_stencil_info::back_stencil).