StencilFunc
Keywords: StencilFunc, NVIDIA, NVIDIA Cg Toolkit, Cg Toolkit, Shader, Shader Programming, GPU Shader Programming, GPU Program

> ## Name

> StencilFunc - 3D API stencil func

> ## Usage

> StencilFunc = int(func) StencilFunc = int3(func, ref, mask)

> ## Valid Enumerants

> func: Never, Less, LEqual, LessEqual, Equal, Greater, NotEqual, GEqual, GreaterEqual, Always ref: integer value mask: integer value

> ## Description

> Specify the stencil test function. See the OpenGL glStencilFunc manual page for details. See the D3DRS_STENCILFUNC render state description for DirectX 9.

> The standard reset callback sets the StencilFunc state to int(Always) or int3(Always, 0, 0xFFFFFFFF).

> ## Opengl Functionality Requirements

> OpenGL 1.0

> ## Direct3D Functionality Requirements

> DirectX 9

> ## See Also

> ClearStencil, StencilEnable, StencilFail, StencilFuncSeparate, StencilMask, StencilMaskSeparate, StencilOp, StencilOpSeparate, StencilPass, StencilRef, StencilTestEnable, StencilTestTwoSideEnable, StencilWriteMask, StencilZFail, TwoSidedStencilMode