Difference between revisions of "love.graphics.clear"

m (Arguments)
m (Function)
Line 37: Line 37:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
love.graphics.clear( c1, c2, ... )
+
love.graphics.clear( color, ... )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|table|c1|A table in the form of <code>{r, g, b, a}</code> containing the color to clear the first active Canvas to.}}
+
{{param|table|color|A table in the form of <code>{r, g, b, a}</code> containing the color to clear the first active Canvas to.}}
{{param|table|c2|A table in the form of <code>{r, g, b, a}</code> containing the color to clear the second active Canvas to.}}
 
 
{{param|table|...|Additional tables for each active Canvas.}}
 
{{param|table|...|Additional tables for each active Canvas.}}
 
=== Returns ===
 
=== Returns ===

Revision as of 05:38, 19 December 2015

Clears the screen to the background color in LÖVE 0.9.2 and earlier, or to the specified color in 0.10.0 and newer.

This function is called automatically before love.draw in the default love.run function. See the example in love.run for a typical use of this function.

Note that the scissor area bounds the cleared region.

Function

Clears the screen to the background color in 0.9.2 and earlier, or to transparent black (0, 0, 0, 0) in LÖVE 0.10.0 and newer.

Synopsis

love.graphics.clear( )

Arguments

None.

Returns

Nothing.

Function

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

Clears the screen or active Canvas to the specified color.

Synopsis

love.graphics.clear( r, g, b, a )

Arguments

number r
The red channel of the color to clear the screen to.
number g
The green channel of the color to clear the screen to.
number b
The blue channel of the color to clear the screen to.
number a (255)
The alpha channel of the color to clear the screen to.

Returns

Nothing.

Function

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

Clears multiple active Canvases to different colors, if multiple Canvases are active at once via love.graphics.setCanvas.

Synopsis

love.graphics.clear( color, ... )

Arguments

table color
A table in the form of {r, g, b, a} containing the color to clear the first active Canvas to.
table ...
Additional tables for each active Canvas.

Returns

Nothing.

Notes

A color must be specified for each active Canvas, when this function variant is used.

See Also


Other Languages