love.graphics.setStencilMode

Available since LÖVE 12.0
This function replaces love.graphics.stencil and love.graphics.setStencilTest.

Configures or disables using the screen's per-pixel stencil buffer.


Function

Synopsis

love.graphics.setStencilMode( action, comparemode, value, readmask, writemask )

Arguments

StencilAction action
Whether and how to modify any stencil values of pixels that are touched by subsequent draws.
CompareMode comparemode
The type of comparison (if any) to make for each pixel.
number value (0)
The value to use when comparing with the stencil value of each pixel, and the new stencil value to use for pixels if the "replace" stencil action is used. Must be an integer between 0 and 255.
number readmask (255)
An 8 bit mask applied to values read from the stencil buffer in subsequent draws.
number writemask (255)
An 8 bit mask applied to values written to the stencil buffer in subsequent draws.

Returns

Nothing.

Function

Disables writing to the stencil buffer and using its values, for subsequent draws.

Synopsis

love.graphics.setStencilMode( )

Arguments

None.

Returns

Nothing.

See Also

Other Languages