Vireo  0.0
Vireo 3D Rendering Hardware Interface
StencilOpState Struct Reference

Detailed Description

Per-face stencil test and write operations.

Lua full name: vireo.StencilOpState

Properties

StencilOp fail_op
 Operation applied when the stencil test fails.
 
StencilOp pass_op
 Operation applied when both the stencil and depth tests pass.
 
StencilOp depth_fail_op
 Operation applied when the stencil test passes but the depth test fails.
 
CompareOp compare_op
 Comparison function used for the stencil test.
 
integer compare_mask
 Bitmask applied to both the reference and stored stencil values before comparison.
 
integer write_mask
 Bitmask controlling which stencil bits are written on a passing test.
 

Property Documentation

StencilOp fail_op

Operation applied when the stencil test fails.

StencilOp pass_op

Operation applied when both the stencil and depth tests pass.

StencilOp depth_fail_op

Operation applied when the stencil test passes but the depth test fails.

CompareOp compare_op

Comparison function used for the stencil test.

integer compare_mask

Bitmask applied to both the reference and stored stencil values before comparison.

integer write_mask

Bitmask controlling which stencil bits are written on a passing test.