2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-02-14 14:18:53 +01:00
<class name= "Color" version= "4.0" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 22:42:36 +02:00
<brief_description >
2020-07-21 20:07:00 +02:00
Color in RGBA format using floats on the range of 0 to 1.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2021-12-24 09:45:09 +01:00
A color represented by red, green, blue, and alpha (RGBA) components. The alpha component is often used for opacity. Values are in floating-point and usually range from 0 to 1. Some properties (such as CanvasItem.modulate) may accept values greater than 1 (overbright or HDR colors).
2020-12-06 23:37:34 +01:00
You can also create a color from standardized color names by using the string constructor or directly using the color constants defined here. The standardized color set is based on the [url=https://en.wikipedia.org/wiki/X11_color_names]X11 color names[/url].
2020-04-04 21:31:34 +02:00
If you want to supply values in a range of 0 to 255, you should use [method @GDScript.Color8].
2020-06-21 17:16:10 +02:00
[b]Note:[/b] In a boolean context, a Color will evaluate to [code]false[/code] if it's equal to [code]Color(0, 0, 0, 1)[/code] (opaque black). Otherwise, a Color will always evaluate to [code]true[/code].
2020-09-23 23:48:37 +02:00
[url=https://raw.githubusercontent.com/godotengine/godot-docs/master/img/color_constants.png]Color constants cheatsheet[/url]
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2020-10-01 10:34:47 +02:00
<link title= "2D GD Paint Demo" > https://godotengine.org/asset-library/asset/517</link>
<link title= "Tween Demo" > https://godotengine.org/asset-library/asset/146</link>
<link title= "GUI Drag And Drop Demo" > https://godotengine.org/asset-library/asset/133</link>
2017-09-12 22:42:36 +02:00
</tutorials>
2021-09-21 04:49:02 +02:00
<constructors >
<constructor name= "Color" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
2017-09-12 22:42:36 +02:00
<description >
2020-11-09 17:46:03 +01:00
Constructs a default-initialized [Color] with all components set to [code]0[/code].
2017-09-12 22:42:36 +02:00
</description>
2021-09-21 04:49:02 +02:00
</constructor>
<constructor name= "Color" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "from" type= "Color" />
<argument index= "1" name= "alpha" type= "float" />
2019-07-19 02:15:39 +02:00
<description >
2020-11-09 17:46:03 +01:00
Constructs a [Color] from an existing color, but with a custom alpha value.
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
2021-12-24 09:45:09 +01:00
var red = Color(Color.red, 0.2) # 20% opaque red.
2020-09-12 17:06:13 +02:00
[/gdscript]
[csharp]
2021-12-24 09:45:09 +01:00
var red = new Color(Colors.Red, 0.2f); // 20% opaque red.
2020-09-12 17:06:13 +02:00
[/csharp]
[/codeblocks]
2019-07-19 02:15:39 +02:00
</description>
2021-09-21 04:49:02 +02:00
</constructor>
<constructor name= "Color" >
<return type= "Color" />
<argument index= "0" name= "from" type= "Color" />
<description >
Constructs a [Color] as a copy of the given [Color].
</description>
</constructor>
<constructor name= "Color" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "code" type= "String" />
2020-12-06 23:37:34 +01:00
<description >
2021-03-18 14:44:42 +01:00
Constructs a [Color] either from an HTML color code or from a standardized color name. Supported color names are the same as the constants.
2020-12-06 23:37:34 +01:00
</description>
2021-09-21 04:49:02 +02:00
</constructor>
<constructor name= "Color" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "code" type= "String" />
<argument index= "1" name= "alpha" type= "float" />
2020-12-06 23:37:34 +01:00
<description >
2021-03-18 14:44:42 +01:00
Constructs a [Color] either from an HTML color code or from a standardized color name, with [code]alpha[/code] on the range of 0 to 1. Supported color names are the same as the constants.
2020-12-06 23:37:34 +01:00
</description>
2021-09-21 04:49:02 +02:00
</constructor>
<constructor name= "Color" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "r" type= "float" />
<argument index= "1" name= "g" type= "float" />
<argument index= "2" name= "b" type= "float" />
2017-09-12 22:42:36 +02:00
<description >
2021-09-21 04:49:02 +02:00
Constructs a [Color] from RGB values, typically between 0 and 1. Alpha will be 1.
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
2021-09-21 04:49:02 +02:00
var color = Color(0.2, 1.0, 0.7) # Similar to `Color8(51, 255, 178, 255)`
2020-09-12 17:06:13 +02:00
[/gdscript]
[csharp]
2021-09-21 04:49:02 +02:00
var color = new Color(0.2f, 1.0f, 0.7f); // Similar to `Color.Color8(51, 255, 178, 255)`
2020-09-12 17:06:13 +02:00
[/csharp]
[/codeblocks]
2017-09-12 22:42:36 +02:00
</description>
2021-09-21 04:49:02 +02:00
</constructor>
<constructor name= "Color" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "r" type= "float" />
<argument index= "1" name= "g" type= "float" />
<argument index= "2" name= "b" type= "float" />
2021-09-21 04:49:02 +02:00
<argument index= "3" name= "a" type= "float" />
2017-09-12 22:42:36 +02:00
<description >
2021-09-21 04:49:02 +02:00
Constructs a [Color] from RGBA values, typically between 0 and 1.
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
2021-09-21 04:49:02 +02:00
var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to `Color8(51, 255, 178, 204)`
2020-09-12 17:06:13 +02:00
[/gdscript]
[csharp]
2021-09-21 04:49:02 +02:00
var color = new Color(0.2f, 1.0f, 0.7f, 0.8f); // Similar to `Color.Color8(51, 255, 178, 255, 204)`
2020-09-12 17:06:13 +02:00
[/csharp]
[/codeblocks]
2017-09-12 22:42:36 +02:00
</description>
2021-09-21 04:49:02 +02:00
</constructor>
</constructors>
<methods >
2021-03-18 14:44:42 +01:00
<method name= "blend" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "over" type= "Color" />
2017-09-12 22:42:36 +02:00
<description >
2018-10-03 00:47:10 +02:00
Returns a new color resulting from blending this color over another. If the color is opaque, the result is also opaque. The second color may have a range of alpha values.
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
2017-09-12 22:42:36 +02:00
var bg = Color(0.0, 1.0, 0.0, 0.5) # Green with alpha of 50%
2018-12-14 09:37:19 +01:00
var fg = Color(1.0, 0.0, 0.0, 0.5) # Red with alpha of 50%
var blended_color = bg.blend(fg) # Brown with alpha of 75%
2020-09-12 17:06:13 +02:00
[/gdscript]
[csharp]
var bg = new Color(0.0f, 1.0f, 0.0f, 0.5f); // Green with alpha of 50%
var fg = new Color(1.0f, 0.0f, 0.0f, 0.5f); // Red with alpha of 50%
Color blendedColor = bg.Blend(fg); // Brown with alpha of 75%
[/csharp]
[/codeblocks]
2017-09-12 22:42:36 +02:00
</description>
</method>
2021-02-01 06:10:52 +01:00
<method name= "clamp" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "min" type= "Color" default= "Color(0, 0, 0, 0)" />
<argument index= "1" name= "max" type= "Color" default= "Color(1, 1, 1, 1)" />
2021-02-01 06:10:52 +01:00
<description >
Returns a new color with all components clamped between the components of [code]min[/code] and [code]max[/code], by running [method @GlobalScope.clamp] on each component.
</description>
</method>
2021-03-18 14:44:42 +01:00
<method name= "darkened" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "amount" type= "float" />
2017-11-24 09:16:27 +01:00
<description >
2018-12-14 09:37:19 +01:00
Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1).
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
2017-11-24 09:16:27 +01:00
var green = Color(0.0, 1.0, 0.0)
var darkgreen = green.darkened(0.2) # 20% darker than regular green
2020-09-12 17:06:13 +02:00
[/gdscript]
[csharp]
var green = new Color(0.0f, 1.0f, 0.0f);
Color darkgreen = green.Darkened(0.2f); // 20% darker than regular green
[/csharp]
[/codeblocks]
2017-11-24 09:16:27 +01:00
</description>
</method>
2021-03-18 14:44:42 +01:00
<method name= "find_named_color" qualifiers= "static" >
2021-07-30 15:28:05 +02:00
<return type= "int" />
<argument index= "0" name= "name" type= "String" />
2021-03-18 14:44:42 +01:00
<description >
</description>
</method>
2021-11-11 09:01:39 +01:00
<method name= "from_hsv" qualifiers= "static" >
<return type= "Color" />
<argument index= "0" name= "h" type= "float" />
<argument index= "1" name= "s" type= "float" />
<argument index= "2" name= "v" type= "float" />
<argument index= "3" name= "alpha" type= "float" default= "1.0" />
<description >
Constructs a color from an [url=https://en.wikipedia.org/wiki/HSL_and_HSV]HSV profile[/url]. [code]h[/code] (hue), [code]s[/code] (saturation), and [code]v[/code] (value) are typically between 0 and 1.
[codeblocks]
[gdscript]
var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8)
[/gdscript]
[csharp]
var c = Color.FromHsv(0.58f, 0.5f, 0.79f, 0.8f);
[/csharp]
[/codeblocks]
</description>
</method>
2021-03-18 14:44:42 +01:00
<method name= "from_rgbe9995" qualifiers= "static" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "rgbe" type= "int" />
2021-03-18 14:44:42 +01:00
<description >
</description>
</method>
<method name= "from_string" qualifiers= "static" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "str" type= "String" />
<argument index= "1" name= "default" type= "Color" />
2021-03-18 14:44:42 +01:00
<description >
</description>
</method>
2021-12-16 06:59:04 +01:00
<method name= "get_luminance" qualifiers= "const" >
<return type= "float" />
<description >
Returns the luminance of the color in the [code][0.0, 1.0][/code] range.
This is useful when determining light or dark color. Colors with a luminance smaller than 0.5 can be generally considered dark.
</description>
</method>
2021-03-18 14:44:42 +01:00
<method name= "get_named_color" qualifiers= "static" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "idx" type= "int" />
2021-03-18 14:44:42 +01:00
<description >
</description>
</method>
<method name= "get_named_color_count" qualifiers= "static" >
2021-07-30 15:28:05 +02:00
<return type= "int" />
2021-03-18 14:44:42 +01:00
<description >
</description>
</method>
<method name= "get_named_color_name" qualifiers= "static" >
2021-07-30 15:28:05 +02:00
<return type= "String" />
<argument index= "0" name= "idx" type= "int" />
2021-03-18 14:44:42 +01:00
<description >
</description>
</method>
<method name= "hex" qualifiers= "static" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "hex" type= "int" />
2021-03-18 14:44:42 +01:00
<description >
</description>
</method>
<method name= "hex64" qualifiers= "static" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "hex" type= "int" />
2021-03-18 14:44:42 +01:00
<description >
</description>
</method>
<method name= "html" qualifiers= "static" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "rgba" type= "String" />
2021-03-18 14:44:42 +01:00
<description >
2022-02-08 06:13:48 +01:00
Returns a new color from [code]rgba[/code], an HTML hexadecimal color string. [code]rgba[/code] is not case sensitive, and may be prefixed with a '#' character.
[code]rgba[/code] must be a valid three-digit or six-digit hexadecimal color string, and may contain an alpha channel value. If [code]rgba[/code] does not contain an alpha channel value, an alpha channel value of 1.0 is applied.
If [code]rgba[/code] is invalid a Color(0.0, 0.0, 0.0, 1.0) is returned.
2022-02-09 05:50:50 +01:00
[b]Note:[/b] This method is not implemented in C#, but the same functionality is provided in the class constructor.
2022-02-08 06:13:48 +01:00
[codeblocks]
[gdscript]
var green = Color.html("#00FF00FF") # set green to Color(0.0, 1.0, 0.0, 1.0)
var blue = Color.html("#0000FF") # set blue to Color(0.0, 0.0, 1.0, 1.0)
[/gdscript]
[csharp]
2022-02-09 05:50:50 +01:00
var green = new Color("#00FF00FF"); // set green to Color(0.0, 1.0, 0.0, 1.0)
var blue = new Color("#0000FF"); // set blue to Color(0.0, 0.0, 1.0, 1.0)
2022-02-08 06:13:48 +01:00
[/csharp]
[/codeblocks]
2021-03-18 14:44:42 +01:00
</description>
</method>
<method name= "html_is_valid" qualifiers= "static" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
<argument index= "0" name= "color" type= "String" />
2021-03-18 14:44:42 +01:00
<description >
2022-02-08 06:13:48 +01:00
Returns [code]true[/code] if [code]color[/code] is a valid HTML hexadecimal color string. [code]color[/code] is not case sensitive, and may be prefixed with a '#' character.
For a string to be valid it must be three-digit or six-digit hexadecimal, and may contain an alpha channel value.
[codeblocks]
[gdscript]
var result = Color.html_is_valid("#55aaFF") # result is true
result = Color.html_is_valid("#55AAFF20") # result is true
result = Color.html_is_valid("55AAFF") # result is true
result = Color.html_is_valid("#F2C") # result is true
result = Color.html_is_valid("#AABBC) # result is false
result = Color.html_is_valid("#55aaFF5") # result is false
[/gdscript]
[csharp]
var result = Color.HtmlIsValid("#55AAFF"); // result is true
result = Color.HtmlIsValid("#55AAFF20"); // result is true
result = Color.HtmlIsValid("55AAFF); // result is true
result = Color.HtmlIsValid("#F2C"); // result is true
result = Color.HtmlIsValid("#AABBC"); // result is false
result = Color.HtmlIsValid("#55aaFF5"); // result is false
[/csharp]
[/codeblocks]
2021-03-18 14:44:42 +01:00
</description>
</method>
<method name= "inverted" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
2017-09-12 22:42:36 +02:00
<description >
2019-06-08 01:44:25 +02:00
Returns the inverted color [code](1 - r, 1 - g, 1 - b, a)[/code].
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
var color = Color(0.3, 0.4, 0.9)
2020-10-11 10:01:18 +02:00
var inverted_color = color.inverted() # Equivalent to `Color(0.7, 0.6, 0.1)`
2020-09-12 17:06:13 +02:00
[/gdscript]
[csharp]
var color = new Color(0.3f, 0.4f, 0.9f);
2020-10-11 10:01:18 +02:00
Color invertedColor = color.Inverted(); // Equivalent to `new Color(0.7f, 0.6f, 0.1f)`
2020-09-12 17:06:13 +02:00
[/csharp]
[/codeblocks]
2017-09-12 22:42:36 +02:00
</description>
</method>
2021-03-18 14:44:42 +01:00
<method name= "is_equal_approx" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
<argument index= "0" name= "to" type= "Color" />
2019-11-08 08:33:48 +01:00
<description >
2021-01-04 14:33:44 +01:00
Returns [code]true[/code] if this color and [code]color[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
2019-11-08 08:33:48 +01:00
</description>
</method>
2021-03-18 14:44:42 +01:00
<method name= "lerp" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "to" type= "Color" />
<argument index= "1" name= "weight" type= "float" />
2017-10-13 06:49:31 +02:00
<description >
2021-04-23 15:46:51 +02:00
Returns the linear interpolation with another color. The interpolation factor [code]weight[/code] is between 0 and 1.
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
2020-03-16 10:07:33 +01:00
var c1 = Color(1.0, 0.0, 0.0)
var c2 = Color(0.0, 1.0, 0.0)
2020-10-11 10:01:18 +02:00
var lerp_color = c1.lerp(c2, 0.5) # Equivalent to `Color(0.5, 0.5, 0.0)`
2020-09-12 17:06:13 +02:00
[/gdscript]
[csharp]
var c1 = new Color(1.0f, 0.0f, 0.0f);
var c2 = new Color(0.0f, 1.0f, 0.0f);
2020-10-11 10:01:18 +02:00
Color lerpColor = c1.Lerp(c2, 0.5f); // Equivalent to `new Color(0.5f, 0.5f, 0.0f)`
2020-09-12 17:06:13 +02:00
[/csharp]
[/codeblocks]
2017-10-13 06:49:31 +02:00
</description>
</method>
2021-03-18 14:44:42 +01:00
<method name= "lightened" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "Color" />
<argument index= "0" name= "amount" type= "float" />
2017-09-12 22:42:36 +02:00
<description >
2020-03-16 10:07:33 +01:00
Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1).
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
2020-03-16 10:07:33 +01:00
var green = Color(0.0, 1.0, 0.0)
var lightgreen = green.lightened(0.2) # 20% lighter than regular green
2020-09-12 17:06:13 +02:00
[/gdscript]
[csharp]
var green = new Color(0.0f, 1.0f, 0.0f);
Color lightgreen = green.Lightened(0.2f); // 20% lighter than regular green
[/csharp]
[/codeblocks]
2017-09-12 22:42:36 +02:00
</description>
</method>
2021-03-18 14:44:42 +01:00
<method name= "to_abgr32" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2020-10-11 10:01:18 +02:00
Returns the color converted to a 32-bit integer in ABGR format (each byte represents a color channel). ABGR is the reversed version of the default format.
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
var color = Color(1, 0.5, 0.2)
print(color.to_abgr32()) # Prints 4281565439
[/gdscript]
[csharp]
var color = new Color(1.0f, 0.5f, 0.2f);
GD.Print(color.ToAbgr32()); // Prints 4281565439
[/csharp]
[/codeblocks]
2017-09-12 22:42:36 +02:00
</description>
</method>
2021-03-18 14:44:42 +01:00
<method name= "to_abgr64" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "int" />
2018-07-25 22:33:42 +02:00
<description >
2020-10-11 10:01:18 +02:00
Returns the color converted to a 64-bit integer in ABGR format (each word represents a color channel). ABGR is the reversed version of the default format.
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
var color = Color(1, 0.5, 0.2)
print(color.to_abgr64()) # Prints -225178692812801
[/gdscript]
[csharp]
var color = new Color(1.0f, 0.5f, 0.2f);
GD.Print(color.ToAbgr64()); // Prints -225178692812801
[/csharp]
[/codeblocks]
2018-07-25 22:33:42 +02:00
</description>
</method>
2021-03-18 14:44:42 +01:00
<method name= "to_argb32" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "int" />
2018-07-25 22:33:42 +02:00
<description >
2020-10-11 10:01:18 +02:00
Returns the color converted to a 32-bit integer in ARGB format (each byte represents a color channel). ARGB is more compatible with DirectX.
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
var color = Color(1, 0.5, 0.2)
print(color.to_argb32()) # Prints 4294934323
[/gdscript]
[csharp]
var color = new Color(1.0f, 0.5f, 0.2f);
GD.Print(color.ToArgb32()); // Prints 4294934323
[/csharp]
[/codeblocks]
2018-07-25 22:33:42 +02:00
</description>
</method>
2021-03-18 14:44:42 +01:00
<method name= "to_argb64" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "int" />
2017-09-12 22:42:36 +02:00
<description >
2020-10-11 10:01:18 +02:00
Returns the color converted to a 64-bit integer in ARGB format (each word represents a color channel). ARGB is more compatible with DirectX.
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
var color = Color(1, 0.5, 0.2)
print(color.to_argb64()) # Prints -2147470541
[/gdscript]
[csharp]
var color = new Color(1.0f, 0.5f, 0.2f);
GD.Print(color.ToArgb64()); // Prints -2147470541
[/csharp]
[/codeblocks]
2018-07-25 22:33:42 +02:00
</description>
</method>
2021-03-18 14:44:42 +01:00
<method name= "to_html" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "String" />
<argument index= "0" name= "with_alpha" type= "bool" default= "true" />
2018-07-25 22:33:42 +02:00
<description >
2020-10-11 10:01:18 +02:00
Returns the color converted to an HTML hexadecimal color string in RGBA format (ex: [code]ff34f822[/code]).
2020-09-01 08:03:30 +02:00
Setting [code]with_alpha[/code] to [code]false[/code] excludes alpha from the hexadecimal string (and uses RGB instead of RGBA format).
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
var color = Color(1, 1, 1, 0.5)
var with_alpha = color.to_html() # Returns "ffffff7f"
var without_alpha = color.to_html(false) # Returns "ffffff"
[/gdscript]
[csharp]
var color = new Color(1, 1, 1, 0.5f);
String withAlpha = color.ToHtml(); // Returns "ffffff7f"
String withoutAlpha = color.ToHtml(false); // Returns "ffffff"
[/csharp]
[/codeblocks]
2018-07-25 22:33:42 +02:00
</description>
</method>
2021-03-18 14:44:42 +01:00
<method name= "to_rgba32" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "int" />
2018-07-25 22:33:42 +02:00
<description >
2020-10-11 10:01:18 +02:00
Returns the color converted to a 32-bit integer in RGBA format (each byte represents a color channel). RGBA is Godot's default format.
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
var color = Color(1, 0.5, 0.2)
print(color.to_rgba32()) # Prints 4286526463
[/gdscript]
[csharp]
var color = new Color(1, 0.5f, 0.2f);
GD.Print(color.ToRgba32()); // Prints 4286526463
[/csharp]
[/codeblocks]
2018-07-25 22:33:42 +02:00
</description>
</method>
2021-03-18 14:44:42 +01:00
<method name= "to_rgba64" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "int" />
2018-07-25 22:33:42 +02:00
<description >
2020-10-11 10:01:18 +02:00
Returns the color converted to a 64-bit integer in RGBA format (each word represents a color channel). RGBA is Godot's default format.
2020-09-12 17:06:13 +02:00
[codeblocks]
[gdscript]
var color = Color(1, 0.5, 0.2)
print(color.to_rgba64()) # Prints -140736629309441
[/gdscript]
[csharp]
var color = new Color(1, 0.5f, 0.2f);
GD.Print(color.ToRgba64()); // Prints -140736629309441
[/csharp]
[/codeblocks]
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<members >
2019-06-29 12:38:01 +02:00
<member name= "a" type= "float" setter= "" getter= "" default= "1.0" >
2021-12-24 09:45:09 +01:00
The color's alpha component, typically on the range of 0 to 1. A value of 0 means that the color is fully transparent. A value of 1 means that the color is fully opaque.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "a8" type= "int" setter= "" getter= "" default= "255" >
2020-07-21 20:07:00 +02:00
Wrapper for [member a] that uses the range 0 to 255 instead of 0 to 1.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "b" type= "float" setter= "" getter= "" default= "0.0" >
2020-07-21 20:07:00 +02:00
The color's blue component, typically on the range of 0 to 1.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "b8" type= "int" setter= "" getter= "" default= "0" >
2020-07-21 20:07:00 +02:00
Wrapper for [member b] that uses the range 0 to 255 instead of 0 to 1.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "g" type= "float" setter= "" getter= "" default= "0.0" >
2020-07-21 20:07:00 +02:00
The color's green component, typically on the range of 0 to 1.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "g8" type= "int" setter= "" getter= "" default= "0" >
2020-07-21 20:07:00 +02:00
Wrapper for [member g] that uses the range 0 to 255 instead of 0 to 1.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "h" type= "float" setter= "" getter= "" default= "0.0" >
2020-07-21 20:07:00 +02:00
The HSV hue of this color, on the range 0 to 1.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "r" type= "float" setter= "" getter= "" default= "0.0" >
2020-07-21 20:07:00 +02:00
The color's red component, typically on the range of 0 to 1.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "r8" type= "int" setter= "" getter= "" default= "0" >
2020-07-21 20:07:00 +02:00
Wrapper for [member r] that uses the range 0 to 255 instead of 0 to 1.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "s" type= "float" setter= "" getter= "" default= "0.0" >
2020-07-21 20:07:00 +02:00
The HSV saturation of this color, on the range 0 to 1.
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "v" type= "float" setter= "" getter= "" default= "0.0" >
2020-07-21 20:07:00 +02:00
The HSV value (brightness) of this color, on the range 0 to 1.
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
2019-09-24 19:45:03 +02:00
<constant name= "ALICE_BLUE" value= "Color(0.94, 0.97, 1, 1)" >
2020-01-26 12:07:59 +01:00
Alice blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "ANTIQUE_WHITE" value= "Color(0.98, 0.92, 0.84, 1)" >
2020-01-26 12:07:59 +01:00
Antique white color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "AQUA" value= "Color(0, 1, 1, 1)" >
2020-01-26 12:07:59 +01:00
Aqua color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "AQUAMARINE" value= "Color(0.5, 1, 0.83, 1)" >
2020-01-26 12:07:59 +01:00
Aquamarine color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "AZURE" value= "Color(0.94, 1, 1, 1)" >
2020-01-26 12:07:59 +01:00
Azure color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "BEIGE" value= "Color(0.96, 0.96, 0.86, 1)" >
2020-01-26 12:07:59 +01:00
Beige color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "BISQUE" value= "Color(1, 0.89, 0.77, 1)" >
2020-01-26 12:07:59 +01:00
Bisque color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "BLACK" value= "Color(0, 0, 0, 1)" >
2020-01-26 12:07:59 +01:00
Black color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "BLANCHED_ALMOND" value= "Color(1, 0.92, 0.8, 1)" >
2021-01-12 19:22:31 +01:00
Blanched almond color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "BLUE" value= "Color(0, 0, 1, 1)" >
2020-01-26 12:07:59 +01:00
Blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "BLUE_VIOLET" value= "Color(0.54, 0.17, 0.89, 1)" >
2020-01-26 12:07:59 +01:00
Blue violet color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "BROWN" value= "Color(0.65, 0.16, 0.16, 1)" >
2020-01-26 12:07:59 +01:00
Brown color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "BURLYWOOD" value= "Color(0.87, 0.72, 0.53, 1)" >
2021-01-12 19:22:31 +01:00
Burlywood color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "CADET_BLUE" value= "Color(0.37, 0.62, 0.63, 1)" >
2020-01-26 12:07:59 +01:00
Cadet blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "CHARTREUSE" value= "Color(0.5, 1, 0, 1)" >
2020-01-26 12:07:59 +01:00
Chartreuse color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "CHOCOLATE" value= "Color(0.82, 0.41, 0.12, 1)" >
2020-01-26 12:07:59 +01:00
Chocolate color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "CORAL" value= "Color(1, 0.5, 0.31, 1)" >
2020-01-26 12:07:59 +01:00
Coral color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "CORNFLOWER_BLUE" value= "Color(0.39, 0.58, 0.93, 1)" >
2021-01-12 19:22:31 +01:00
Cornflower blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "CORNSILK" value= "Color(1, 0.97, 0.86, 1)" >
2021-01-12 19:22:31 +01:00
Cornsilk color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "CRIMSON" value= "Color(0.86, 0.08, 0.24, 1)" >
2020-01-26 12:07:59 +01:00
Crimson color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "CYAN" value= "Color(0, 1, 1, 1)" >
2020-01-26 12:07:59 +01:00
Cyan color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_BLUE" value= "Color(0, 0, 0.55, 1)" >
2020-01-26 12:07:59 +01:00
Dark blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_CYAN" value= "Color(0, 0.55, 0.55, 1)" >
2020-01-26 12:07:59 +01:00
Dark cyan color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_GOLDENROD" value= "Color(0.72, 0.53, 0.04, 1)" >
2020-01-26 12:07:59 +01:00
Dark goldenrod color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_GRAY" value= "Color(0.66, 0.66, 0.66, 1)" >
2020-01-26 12:07:59 +01:00
Dark gray color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_GREEN" value= "Color(0, 0.39, 0, 1)" >
2020-01-26 12:07:59 +01:00
Dark green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_KHAKI" value= "Color(0.74, 0.72, 0.42, 1)" >
2020-01-26 12:07:59 +01:00
Dark khaki color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_MAGENTA" value= "Color(0.55, 0, 0.55, 1)" >
2020-01-26 12:07:59 +01:00
Dark magenta color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_OLIVE_GREEN" value= "Color(0.33, 0.42, 0.18, 1)" >
2020-01-26 12:07:59 +01:00
Dark olive green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_ORANGE" value= "Color(1, 0.55, 0, 1)" >
2020-01-26 12:07:59 +01:00
Dark orange color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_ORCHID" value= "Color(0.6, 0.2, 0.8, 1)" >
2020-01-26 12:07:59 +01:00
Dark orchid color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_RED" value= "Color(0.55, 0, 0, 1)" >
2020-01-26 12:07:59 +01:00
Dark red color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_SALMON" value= "Color(0.91, 0.59, 0.48, 1)" >
2020-01-26 12:07:59 +01:00
Dark salmon color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_SEA_GREEN" value= "Color(0.56, 0.74, 0.56, 1)" >
2020-01-26 12:07:59 +01:00
Dark sea green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_SLATE_BLUE" value= "Color(0.28, 0.24, 0.55, 1)" >
2020-01-26 12:07:59 +01:00
Dark slate blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_SLATE_GRAY" value= "Color(0.18, 0.31, 0.31, 1)" >
2020-01-26 12:07:59 +01:00
Dark slate gray color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_TURQUOISE" value= "Color(0, 0.81, 0.82, 1)" >
2020-01-26 12:07:59 +01:00
Dark turquoise color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DARK_VIOLET" value= "Color(0.58, 0, 0.83, 1)" >
2020-01-26 12:07:59 +01:00
Dark violet color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DEEP_PINK" value= "Color(1, 0.08, 0.58, 1)" >
2020-01-26 12:07:59 +01:00
Deep pink color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DEEP_SKY_BLUE" value= "Color(0, 0.75, 1, 1)" >
2020-01-26 12:07:59 +01:00
Deep sky blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DIM_GRAY" value= "Color(0.41, 0.41, 0.41, 1)" >
2020-01-26 12:07:59 +01:00
Dim gray color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "DODGER_BLUE" value= "Color(0.12, 0.56, 1, 1)" >
2020-01-26 12:07:59 +01:00
Dodger blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "FIREBRICK" value= "Color(0.7, 0.13, 0.13, 1)" >
2020-01-26 12:07:59 +01:00
Firebrick color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "FLORAL_WHITE" value= "Color(1, 0.98, 0.94, 1)" >
2020-01-26 12:07:59 +01:00
Floral white color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "FOREST_GREEN" value= "Color(0.13, 0.55, 0.13, 1)" >
2020-01-26 12:07:59 +01:00
Forest green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "FUCHSIA" value= "Color(1, 0, 1, 1)" >
2020-01-26 12:07:59 +01:00
Fuchsia color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "GAINSBORO" value= "Color(0.86, 0.86, 0.86, 1)" >
2020-01-26 12:07:59 +01:00
Gainsboro color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "GHOST_WHITE" value= "Color(0.97, 0.97, 1, 1)" >
2020-01-26 12:07:59 +01:00
Ghost white color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "GOLD" value= "Color(1, 0.84, 0, 1)" >
2020-01-26 12:07:59 +01:00
Gold color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "GOLDENROD" value= "Color(0.85, 0.65, 0.13, 1)" >
2020-01-26 12:07:59 +01:00
Goldenrod color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "GRAY" value= "Color(0.75, 0.75, 0.75, 1)" >
2020-02-13 10:08:52 +01:00
Gray color.
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "GREEN" value= "Color(0, 1, 0, 1)" >
2020-01-26 12:07:59 +01:00
Green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "GREEN_YELLOW" value= "Color(0.68, 1, 0.18, 1)" >
2020-01-26 12:07:59 +01:00
Green yellow color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "HONEYDEW" value= "Color(0.94, 1, 0.94, 1)" >
2020-01-26 12:07:59 +01:00
Honeydew color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "HOT_PINK" value= "Color(1, 0.41, 0.71, 1)" >
2020-01-26 12:07:59 +01:00
Hot pink color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "INDIAN_RED" value= "Color(0.8, 0.36, 0.36, 1)" >
2020-01-26 12:07:59 +01:00
Indian red color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "INDIGO" value= "Color(0.29, 0, 0.51, 1)" >
2020-01-26 12:07:59 +01:00
Indigo color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "IVORY" value= "Color(1, 1, 0.94, 1)" >
2020-01-26 12:07:59 +01:00
Ivory color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "KHAKI" value= "Color(0.94, 0.9, 0.55, 1)" >
2020-01-26 12:07:59 +01:00
Khaki color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LAVENDER" value= "Color(0.9, 0.9, 0.98, 1)" >
2020-01-26 12:07:59 +01:00
Lavender color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LAVENDER_BLUSH" value= "Color(1, 0.94, 0.96, 1)" >
2020-01-26 12:07:59 +01:00
Lavender blush color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LAWN_GREEN" value= "Color(0.49, 0.99, 0, 1)" >
2020-01-26 12:07:59 +01:00
Lawn green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LEMON_CHIFFON" value= "Color(1, 0.98, 0.8, 1)" >
2020-01-26 12:07:59 +01:00
Lemon chiffon color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIGHT_BLUE" value= "Color(0.68, 0.85, 0.9, 1)" >
2020-01-26 12:07:59 +01:00
Light blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIGHT_CORAL" value= "Color(0.94, 0.5, 0.5, 1)" >
2020-01-26 12:07:59 +01:00
Light coral color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIGHT_CYAN" value= "Color(0.88, 1, 1, 1)" >
2020-01-26 12:07:59 +01:00
Light cyan color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIGHT_GOLDENROD" value= "Color(0.98, 0.98, 0.82, 1)" >
2020-01-26 12:07:59 +01:00
Light goldenrod color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIGHT_GRAY" value= "Color(0.83, 0.83, 0.83, 1)" >
2020-01-26 12:07:59 +01:00
Light gray color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIGHT_GREEN" value= "Color(0.56, 0.93, 0.56, 1)" >
2020-01-26 12:07:59 +01:00
Light green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIGHT_PINK" value= "Color(1, 0.71, 0.76, 1)" >
2020-01-26 12:07:59 +01:00
Light pink color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIGHT_SALMON" value= "Color(1, 0.63, 0.48, 1)" >
2020-01-26 12:07:59 +01:00
Light salmon color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIGHT_SEA_GREEN" value= "Color(0.13, 0.7, 0.67, 1)" >
2020-01-26 12:07:59 +01:00
Light sea green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIGHT_SKY_BLUE" value= "Color(0.53, 0.81, 0.98, 1)" >
2020-01-26 12:07:59 +01:00
Light sky blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIGHT_SLATE_GRAY" value= "Color(0.47, 0.53, 0.6, 1)" >
2020-01-26 12:07:59 +01:00
Light slate gray color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIGHT_STEEL_BLUE" value= "Color(0.69, 0.77, 0.87, 1)" >
2020-01-26 12:07:59 +01:00
Light steel blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIGHT_YELLOW" value= "Color(1, 1, 0.88, 1)" >
2020-01-26 12:07:59 +01:00
Light yellow color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIME" value= "Color(0, 1, 0, 1)" >
2020-01-26 12:07:59 +01:00
Lime color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LIME_GREEN" value= "Color(0.2, 0.8, 0.2, 1)" >
2020-01-26 12:07:59 +01:00
Lime green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "LINEN" value= "Color(0.98, 0.94, 0.9, 1)" >
2020-01-26 12:07:59 +01:00
Linen color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MAGENTA" value= "Color(1, 0, 1, 1)" >
2020-01-26 12:07:59 +01:00
Magenta color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MAROON" value= "Color(0.69, 0.19, 0.38, 1)" >
2020-01-26 12:07:59 +01:00
Maroon color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MEDIUM_AQUAMARINE" value= "Color(0.4, 0.8, 0.67, 1)" >
2020-01-26 12:07:59 +01:00
Medium aquamarine color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MEDIUM_BLUE" value= "Color(0, 0, 0.8, 1)" >
2020-01-26 12:07:59 +01:00
Medium blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MEDIUM_ORCHID" value= "Color(0.73, 0.33, 0.83, 1)" >
2020-01-26 12:07:59 +01:00
Medium orchid color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MEDIUM_PURPLE" value= "Color(0.58, 0.44, 0.86, 1)" >
2020-01-26 12:07:59 +01:00
Medium purple color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MEDIUM_SEA_GREEN" value= "Color(0.24, 0.7, 0.44, 1)" >
2020-01-26 12:07:59 +01:00
Medium sea green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MEDIUM_SLATE_BLUE" value= "Color(0.48, 0.41, 0.93, 1)" >
2020-01-26 12:07:59 +01:00
Medium slate blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MEDIUM_SPRING_GREEN" value= "Color(0, 0.98, 0.6, 1)" >
2020-01-26 12:07:59 +01:00
Medium spring green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MEDIUM_TURQUOISE" value= "Color(0.28, 0.82, 0.8, 1)" >
2020-01-26 12:07:59 +01:00
Medium turquoise color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MEDIUM_VIOLET_RED" value= "Color(0.78, 0.08, 0.52, 1)" >
2020-01-26 12:07:59 +01:00
Medium violet red color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MIDNIGHT_BLUE" value= "Color(0.1, 0.1, 0.44, 1)" >
2020-01-26 12:07:59 +01:00
Midnight blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MINT_CREAM" value= "Color(0.96, 1, 0.98, 1)" >
2020-01-26 12:07:59 +01:00
Mint cream color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MISTY_ROSE" value= "Color(1, 0.89, 0.88, 1)" >
2020-01-26 12:07:59 +01:00
Misty rose color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "MOCCASIN" value= "Color(1, 0.89, 0.71, 1)" >
2020-01-26 12:07:59 +01:00
Moccasin color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "NAVAJO_WHITE" value= "Color(1, 0.87, 0.68, 1)" >
2020-01-26 12:07:59 +01:00
Navajo white color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "NAVY_BLUE" value= "Color(0, 0, 0.5, 1)" >
2020-01-26 12:07:59 +01:00
Navy blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "OLD_LACE" value= "Color(0.99, 0.96, 0.9, 1)" >
2020-01-26 12:07:59 +01:00
Old lace color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "OLIVE" value= "Color(0.5, 0.5, 0, 1)" >
2020-01-26 12:07:59 +01:00
Olive color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "OLIVE_DRAB" value= "Color(0.42, 0.56, 0.14, 1)" >
2020-01-26 12:07:59 +01:00
Olive drab color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "ORANGE" value= "Color(1, 0.65, 0, 1)" >
2020-01-26 12:07:59 +01:00
Orange color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "ORANGE_RED" value= "Color(1, 0.27, 0, 1)" >
2020-01-26 12:07:59 +01:00
Orange red color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "ORCHID" value= "Color(0.85, 0.44, 0.84, 1)" >
2020-01-26 12:07:59 +01:00
Orchid color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "PALE_GOLDENROD" value= "Color(0.93, 0.91, 0.67, 1)" >
2020-01-26 12:07:59 +01:00
Pale goldenrod color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "PALE_GREEN" value= "Color(0.6, 0.98, 0.6, 1)" >
2020-01-26 12:07:59 +01:00
Pale green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "PALE_TURQUOISE" value= "Color(0.69, 0.93, 0.93, 1)" >
2020-01-26 12:07:59 +01:00
Pale turquoise color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "PALE_VIOLET_RED" value= "Color(0.86, 0.44, 0.58, 1)" >
2020-01-26 12:07:59 +01:00
Pale violet red color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "PAPAYA_WHIP" value= "Color(1, 0.94, 0.84, 1)" >
2020-01-26 12:07:59 +01:00
Papaya whip color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "PEACH_PUFF" value= "Color(1, 0.85, 0.73, 1)" >
2020-01-26 12:07:59 +01:00
Peach puff color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "PERU" value= "Color(0.8, 0.52, 0.25, 1)" >
2020-01-26 12:07:59 +01:00
Peru color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "PINK" value= "Color(1, 0.75, 0.8, 1)" >
2020-01-26 12:07:59 +01:00
Pink color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "PLUM" value= "Color(0.87, 0.63, 0.87, 1)" >
2020-01-26 12:07:59 +01:00
Plum color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "POWDER_BLUE" value= "Color(0.69, 0.88, 0.9, 1)" >
2020-01-26 12:07:59 +01:00
Powder blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "PURPLE" value= "Color(0.63, 0.13, 0.94, 1)" >
2020-01-26 12:07:59 +01:00
Purple color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "REBECCA_PURPLE" value= "Color(0.4, 0.2, 0.6, 1)" >
2020-01-26 12:07:59 +01:00
Rebecca purple color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "RED" value= "Color(1, 0, 0, 1)" >
2020-01-26 12:07:59 +01:00
Red color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "ROSY_BROWN" value= "Color(0.74, 0.56, 0.56, 1)" >
2020-01-26 12:07:59 +01:00
Rosy brown color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "ROYAL_BLUE" value= "Color(0.25, 0.41, 0.88, 1)" >
2020-01-26 12:07:59 +01:00
Royal blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "SADDLE_BROWN" value= "Color(0.55, 0.27, 0.07, 1)" >
2020-01-26 12:07:59 +01:00
Saddle brown color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "SALMON" value= "Color(0.98, 0.5, 0.45, 1)" >
2020-01-26 12:07:59 +01:00
Salmon color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "SANDY_BROWN" value= "Color(0.96, 0.64, 0.38, 1)" >
2020-01-26 12:07:59 +01:00
Sandy brown color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "SEA_GREEN" value= "Color(0.18, 0.55, 0.34, 1)" >
2020-01-26 12:07:59 +01:00
Sea green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "SEASHELL" value= "Color(1, 0.96, 0.93, 1)" >
2020-01-26 12:07:59 +01:00
Seashell color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "SIENNA" value= "Color(0.63, 0.32, 0.18, 1)" >
2020-01-26 12:07:59 +01:00
Sienna color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "SILVER" value= "Color(0.75, 0.75, 0.75, 1)" >
2020-01-26 12:07:59 +01:00
Silver color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "SKY_BLUE" value= "Color(0.53, 0.81, 0.92, 1)" >
2020-01-26 12:07:59 +01:00
Sky blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "SLATE_BLUE" value= "Color(0.42, 0.35, 0.8, 1)" >
2020-01-26 12:07:59 +01:00
Slate blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "SLATE_GRAY" value= "Color(0.44, 0.5, 0.56, 1)" >
2020-01-26 12:07:59 +01:00
Slate gray color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "SNOW" value= "Color(1, 0.98, 0.98, 1)" >
2020-01-26 12:07:59 +01:00
Snow color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "SPRING_GREEN" value= "Color(0, 1, 0.5, 1)" >
2020-01-26 12:07:59 +01:00
Spring green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "STEEL_BLUE" value= "Color(0.27, 0.51, 0.71, 1)" >
2020-01-26 12:07:59 +01:00
Steel blue color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "TAN" value= "Color(0.82, 0.71, 0.55, 1)" >
2020-01-26 12:07:59 +01:00
Tan color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "TEAL" value= "Color(0, 0.5, 0.5, 1)" >
2020-01-26 12:07:59 +01:00
Teal color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "THISTLE" value= "Color(0.85, 0.75, 0.85, 1)" >
2020-01-26 12:07:59 +01:00
Thistle color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "TOMATO" value= "Color(1, 0.39, 0.28, 1)" >
2020-01-26 12:07:59 +01:00
Tomato color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "TRANSPARENT" value= "Color(1, 1, 1, 0)" >
2021-01-12 19:22:31 +01:00
Transparent color (white with zero alpha).
2019-05-28 18:08:13 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "TURQUOISE" value= "Color(0.25, 0.88, 0.82, 1)" >
2020-01-26 12:07:59 +01:00
Turquoise color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "VIOLET" value= "Color(0.93, 0.51, 0.93, 1)" >
2020-01-26 12:07:59 +01:00
Violet color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "WEB_GRAY" value= "Color(0.5, 0.5, 0.5, 1)" >
2020-01-26 12:07:59 +01:00
Web gray color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "WEB_GREEN" value= "Color(0, 0.5, 0, 1)" >
2020-01-26 12:07:59 +01:00
Web green color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "WEB_MAROON" value= "Color(0.5, 0, 0, 1)" >
2020-01-26 12:07:59 +01:00
Web maroon color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "WEB_PURPLE" value= "Color(0.5, 0, 0.5, 1)" >
2020-01-26 12:07:59 +01:00
Web purple color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "WHEAT" value= "Color(0.96, 0.87, 0.7, 1)" >
2020-01-26 12:07:59 +01:00
Wheat color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "WHITE" value= "Color(1, 1, 1, 1)" >
2020-01-26 12:07:59 +01:00
White color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "WHITE_SMOKE" value= "Color(0.96, 0.96, 0.96, 1)" >
2020-01-26 12:07:59 +01:00
White smoke color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "YELLOW" value= "Color(1, 1, 0, 1)" >
2020-01-26 12:07:59 +01:00
Yellow color.
2018-08-21 00:35:30 +02:00
</constant>
2019-09-24 19:45:03 +02:00
<constant name= "YELLOW_GREEN" value= "Color(0.6, 0.8, 0.2, 1)" >
2020-01-26 12:07:59 +01:00
Yellow green color.
2018-08-21 00:35:30 +02:00
</constant>
2017-09-12 22:42:36 +02:00
</constants>
2021-09-21 04:49:02 +02:00
<operators >
<operator name= "operator !=" >
<return type= "bool" />
<argument index= "0" name= "right" type= "Color" />
<description >
2021-11-04 16:58:20 +01:00
Returns [code]true[/code] if the colors are not equal.
[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
2021-09-21 04:49:02 +02:00
</description>
</operator>
<operator name= "operator *" >
<return type= "Color" />
<argument index= "0" name= "right" type= "Color" />
<description >
2021-11-04 16:58:20 +01:00
Multiplies each component of the [Color] by the components of the given [Color].
2021-09-21 04:49:02 +02:00
</description>
</operator>
<operator name= "operator *" >
<return type= "Color" />
<argument index= "0" name= "right" type= "float" />
<description >
2021-11-04 16:58:20 +01:00
Multiplies each component of the [Color] by the given [float].
2021-09-21 04:49:02 +02:00
</description>
</operator>
<operator name= "operator *" >
<return type= "Color" />
<argument index= "0" name= "right" type= "int" />
<description >
2021-11-04 16:58:20 +01:00
Multiplies each component of the [Color] by the given [int].
2021-09-21 04:49:02 +02:00
</description>
</operator>
<operator name= "operator +" >
<return type= "Color" />
<argument index= "0" name= "right" type= "Color" />
<description >
2021-11-04 16:58:20 +01:00
Adds each component of the [Color] with the components of the given [Color].
2021-09-21 04:49:02 +02:00
</description>
</operator>
<operator name= "operator -" >
<return type= "Color" />
<argument index= "0" name= "right" type= "Color" />
<description >
2021-11-04 16:58:20 +01:00
Subtracts each component of the [Color] by the components of the given [Color].
2021-09-21 04:49:02 +02:00
</description>
</operator>
<operator name= "operator /" >
<return type= "Color" />
<argument index= "0" name= "right" type= "Color" />
<description >
2021-11-04 16:58:20 +01:00
Divides each component of the [Color] by the components of the given [Color].
2021-09-21 04:49:02 +02:00
</description>
</operator>
<operator name= "operator /" >
<return type= "Color" />
<argument index= "0" name= "right" type= "float" />
<description >
2021-11-04 16:58:20 +01:00
Divides each component of the [Color] by the given [float].
2021-09-21 04:49:02 +02:00
</description>
</operator>
<operator name= "operator /" >
<return type= "Color" />
<argument index= "0" name= "right" type= "int" />
<description >
2021-11-04 16:58:20 +01:00
Divides each component of the [Color] by the given [int].
2021-09-21 04:49:02 +02:00
</description>
</operator>
<operator name= "operator ==" >
<return type= "bool" />
<argument index= "0" name= "right" type= "Color" />
<description >
2021-11-04 16:58:20 +01:00
Returns [code]true[/code] if the colors are exactly equal.
[b]Note:[/b] Due to floating-point precision errors, consider using [method is_equal_approx] instead, which is more reliable.
2021-09-21 04:49:02 +02:00
</description>
</operator>
<operator name= "operator []" >
<return type= "float" />
<argument index= "0" name= "index" type= "int" />
<description >
2021-11-04 16:58:20 +01:00
Access color components using their index. [code]c[0][/code] is equivalent to [code]c.r[/code], [code]c[1][/code] is equivalent to [code]c.g[/code], [code]c[2][/code] is equivalent to [code]c.b[/code], and [code]c[3][/code] is equivalent to [code]c.a[/code].
2021-09-21 04:49:02 +02:00
</description>
</operator>
<operator name= "operator unary+" >
<return type= "Color" />
<description >
2021-11-04 16:58:20 +01:00
Returns the same value as if the [code]+[/code] was not there. Unary [code]+[/code] does nothing, but sometimes it can make your code more readable.
2021-09-21 04:49:02 +02:00
</description>
</operator>
<operator name= "operator unary-" >
<return type= "Color" />
<description >
2021-11-04 16:58:20 +01:00
Inverts the given color. This is equivalent to [code]Color.WHITE - c[/code] or [code]Color(1 - c.r, 1 - c.g, 1 - c.b, 1 - c.a)[/code].
2021-09-21 04:49:02 +02:00
</description>
</operator>
</operators>
2017-09-12 22:42:36 +02:00
</class>