love.graphics.getStencilTest

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

Gets the current stencil test configuration.

When stencil testing is enabled, the geometry of everything that is drawn afterward will be clipped / stencilled out based on a comparison between the arguments of this function and the stencil value of each pixel that the geometry touches. The stencil values of pixels are affected via love.graphics.stencil.

Each Canvas has its own per-pixel stencil values.

Function

Synopsis

comparemode, comparevalue = love.graphics.getStencilTest( )

Arguments

None.

Returns

CompareMode comparemode

The type of comparison that is made for each pixel. Will be "always" if stencil testing is disabled.

number comparevalue

The value used when comparing with the stencil value of each pixel.

See Also

• love.graphics
• love.graphics.setStencilTest
• love.graphics.stencil