love.graphics.getStencilState

Available since LÖVE 12.0
This function is not supported in earlier versions.

Gets the current low level stencil state.

For simpler APIs see love.graphics.setStencilMode and love.graphics.getStencilMode.

Function

Synopsis

action, comparemode, value, readmask, writemask = love.graphics.getStencilState( )

Arguments

None.

Returns

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) being made for each pixel.
number value
The value used 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. Will be an integer between 0 and 255.
number readmask
An 8 bit mask applied to values read from the stencil buffer in subsequent draws.
number writemask
An 8 bit mask applied to values written to the stencil buffer in subsequent draws.

See Also


Other Languages