depthStencilStateType Enumeration

The depth and stencil state type.
Members
 
  Member name Description
DepthMaskFalse_DepthTestEqual Depth write mask: false, depth test: Equal, stencil test: off
DepthMaskFalse_DepthTestGreater Depth write mask: false, depth test: Greater, stencil test: off
DepthMaskFalse_DepthTestLess Depth write mask: false, depth test: Less, stencil test: off
DepthMaskFalse_DepthTestLessEqual Depth write mask: false, depth test: LessEqual, stencil test: off
DepthTestAlways Depth write mask: true, depth test: Always, stencil test: off
DepthTestEqual Depth write mask: true, depth test: Equal, stencil test: off
DepthTestEqual_StencilOn_Func_Equal_1_1_Op_Keep_Keep_Keep Depth write mask: true, depth test: Equal, stencil test: on, stencil test function: Equal, stencil test reference value: 1, stencil test mask: 1, stencil test fail operation: Keep, stencil test operation when depth test fails: Keep, stencil test operation when stencil test and depth test pass: Keep
DepthTestLess Depth write mask: true, depth test: Less, stencil test: off
DepthTestLessEqual Depth write mask: true, depth test: LessEqual, stencil test: off
DepthTestLessEqual_StencilOn_Func_Equal_1_1_Op_Keep_Keep_Keep Depth write mask: true, depth test: LessEqual, stencil test: on, stencil test function: Equal, stencil test reference value: 1, stencil test mask: 1, stencil test fail operation: Keep, stencil test operation when depth test fails: Keep, stencil test operation when stencil test and depth test pass: Keep
DepthTestLess_StencilOn_Func_Always_1_1_Op_Replace_Replace_Replace Depth write mask: true, depth test: Less, stencil test: on, stencil test function: Always, stencil test reference value: 1, stencil test mask: 1, stencil test fail operation: Replace, stencil test operation when depth test fails: Replace, stencil test operation when stencil test and depth test pass: Replace
DepthTestLess_StencilOn_Func_Equal_1_1_Op_Keep_Keep_Keep Depth write mask: true, depth test: Less, stencil test: on, stencil test function: Equal, stencil test reference value: 1, stencil test mask: 1, stencil test fail operation: Keep, stencil test operation when depth test fails: Keep, stencil test operation when stencil test and depth test pass: Keep
DepthTestLess_StencilOn_Func_Never_1_FF_Op_Invert_Keep_Keep Depth write mask: true, depth test: Less, stencil test: on, stencil test function: Never, stencil test reference value: 1, stencil test mask: FF, stencil test fail operation: Invert, stencil test operation when depth test fails: Keep, stencil test operation when stencil test and depth test pass: Keep
DepthTestOff Depth write mask: false, depth test: off, stencil test: off
DepthTestOff_StencilOn_Func_Always_0_0_Op_Keep_Keep_Decrement
DepthTestOff_StencilOn_Func_Always_0_0_Op_Keep_Keep_Increment
DepthTestOff_StencilOn_Func_Always_1_1_Op_Replace_Replace_Replace Depth write mask: off, depth test: off, stencil test: on, stencil test function: Always, stencil test reference value: 1, stencil test mask: 1, stencil test fail operation: Replace, stencil test operation when depth test fails: Replace, stencil test operation when stencil test and depth test pass: Replace
DepthTestOff_StencilOn_Func_Equal_1_1_Op_Keep_Keep_Keep Depth write mask: false, depth test: off, stencil test: on, stencil test function: Equal, stencil test reference value: 1, stencil test mask: 1, stencil test fail operation: Keep, stencil test operation when depth test fails: Keep, stencil test operation when stencil test and depth test pass: Keep
DepthTestOff_StencilOn_Func_Never_1_FF_Op_Invert_Keep_Keep Depth write mask: false, depth test: off, stencil test: on, stencil test function: Never, stencil test reference value: 1, stencil test mask: FF, stencil test fail operation: Invert, stencil test operation when depth test fails: Keep, stencil test operation when stencil test and depth test pass: Keep
DepthTestOff_StencilOn_Func_Never_1_FF_Op_Zero_Keep_Keep Depth write mask: false, depth test: off, stencil test: on, stencil test function: Never, stencil test reference value: 1, stencil test mask: FF, stencil test fail operation: Zero, stencil test operation when depth test fails: Keep, stencil test operation when stencil test and depth test pass: Keep
DepthTestOff_StencilOn_Func_NotEqual_1_FF_Op_Keep_keep_keep Depth write mask: off, Depth test: off, Stencil test: on, stencil test function: NotEqual, stencil test reference value: 1, stencil test mask: FF, stencil test fail operation: Keep, stencil test operation when depth test fails: Keep, stencil test operation when stencil test and depth test pass: Keep
DepthTestOn_StencilOn_Func_NotEqual_0_0xFF
Remarks
 
The identifiers are self explanatory and determine: The depth test status and depth function (see the glDepthFunc() documentation), The stencil status, function, reference value and mask (see the glStencilFunc() documentation), The action to take when the stencil test fails, the depth test fails or both test pass (see the glStencilOp() documentation).

In this article

Definition