Difference between revisions of "love.graphics.setBackgroundColor"

m (Add link to getter.)
(Updated for 11.0)
Line 1: Line 1:
 
Sets the background color.
 
Sets the background color.
 +
 +
In versions prior to [[11.0]], color component values were within the range of 0 to 255 instead of 0 to 1.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 6: Line 8:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|number|red|The red component (0-255).}}
+
{{param|number|red|The red component (0-1).}}
{{param|number|green|The green component (0-255).}}
+
{{param|number|green|The green component (0-1).}}
{{param|number|blue|The blue component (0-255).}}
+
{{param|number|blue|The blue component (0-1).}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
Line 18: Line 20:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|number|red|The red component (0-255).}}
+
{{param|number|red|The red component (0-1).}}
{{param|number|green|The green component (0-255).}}
+
{{param|number|green|The green component (0-1).}}
{{param|number|blue|The blue component (0-255).}}
+
{{param|number|blue|The blue component (0-1).}}
{{param|number|alpha|The alpha component (0-255).}}
+
{{param|number|alpha|The alpha component (0-1).}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.

Revision as of 20:15, 1 April 2018

Sets the background color.

In versions prior to 11.0, color component values were within the range of 0 to 255 instead of 0 to 1.

Function

Synopsis

love.graphics.setBackgroundColor( red, green, blue )

Arguments

number red
The red component (0-1).
number green
The green component (0-1).
number blue
The blue component (0-1).

Returns

Nothing.

Function

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

Synopsis

love.graphics.setBackgroundColor( red, green, blue, alpha )

Arguments

number red
The red component (0-1).
number green
The green component (0-1).
number blue
The blue component (0-1).
number alpha
The alpha component (0-1).

Returns

Nothing.

Function

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

Synopsis

love.graphics.setBackgroundColor( rgb )

Arguments

table rgb
A numerical indexed table with the red, green and blue values as numbers.

Returns

Nothing.

Function

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

Synopsis

love.graphics.setBackgroundColor( rgba )

Arguments

table rgba
A numerical indexed table with the red, green, blue and alpha values as numbers.

Returns

Nothing.

See Also


Other Languages