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

Syntax

class StencilTest

Description

Class for setting the stencil test.

Member Variables

isEnable bool Sets enable/disable for the stencil test. Always passes if disabled. Initial value is false (disabled).
maskOp bit8 Mask setting for the stencil buffer. The type is bit8. The initial value is 0xff. Equivalent to glStencilMask( mask ).
func PicaDataStencilTest Sets the comparison function to use in the stencil test. The type is PicaDataStencilTest. The initial value is PICA_DATA_STENCIL_TEST_ALWAYS. Corresponds to the ref argument of a call to glStencilFunc(func, ref, mask).
ref bit32 Sets the reference value to use in the stencil test. The type is bit32. The initial value is 0.
mask bit32 Sets the mask value to use in the stencil test. The type is bit32. The initial value is 0xff. Corresponds to the mask argument of a call to glStencilFunc(func, ref, mask).
opFail PicaDataStencilOp Sets stencil buffer value operations to be applied when the stencil test fails. The type is PicaDataStencilOp. The initial value is PICA_DATA_STENCIL_OP_KEEP. Corresponds to the func argument of a call to glStencilFunc(func, ref, mask).
opZFail PicaDataStencilOp Sets stencil buffer value operations to be applied when the stencil test passes, but the depth test fails. The type is PicaDataStencilOp. The initial value is PICA_DATA_STENCIL_OP_KEEP.
opZPass PicaDataStencilOp Sets stencil buffer value operations to be applied when the stencil test and depth test both fail. The type is PicaDataStencilOp. The initial value is PICA_DATA_STENCIL_OP_KEEP.

Member Functions

StencilTest Initializes using initial values for stencil test settings.
MakeCommand Generates a rendering command based on information already set.
S MakeDisableCommand Generates commands to disable stencil tests.

Revision History

2010/09/15
Initial version.

CONFIDENTIAL