Difference between revisions of "love.graphics.getBackgroundColor"

m (1 revision: Importing from potato (again).)
(Updated for 11.0)
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 +
Gets the current background color.
  
Gets the current 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 ===
 
<source lang="lua">
 
<source lang="lua">
r, g, b = love.graphics.getBackgroundColor( )
+
r, g, b, a = love.graphics.getBackgroundColor( )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{param|number|r|The red component (0-255).}}
+
{{param|number|r|The red component (0-1).}}
{{param|number|g|The green component (0-255).}}
+
{{param|number|g|The green component (0-1).}}
{{param|number|b|The blue component (0-255).}}
+
{{param|number|b|The blue component (0-1).}}
 +
{{param|number|a|The alpha component (0-1).}}
 
== See Also ==
 
== See Also ==
 
* [[parent::love.graphics]]
 
* [[parent::love.graphics]]
 +
* [[love.graphics.setBackgroundColor]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Gets the current background color.}}
 
{{#set:Description=Gets the current background color.}}
 +
{{#set:Since=000}}
 +
{{#set:Sub-Category=State}}
 +
== Other Languages ==
 +
{{i18n|love.graphics.getBackgroundColor}}

Latest revision as of 20:16, 1 April 2018

Gets the current 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

r, g, b, a = love.graphics.getBackgroundColor( )

Arguments

None.

Returns

number r
The red component (0-1).
number g
The green component (0-1).
number b
The blue component (0-1).
number a
The alpha component (0-1).

See Also


Other Languages