nn::gr::CTR::RenderState::StencilTest Class

Syntax

class StencilTest

Description

Class for setting the stencil test.

Member Variables

isEnable Sets enable/disable for the stencil test. Always passes if disabled. The initial value is false (disabled).
isEnableWrite Enables or disables writes to the stencil buffer. The type is bool. The initial value is false (disabled).
func Sets the comparison function to use in the stencil test. The type is PicaDataStencilTest. Use a PicaDataStencilTest enumerated constant from the PICA macro header. The initial value is PICA_DATA_STENCIL_TEST_ALWAYS.
ref Sets the reference value to use in the stencil test. Type is u32. The initial value is 0.
mask Sets the mask value to use in the stencil test. Type is u32. The initial value is 0xff.
opFail Sets stencil buffer value operations to be applied when the stencil test fails. The type is PicaDataStencilOp. Use a PicaDataStencilOp enumerated constant from the PICA macro header. The initial value is PICA_DATA_STENCIL_OP_KEEP.
opZFail Sets stencil buffer value operations to be applied when the stencil test passes, but the depth test fails. The type is PicaDataStencilOp. Use a PicaDataStencilOp enumerated constant from the PICA macro header. The initial value is PICA_DATA_STENCIL_OP_KEEP.
opZPass Sets stencil buffer value operations to be applied when the stencil test and depth test both fail. The type is PicaDataStencilOp. Use a PicaDataStencilOp enumerated constant from the PICA macro header. The initial value is PICA_DATA_STENCIL_OP_KEEP.

Member Functions

StencilTest Initializes using initial values for stencil test settings.
MakeCommand Generates drawing commands based on previously set information.

Revision History

2010/09/15
Initial version.

CONFIDENTIAL