Vireo  0.0
Vireo 3D Rendering Hardware Interface
StencilOp Enum Referenceenum

Detailed Description

Operations applied to a stencil buffer value based on test results.

Lua full name: vireo.StencilOp

Constants

integer KEEP
 Keep the current stencil value unchanged.
 
integer ZERO
 Set the stencil value to 0.
 
integer REPLACE
 Replace the stencil value with the stencil reference value.
 
integer INCREMENT_AND_CLAMP
 Increment the stencil value, clamped to the maximum representable value.
 
integer DECREMENT_AND_CLAMP
 Decrement the stencil value, clamped to 0.
 
integer INVERT
 Bitwise-invert all bits of the stencil value.
 
integer INCREMENT_AND_WRAP
 Increment the stencil value, wrapping to 0 on overflow.
 
integer DECREMENT_AND_WRAP
 Decrement the stencil value, wrapping to the maximum on underflow.
 

Enumerator Documentation

integer KEEP

Keep the current stencil value unchanged.

integer ZERO

Set the stencil value to 0.

integer REPLACE

Replace the stencil value with the stencil reference value.

integer INCREMENT_AND_CLAMP

Increment the stencil value, clamped to the maximum representable value.

integer DECREMENT_AND_CLAMP

Decrement the stencil value, clamped to 0.

integer INVERT

Bitwise-invert all bits of the stencil value.

integer INCREMENT_AND_WRAP

Increment the stencil value, wrapping to 0 on overflow.

integer DECREMENT_AND_WRAP

Decrement the stencil value, wrapping to the maximum on underflow.