love.graphics.getStencilTest

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

Gets whether stencil testing is enabled.

When stencil testing is enabled, the geometry of everything that is drawn will be clipped / stencilled out based on whether it intersects with what has been previously drawn to the stencil buffer.

Each Canvas has its own stencil buffer.

Function

Synopsis

enabled, inverted = love.graphics.getStencilTest( )

Arguments

None.

boolean enable (false)
Whether to enable stencil testing.
boolean invert (false)
Whether to invert the stencil test. If true, the parts of drawn geometry that touch what has been previously drawn to the stencil buffer will be clipped. Otherwise everything else will be clipped.

Returns

boolean enable
Whether stencil testing is enabled.
boolean inverted
Whether the stencil test is inverted or not.

Nothing.

See Also


Other Languages