Home -> IStateGroupNode -> SetStencilTestEnabled

Description

The SetStencilTestEnabled method specifies whether stencil testing will be active, and configures some settings related to stencil testing.

Usage

void SetStencilTestEnabled(bool state, uint32_t compareMask = std::numeric_limits<uint32_t>::max(), uint32_t writeMask = std::numeric_limits<uint32_t>::max());

Argument list

state [bool]
True to enable stencil testing, false to disable stencil testing.
compareMask [uint32_t]
The bit mask applied to both the stencil reference value and stored stencil value before comparison.
writeMask [uint32_t]
The bit mask that controls which stencil bits may be updated by stencil operations.

See also