Difference between revisions of "SpriteBatch:getColor"

(Created page)
 
(Updated for 11.0)
 
Line 4: Line 4:
 
If no color has been set with [[SpriteBatch:setColor]] or the current SpriteBatch color has been cleared, this method will return nil.
 
If no color has been set with [[SpriteBatch:setColor]] or the current SpriteBatch color has been cleared, this method will return nil.
  
 +
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 12: Line 13:
 
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-255).}}
+
{{param|number|a|The alpha component (0-1).}}
 
== See Also ==
 
== See Also ==
 
* [[parent::SpriteBatch]]
 
* [[parent::SpriteBatch]]

Latest revision as of 20:18, 1 April 2018

Available since LÖVE 0.9.0
This method is not supported in earlier versions.

Gets the color that will be used for the next add and set operations.

If no color has been set with SpriteBatch:setColor or the current SpriteBatch color has been cleared, this method will return nil.

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 = SpriteBatch:getColor( )

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