godot-docs/classes/class_color.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Color.xml.

.. _class_Color:

Color
=====

Color in RGBA format using floats on the range of 0 to 1.

Description
-----------

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).

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 `X11 color names <https://en.wikipedia.org/wiki/X11_color_names>`__.

If you want to supply values in a range of 0 to 255, you should use :ref:`@GDScript.Color8<class_@GDScript_method_Color8>`.

\ **Note:** In a boolean context, a Color will evaluate to ``false`` if it's equal to ``Color(0, 0, 0, 1)`` (opaque black). Otherwise, a Color will always evaluate to ``true``.

\ `Color constants cheatsheet <https://raw.githubusercontent.com/godotengine/godot-docs/master/img/color_constants.png>`__

Tutorials
---------

- `2D GD Paint Demo <https://godotengine.org/asset-library/asset/517>`__

- `Tween Demo <https://godotengine.org/asset-library/asset/146>`__

- `GUI Drag And Drop Demo <https://godotengine.org/asset-library/asset/133>`__

Properties
----------

+---------------------------+------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`a<class_Color_property_a>`   | ``1.0`` |
+---------------------------+------------------------------------+---------+
| :ref:`int<class_int>`     | :ref:`a8<class_Color_property_a8>` | ``255`` |
+---------------------------+------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`b<class_Color_property_b>`   | ``0.0`` |
+---------------------------+------------------------------------+---------+
| :ref:`int<class_int>`     | :ref:`b8<class_Color_property_b8>` | ``0``   |
+---------------------------+------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`g<class_Color_property_g>`   | ``0.0`` |
+---------------------------+------------------------------------+---------+
| :ref:`int<class_int>`     | :ref:`g8<class_Color_property_g8>` | ``0``   |
+---------------------------+------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`h<class_Color_property_h>`   | ``0.0`` |
+---------------------------+------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`r<class_Color_property_r>`   | ``0.0`` |
+---------------------------+------------------------------------+---------+
| :ref:`int<class_int>`     | :ref:`r8<class_Color_property_r8>` | ``0``   |
+---------------------------+------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`s<class_Color_property_s>`   | ``0.0`` |
+---------------------------+------------------------------------+---------+
| :ref:`float<class_float>` | :ref:`v<class_Color_property_v>`   | ``0.0`` |
+---------------------------+------------------------------------+---------+

Constructors
------------

+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>` **(** **)**                                                                                                                    |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>` **(** :ref:`Color<class_Color>` from, :ref:`float<class_float>` alpha **)**                                                    |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>` **(** :ref:`Color<class_Color>` from **)**                                                                                     |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>` **(** :ref:`String<class_String>` code **)**                                                                                   |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>` **(** :ref:`String<class_String>` code, :ref:`float<class_float>` alpha **)**                                                  |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)**                              |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)** |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Methods
-------

+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`blend<class_Color_method_blend>` **(** :ref:`Color<class_Color>` over **)** |const|                                                                                                          |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`clamp<class_Color_method_clamp>` **(** :ref:`Color<class_Color>` min=Color(0, 0, 0, 0), :ref:`Color<class_Color>` max=Color(1, 1, 1, 1) **)** |const|                                        |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`darkened<class_Color_method_darkened>` **(** :ref:`float<class_float>` amount **)** |const|                                                                                                  |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`       | :ref:`find_named_color<class_Color_method_find_named_color>` **(** :ref:`String<class_String>` name **)** |static|                                                                                 |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`from_hsv<class_Color_method_from_hsv>` **(** :ref:`float<class_float>` h, :ref:`float<class_float>` s, :ref:`float<class_float>` v, :ref:`float<class_float>` alpha=1.0 **)** |static|       |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`from_ok_hsl<class_Color_method_from_ok_hsl>` **(** :ref:`float<class_float>` h, :ref:`float<class_float>` s, :ref:`float<class_float>` l, :ref:`float<class_float>` alpha=1.0 **)** |static| |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`from_rgbe9995<class_Color_method_from_rgbe9995>` **(** :ref:`int<class_int>` rgbe **)** |static|                                                                                             |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`from_string<class_Color_method_from_string>` **(** :ref:`String<class_String>` str, :ref:`Color<class_Color>` default **)** |static|                                                         |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`   | :ref:`get_luminance<class_Color_method_get_luminance>` **(** **)** |const|                                                                                                                         |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`get_named_color<class_Color_method_get_named_color>` **(** :ref:`int<class_int>` idx **)** |static|                                                                                          |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`       | :ref:`get_named_color_count<class_Color_method_get_named_color_count>` **(** **)** |static|                                                                                                        |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_named_color_name<class_Color_method_get_named_color_name>` **(** :ref:`int<class_int>` idx **)** |static|                                                                                |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`hex<class_Color_method_hex>` **(** :ref:`int<class_int>` hex **)** |static|                                                                                                                  |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`hex64<class_Color_method_hex64>` **(** :ref:`int<class_int>` hex **)** |static|                                                                                                              |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`html<class_Color_method_html>` **(** :ref:`String<class_String>` rgba **)** |static|                                                                                                         |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`html_is_valid<class_Color_method_html_is_valid>` **(** :ref:`String<class_String>` color **)** |static|                                                                                      |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`inverted<class_Color_method_inverted>` **(** **)** |const|                                                                                                                                   |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`is_equal_approx<class_Color_method_is_equal_approx>` **(** :ref:`Color<class_Color>` to **)** |const|                                                                                        |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`lerp<class_Color_method_lerp>` **(** :ref:`Color<class_Color>` to, :ref:`float<class_float>` weight **)** |const|                                                                            |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`lightened<class_Color_method_lightened>` **(** :ref:`float<class_float>` amount **)** |const|                                                                                                |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`linear_to_srgb<class_Color_method_linear_to_srgb>` **(** **)** |const|                                                                                                                       |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`   | :ref:`srgb_to_linear<class_Color_method_srgb_to_linear>` **(** **)** |const|                                                                                                                       |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`       | :ref:`to_abgr32<class_Color_method_to_abgr32>` **(** **)** |const|                                                                                                                                 |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`       | :ref:`to_abgr64<class_Color_method_to_abgr64>` **(** **)** |const|                                                                                                                                 |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`       | :ref:`to_argb32<class_Color_method_to_argb32>` **(** **)** |const|                                                                                                                                 |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`       | :ref:`to_argb64<class_Color_method_to_argb64>` **(** **)** |const|                                                                                                                                 |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`to_html<class_Color_method_to_html>` **(** :ref:`bool<class_bool>` with_alpha=true **)** |const|                                                                                             |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`       | :ref:`to_rgba32<class_Color_method_to_rgba32>` **(** **)** |const|                                                                                                                                 |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`       | :ref:`to_rgba64<class_Color_method_to_rgba64>` **(** **)** |const|                                                                                                                                 |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Operators
---------

+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`   | :ref:`operator !=<class_Color_operator_neq_bool>` **(** :ref:`Color<class_Color>` right **)** |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator *<class_Color_operator_mul_Color>` **(** :ref:`Color<class_Color>` right **)** |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator *<class_Color_operator_mul_Color>` **(** :ref:`float<class_float>` right **)** |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator *<class_Color_operator_mul_Color>` **(** :ref:`int<class_int>` right **)**     |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator +<class_Color_operator_sum_Color>` **(** :ref:`Color<class_Color>` right **)** |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator -<class_Color_operator_dif_Color>` **(** :ref:`Color<class_Color>` right **)** |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator /<class_Color_operator_div_Color>` **(** :ref:`Color<class_Color>` right **)** |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator /<class_Color_operator_div_Color>` **(** :ref:`float<class_float>` right **)** |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator /<class_Color_operator_div_Color>` **(** :ref:`int<class_int>` right **)**     |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`   | :ref:`operator ==<class_Color_operator_eq_bool>` **(** :ref:`Color<class_Color>` right **)**  |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator []<class_Color_operator_idx_float>` **(** :ref:`int<class_int>` index **)**    |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator unary+<class_Color_operator_unplus_Color>` **(** **)**                         |
+---------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator unary-<class_Color_operator_unminus_Color>` **(** **)**                        |
+---------------------------+-----------------------------------------------------------------------------------------------+

Constants
---------

.. _class_Color_constant_ALICE_BLUE:

.. _class_Color_constant_ANTIQUE_WHITE:

.. _class_Color_constant_AQUA:

.. _class_Color_constant_AQUAMARINE:

.. _class_Color_constant_AZURE:

.. _class_Color_constant_BEIGE:

.. _class_Color_constant_BISQUE:

.. _class_Color_constant_BLACK:

.. _class_Color_constant_BLANCHED_ALMOND:

.. _class_Color_constant_BLUE:

.. _class_Color_constant_BLUE_VIOLET:

.. _class_Color_constant_BROWN:

.. _class_Color_constant_BURLYWOOD:

.. _class_Color_constant_CADET_BLUE:

.. _class_Color_constant_CHARTREUSE:

.. _class_Color_constant_CHOCOLATE:

.. _class_Color_constant_CORAL:

.. _class_Color_constant_CORNFLOWER_BLUE:

.. _class_Color_constant_CORNSILK:

.. _class_Color_constant_CRIMSON:

.. _class_Color_constant_CYAN:

.. _class_Color_constant_DARK_BLUE:

.. _class_Color_constant_DARK_CYAN:

.. _class_Color_constant_DARK_GOLDENROD:

.. _class_Color_constant_DARK_GRAY:

.. _class_Color_constant_DARK_GREEN:

.. _class_Color_constant_DARK_KHAKI:

.. _class_Color_constant_DARK_MAGENTA:

.. _class_Color_constant_DARK_OLIVE_GREEN:

.. _class_Color_constant_DARK_ORANGE:

.. _class_Color_constant_DARK_ORCHID:

.. _class_Color_constant_DARK_RED:

.. _class_Color_constant_DARK_SALMON:

.. _class_Color_constant_DARK_SEA_GREEN:

.. _class_Color_constant_DARK_SLATE_BLUE:

.. _class_Color_constant_DARK_SLATE_GRAY:

.. _class_Color_constant_DARK_TURQUOISE:

.. _class_Color_constant_DARK_VIOLET:

.. _class_Color_constant_DEEP_PINK:

.. _class_Color_constant_DEEP_SKY_BLUE:

.. _class_Color_constant_DIM_GRAY:

.. _class_Color_constant_DODGER_BLUE:

.. _class_Color_constant_FIREBRICK:

.. _class_Color_constant_FLORAL_WHITE:

.. _class_Color_constant_FOREST_GREEN:

.. _class_Color_constant_FUCHSIA:

.. _class_Color_constant_GAINSBORO:

.. _class_Color_constant_GHOST_WHITE:

.. _class_Color_constant_GOLD:

.. _class_Color_constant_GOLDENROD:

.. _class_Color_constant_GRAY:

.. _class_Color_constant_GREEN:

.. _class_Color_constant_GREEN_YELLOW:

.. _class_Color_constant_HONEYDEW:

.. _class_Color_constant_HOT_PINK:

.. _class_Color_constant_INDIAN_RED:

.. _class_Color_constant_INDIGO:

.. _class_Color_constant_IVORY:

.. _class_Color_constant_KHAKI:

.. _class_Color_constant_LAVENDER:

.. _class_Color_constant_LAVENDER_BLUSH:

.. _class_Color_constant_LAWN_GREEN:

.. _class_Color_constant_LEMON_CHIFFON:

.. _class_Color_constant_LIGHT_BLUE:

.. _class_Color_constant_LIGHT_CORAL:

.. _class_Color_constant_LIGHT_CYAN:

.. _class_Color_constant_LIGHT_GOLDENROD:

.. _class_Color_constant_LIGHT_GRAY:

.. _class_Color_constant_LIGHT_GREEN:

.. _class_Color_constant_LIGHT_PINK:

.. _class_Color_constant_LIGHT_SALMON:

.. _class_Color_constant_LIGHT_SEA_GREEN:

.. _class_Color_constant_LIGHT_SKY_BLUE:

.. _class_Color_constant_LIGHT_SLATE_GRAY:

.. _class_Color_constant_LIGHT_STEEL_BLUE:

.. _class_Color_constant_LIGHT_YELLOW:

.. _class_Color_constant_LIME:

.. _class_Color_constant_LIME_GREEN:

.. _class_Color_constant_LINEN:

.. _class_Color_constant_MAGENTA:

.. _class_Color_constant_MAROON:

.. _class_Color_constant_MEDIUM_AQUAMARINE:

.. _class_Color_constant_MEDIUM_BLUE:

.. _class_Color_constant_MEDIUM_ORCHID:

.. _class_Color_constant_MEDIUM_PURPLE:

.. _class_Color_constant_MEDIUM_SEA_GREEN:

.. _class_Color_constant_MEDIUM_SLATE_BLUE:

.. _class_Color_constant_MEDIUM_SPRING_GREEN:

.. _class_Color_constant_MEDIUM_TURQUOISE:

.. _class_Color_constant_MEDIUM_VIOLET_RED:

.. _class_Color_constant_MIDNIGHT_BLUE:

.. _class_Color_constant_MINT_CREAM:

.. _class_Color_constant_MISTY_ROSE:

.. _class_Color_constant_MOCCASIN:

.. _class_Color_constant_NAVAJO_WHITE:

.. _class_Color_constant_NAVY_BLUE:

.. _class_Color_constant_OLD_LACE:

.. _class_Color_constant_OLIVE:

.. _class_Color_constant_OLIVE_DRAB:

.. _class_Color_constant_ORANGE:

.. _class_Color_constant_ORANGE_RED:

.. _class_Color_constant_ORCHID:

.. _class_Color_constant_PALE_GOLDENROD:

.. _class_Color_constant_PALE_GREEN:

.. _class_Color_constant_PALE_TURQUOISE:

.. _class_Color_constant_PALE_VIOLET_RED:

.. _class_Color_constant_PAPAYA_WHIP:

.. _class_Color_constant_PEACH_PUFF:

.. _class_Color_constant_PERU:

.. _class_Color_constant_PINK:

.. _class_Color_constant_PLUM:

.. _class_Color_constant_POWDER_BLUE:

.. _class_Color_constant_PURPLE:

.. _class_Color_constant_REBECCA_PURPLE:

.. _class_Color_constant_RED:

.. _class_Color_constant_ROSY_BROWN:

.. _class_Color_constant_ROYAL_BLUE:

.. _class_Color_constant_SADDLE_BROWN:

.. _class_Color_constant_SALMON:

.. _class_Color_constant_SANDY_BROWN:

.. _class_Color_constant_SEA_GREEN:

.. _class_Color_constant_SEASHELL:

.. _class_Color_constant_SIENNA:

.. _class_Color_constant_SILVER:

.. _class_Color_constant_SKY_BLUE:

.. _class_Color_constant_SLATE_BLUE:

.. _class_Color_constant_SLATE_GRAY:

.. _class_Color_constant_SNOW:

.. _class_Color_constant_SPRING_GREEN:

.. _class_Color_constant_STEEL_BLUE:

.. _class_Color_constant_TAN:

.. _class_Color_constant_TEAL:

.. _class_Color_constant_THISTLE:

.. _class_Color_constant_TOMATO:

.. _class_Color_constant_TRANSPARENT:

.. _class_Color_constant_TURQUOISE:

.. _class_Color_constant_VIOLET:

.. _class_Color_constant_WEB_GRAY:

.. _class_Color_constant_WEB_GREEN:

.. _class_Color_constant_WEB_MAROON:

.. _class_Color_constant_WEB_PURPLE:

.. _class_Color_constant_WHEAT:

.. _class_Color_constant_WHITE:

.. _class_Color_constant_WHITE_SMOKE:

.. _class_Color_constant_YELLOW:

.. _class_Color_constant_YELLOW_GREEN:

- **ALICE_BLUE** = **Color(0.941176, 0.972549, 1, 1)** --- Alice blue color.

- **ANTIQUE_WHITE** = **Color(0.980392, 0.921569, 0.843137, 1)** --- Antique white color.

- **AQUA** = **Color(0, 1, 1, 1)** --- Aqua color.

- **AQUAMARINE** = **Color(0.498039, 1, 0.831373, 1)** --- Aquamarine color.

- **AZURE** = **Color(0.941176, 1, 1, 1)** --- Azure color.

- **BEIGE** = **Color(0.960784, 0.960784, 0.862745, 1)** --- Beige color.

- **BISQUE** = **Color(1, 0.894118, 0.768627, 1)** --- Bisque color.

- **BLACK** = **Color(0, 0, 0, 1)** --- Black color.

- **BLANCHED_ALMOND** = **Color(1, 0.921569, 0.803922, 1)** --- Blanched almond color.

- **BLUE** = **Color(0, 0, 1, 1)** --- Blue color.

- **BLUE_VIOLET** = **Color(0.541176, 0.168627, 0.886275, 1)** --- Blue violet color.

- **BROWN** = **Color(0.647059, 0.164706, 0.164706, 1)** --- Brown color.

- **BURLYWOOD** = **Color(0.870588, 0.721569, 0.529412, 1)** --- Burlywood color.

- **CADET_BLUE** = **Color(0.372549, 0.619608, 0.627451, 1)** --- Cadet blue color.

- **CHARTREUSE** = **Color(0.498039, 1, 0, 1)** --- Chartreuse color.

- **CHOCOLATE** = **Color(0.823529, 0.411765, 0.117647, 1)** --- Chocolate color.

- **CORAL** = **Color(1, 0.498039, 0.313726, 1)** --- Coral color.

- **CORNFLOWER_BLUE** = **Color(0.392157, 0.584314, 0.929412, 1)** --- Cornflower blue color.

- **CORNSILK** = **Color(1, 0.972549, 0.862745, 1)** --- Cornsilk color.

- **CRIMSON** = **Color(0.862745, 0.0784314, 0.235294, 1)** --- Crimson color.

- **CYAN** = **Color(0, 1, 1, 1)** --- Cyan color.

- **DARK_BLUE** = **Color(0, 0, 0.545098, 1)** --- Dark blue color.

- **DARK_CYAN** = **Color(0, 0.545098, 0.545098, 1)** --- Dark cyan color.

- **DARK_GOLDENROD** = **Color(0.721569, 0.52549, 0.0431373, 1)** --- Dark goldenrod color.

- **DARK_GRAY** = **Color(0.662745, 0.662745, 0.662745, 1)** --- Dark gray color.

- **DARK_GREEN** = **Color(0, 0.392157, 0, 1)** --- Dark green color.

- **DARK_KHAKI** = **Color(0.741176, 0.717647, 0.419608, 1)** --- Dark khaki color.

- **DARK_MAGENTA** = **Color(0.545098, 0, 0.545098, 1)** --- Dark magenta color.

- **DARK_OLIVE_GREEN** = **Color(0.333333, 0.419608, 0.184314, 1)** --- Dark olive green color.

- **DARK_ORANGE** = **Color(1, 0.54902, 0, 1)** --- Dark orange color.

- **DARK_ORCHID** = **Color(0.6, 0.196078, 0.8, 1)** --- Dark orchid color.

- **DARK_RED** = **Color(0.545098, 0, 0, 1)** --- Dark red color.

- **DARK_SALMON** = **Color(0.913725, 0.588235, 0.478431, 1)** --- Dark salmon color.

- **DARK_SEA_GREEN** = **Color(0.560784, 0.737255, 0.560784, 1)** --- Dark sea green color.

- **DARK_SLATE_BLUE** = **Color(0.282353, 0.239216, 0.545098, 1)** --- Dark slate blue color.

- **DARK_SLATE_GRAY** = **Color(0.184314, 0.309804, 0.309804, 1)** --- Dark slate gray color.

- **DARK_TURQUOISE** = **Color(0, 0.807843, 0.819608, 1)** --- Dark turquoise color.

- **DARK_VIOLET** = **Color(0.580392, 0, 0.827451, 1)** --- Dark violet color.

- **DEEP_PINK** = **Color(1, 0.0784314, 0.576471, 1)** --- Deep pink color.

- **DEEP_SKY_BLUE** = **Color(0, 0.74902, 1, 1)** --- Deep sky blue color.

- **DIM_GRAY** = **Color(0.411765, 0.411765, 0.411765, 1)** --- Dim gray color.

- **DODGER_BLUE** = **Color(0.117647, 0.564706, 1, 1)** --- Dodger blue color.

- **FIREBRICK** = **Color(0.698039, 0.133333, 0.133333, 1)** --- Firebrick color.

- **FLORAL_WHITE** = **Color(1, 0.980392, 0.941176, 1)** --- Floral white color.

- **FOREST_GREEN** = **Color(0.133333, 0.545098, 0.133333, 1)** --- Forest green color.

- **FUCHSIA** = **Color(1, 0, 1, 1)** --- Fuchsia color.

- **GAINSBORO** = **Color(0.862745, 0.862745, 0.862745, 1)** --- Gainsboro color.

- **GHOST_WHITE** = **Color(0.972549, 0.972549, 1, 1)** --- Ghost white color.

- **GOLD** = **Color(1, 0.843137, 0, 1)** --- Gold color.

- **GOLDENROD** = **Color(0.854902, 0.647059, 0.12549, 1)** --- Goldenrod color.

- **GRAY** = **Color(0.745098, 0.745098, 0.745098, 1)** --- Gray color.

- **GREEN** = **Color(0, 1, 0, 1)** --- Green color.

- **GREEN_YELLOW** = **Color(0.678431, 1, 0.184314, 1)** --- Green yellow color.

- **HONEYDEW** = **Color(0.941176, 1, 0.941176, 1)** --- Honeydew color.

- **HOT_PINK** = **Color(1, 0.411765, 0.705882, 1)** --- Hot pink color.

- **INDIAN_RED** = **Color(0.803922, 0.360784, 0.360784, 1)** --- Indian red color.

- **INDIGO** = **Color(0.294118, 0, 0.509804, 1)** --- Indigo color.

- **IVORY** = **Color(1, 1, 0.941176, 1)** --- Ivory color.

- **KHAKI** = **Color(0.941176, 0.901961, 0.54902, 1)** --- Khaki color.

- **LAVENDER** = **Color(0.901961, 0.901961, 0.980392, 1)** --- Lavender color.

- **LAVENDER_BLUSH** = **Color(1, 0.941176, 0.960784, 1)** --- Lavender blush color.

- **LAWN_GREEN** = **Color(0.486275, 0.988235, 0, 1)** --- Lawn green color.

- **LEMON_CHIFFON** = **Color(1, 0.980392, 0.803922, 1)** --- Lemon chiffon color.

- **LIGHT_BLUE** = **Color(0.678431, 0.847059, 0.901961, 1)** --- Light blue color.

- **LIGHT_CORAL** = **Color(0.941176, 0.501961, 0.501961, 1)** --- Light coral color.

- **LIGHT_CYAN** = **Color(0.878431, 1, 1, 1)** --- Light cyan color.

- **LIGHT_GOLDENROD** = **Color(0.980392, 0.980392, 0.823529, 1)** --- Light goldenrod color.

- **LIGHT_GRAY** = **Color(0.827451, 0.827451, 0.827451, 1)** --- Light gray color.

- **LIGHT_GREEN** = **Color(0.564706, 0.933333, 0.564706, 1)** --- Light green color.

- **LIGHT_PINK** = **Color(1, 0.713726, 0.756863, 1)** --- Light pink color.

- **LIGHT_SALMON** = **Color(1, 0.627451, 0.478431, 1)** --- Light salmon color.

- **LIGHT_SEA_GREEN** = **Color(0.12549, 0.698039, 0.666667, 1)** --- Light sea green color.

- **LIGHT_SKY_BLUE** = **Color(0.529412, 0.807843, 0.980392, 1)** --- Light sky blue color.

- **LIGHT_SLATE_GRAY** = **Color(0.466667, 0.533333, 0.6, 1)** --- Light slate gray color.

- **LIGHT_STEEL_BLUE** = **Color(0.690196, 0.768627, 0.870588, 1)** --- Light steel blue color.

- **LIGHT_YELLOW** = **Color(1, 1, 0.878431, 1)** --- Light yellow color.

- **LIME** = **Color(0, 1, 0, 1)** --- Lime color.

- **LIME_GREEN** = **Color(0.196078, 0.803922, 0.196078, 1)** --- Lime green color.

- **LINEN** = **Color(0.980392, 0.941176, 0.901961, 1)** --- Linen color.

- **MAGENTA** = **Color(1, 0, 1, 1)** --- Magenta color.

- **MAROON** = **Color(0.690196, 0.188235, 0.376471, 1)** --- Maroon color.

- **MEDIUM_AQUAMARINE** = **Color(0.4, 0.803922, 0.666667, 1)** --- Medium aquamarine color.

- **MEDIUM_BLUE** = **Color(0, 0, 0.803922, 1)** --- Medium blue color.

- **MEDIUM_ORCHID** = **Color(0.729412, 0.333333, 0.827451, 1)** --- Medium orchid color.

- **MEDIUM_PURPLE** = **Color(0.576471, 0.439216, 0.858824, 1)** --- Medium purple color.

- **MEDIUM_SEA_GREEN** = **Color(0.235294, 0.701961, 0.443137, 1)** --- Medium sea green color.

- **MEDIUM_SLATE_BLUE** = **Color(0.482353, 0.407843, 0.933333, 1)** --- Medium slate blue color.

- **MEDIUM_SPRING_GREEN** = **Color(0, 0.980392, 0.603922, 1)** --- Medium spring green color.

- **MEDIUM_TURQUOISE** = **Color(0.282353, 0.819608, 0.8, 1)** --- Medium turquoise color.

- **MEDIUM_VIOLET_RED** = **Color(0.780392, 0.0823529, 0.521569, 1)** --- Medium violet red color.

- **MIDNIGHT_BLUE** = **Color(0.0980392, 0.0980392, 0.439216, 1)** --- Midnight blue color.

- **MINT_CREAM** = **Color(0.960784, 1, 0.980392, 1)** --- Mint cream color.

- **MISTY_ROSE** = **Color(1, 0.894118, 0.882353, 1)** --- Misty rose color.

- **MOCCASIN** = **Color(1, 0.894118, 0.709804, 1)** --- Moccasin color.

- **NAVAJO_WHITE** = **Color(1, 0.870588, 0.678431, 1)** --- Navajo white color.

- **NAVY_BLUE** = **Color(0, 0, 0.501961, 1)** --- Navy blue color.

- **OLD_LACE** = **Color(0.992157, 0.960784, 0.901961, 1)** --- Old lace color.

- **OLIVE** = **Color(0.501961, 0.501961, 0, 1)** --- Olive color.

- **OLIVE_DRAB** = **Color(0.419608, 0.556863, 0.137255, 1)** --- Olive drab color.

- **ORANGE** = **Color(1, 0.647059, 0, 1)** --- Orange color.

- **ORANGE_RED** = **Color(1, 0.270588, 0, 1)** --- Orange red color.

- **ORCHID** = **Color(0.854902, 0.439216, 0.839216, 1)** --- Orchid color.

- **PALE_GOLDENROD** = **Color(0.933333, 0.909804, 0.666667, 1)** --- Pale goldenrod color.

- **PALE_GREEN** = **Color(0.596078, 0.984314, 0.596078, 1)** --- Pale green color.

- **PALE_TURQUOISE** = **Color(0.686275, 0.933333, 0.933333, 1)** --- Pale turquoise color.

- **PALE_VIOLET_RED** = **Color(0.858824, 0.439216, 0.576471, 1)** --- Pale violet red color.

- **PAPAYA_WHIP** = **Color(1, 0.937255, 0.835294, 1)** --- Papaya whip color.

- **PEACH_PUFF** = **Color(1, 0.854902, 0.72549, 1)** --- Peach puff color.

- **PERU** = **Color(0.803922, 0.521569, 0.247059, 1)** --- Peru color.

- **PINK** = **Color(1, 0.752941, 0.796078, 1)** --- Pink color.

- **PLUM** = **Color(0.866667, 0.627451, 0.866667, 1)** --- Plum color.

- **POWDER_BLUE** = **Color(0.690196, 0.878431, 0.901961, 1)** --- Powder blue color.

- **PURPLE** = **Color(0.627451, 0.12549, 0.941176, 1)** --- Purple color.

- **REBECCA_PURPLE** = **Color(0.4, 0.2, 0.6, 1)** --- Rebecca purple color.

- **RED** = **Color(1, 0, 0, 1)** --- Red color.

- **ROSY_BROWN** = **Color(0.737255, 0.560784, 0.560784, 1)** --- Rosy brown color.

- **ROYAL_BLUE** = **Color(0.254902, 0.411765, 0.882353, 1)** --- Royal blue color.

- **SADDLE_BROWN** = **Color(0.545098, 0.270588, 0.0745098, 1)** --- Saddle brown color.

- **SALMON** = **Color(0.980392, 0.501961, 0.447059, 1)** --- Salmon color.

- **SANDY_BROWN** = **Color(0.956863, 0.643137, 0.376471, 1)** --- Sandy brown color.

- **SEA_GREEN** = **Color(0.180392, 0.545098, 0.341176, 1)** --- Sea green color.

- **SEASHELL** = **Color(1, 0.960784, 0.933333, 1)** --- Seashell color.

- **SIENNA** = **Color(0.627451, 0.321569, 0.176471, 1)** --- Sienna color.

- **SILVER** = **Color(0.752941, 0.752941, 0.752941, 1)** --- Silver color.

- **SKY_BLUE** = **Color(0.529412, 0.807843, 0.921569, 1)** --- Sky blue color.

- **SLATE_BLUE** = **Color(0.415686, 0.352941, 0.803922, 1)** --- Slate blue color.

- **SLATE_GRAY** = **Color(0.439216, 0.501961, 0.564706, 1)** --- Slate gray color.

- **SNOW** = **Color(1, 0.980392, 0.980392, 1)** --- Snow color.

- **SPRING_GREEN** = **Color(0, 1, 0.498039, 1)** --- Spring green color.

- **STEEL_BLUE** = **Color(0.27451, 0.509804, 0.705882, 1)** --- Steel blue color.

- **TAN** = **Color(0.823529, 0.705882, 0.54902, 1)** --- Tan color.

- **TEAL** = **Color(0, 0.501961, 0.501961, 1)** --- Teal color.

- **THISTLE** = **Color(0.847059, 0.74902, 0.847059, 1)** --- Thistle color.

- **TOMATO** = **Color(1, 0.388235, 0.278431, 1)** --- Tomato color.

- **TRANSPARENT** = **Color(1, 1, 1, 0)** --- Transparent color (white with zero alpha).

- **TURQUOISE** = **Color(0.25098, 0.878431, 0.815686, 1)** --- Turquoise color.

- **VIOLET** = **Color(0.933333, 0.509804, 0.933333, 1)** --- Violet color.

- **WEB_GRAY** = **Color(0.501961, 0.501961, 0.501961, 1)** --- Web gray color.

- **WEB_GREEN** = **Color(0, 0.501961, 0, 1)** --- Web green color.

- **WEB_MAROON** = **Color(0.501961, 0, 0, 1)** --- Web maroon color.

- **WEB_PURPLE** = **Color(0.501961, 0, 0.501961, 1)** --- Web purple color.

- **WHEAT** = **Color(0.960784, 0.870588, 0.701961, 1)** --- Wheat color.

- **WHITE** = **Color(1, 1, 1, 1)** --- White color.

- **WHITE_SMOKE** = **Color(0.960784, 0.960784, 0.960784, 1)** --- White smoke color.

- **YELLOW** = **Color(1, 1, 0, 1)** --- Yellow color.

- **YELLOW_GREEN** = **Color(0.603922, 0.803922, 0.196078, 1)** --- Yellow green color.

Property Descriptions
---------------------

.. _class_Color_property_a:

- :ref:`float<class_float>` **a**

+-----------+---------+
| *Default* | ``1.0`` |
+-----------+---------+

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.

----

.. _class_Color_property_a8:

- :ref:`int<class_int>` **a8**

+-----------+---------+
| *Default* | ``255`` |
+-----------+---------+

Wrapper for :ref:`a<class_Color_property_a>` that uses the range 0 to 255 instead of 0 to 1.

----

.. _class_Color_property_b:

- :ref:`float<class_float>` **b**

+-----------+---------+
| *Default* | ``0.0`` |
+-----------+---------+

The color's blue component, typically on the range of 0 to 1.

----

.. _class_Color_property_b8:

- :ref:`int<class_int>` **b8**

+-----------+-------+
| *Default* | ``0`` |
+-----------+-------+

Wrapper for :ref:`b<class_Color_property_b>` that uses the range 0 to 255 instead of 0 to 1.

----

.. _class_Color_property_g:

- :ref:`float<class_float>` **g**

+-----------+---------+
| *Default* | ``0.0`` |
+-----------+---------+

The color's green component, typically on the range of 0 to 1.

----

.. _class_Color_property_g8:

- :ref:`int<class_int>` **g8**

+-----------+-------+
| *Default* | ``0`` |
+-----------+-------+

Wrapper for :ref:`g<class_Color_property_g>` that uses the range 0 to 255 instead of 0 to 1.

----

.. _class_Color_property_h:

- :ref:`float<class_float>` **h**

+-----------+---------+
| *Default* | ``0.0`` |
+-----------+---------+

The HSV hue of this color, on the range 0 to 1.

----

.. _class_Color_property_r:

- :ref:`float<class_float>` **r**

+-----------+---------+
| *Default* | ``0.0`` |
+-----------+---------+

The color's red component, typically on the range of 0 to 1.

----

.. _class_Color_property_r8:

- :ref:`int<class_int>` **r8**

+-----------+-------+
| *Default* | ``0`` |
+-----------+-------+

Wrapper for :ref:`r<class_Color_property_r>` that uses the range 0 to 255 instead of 0 to 1.

----

.. _class_Color_property_s:

- :ref:`float<class_float>` **s**

+-----------+---------+
| *Default* | ``0.0`` |
+-----------+---------+

The HSV saturation of this color, on the range 0 to 1.

----

.. _class_Color_property_v:

- :ref:`float<class_float>` **v**

+-----------+---------+
| *Default* | ``0.0`` |
+-----------+---------+

The HSV value (brightness) of this color, on the range 0 to 1.

Constructor Descriptions
------------------------

.. _class_Color_constructor_Color:

- :ref:`Color<class_Color>` **Color** **(** **)**

Constructs a default-initialized ``Color`` with all components set to ``0``.

----

- :ref:`Color<class_Color>` **Color** **(** :ref:`Color<class_Color>` from, :ref:`float<class_float>` alpha **)**

Constructs a ``Color`` from an existing color, but with a custom alpha value.


.. tabs::

 .. code-tab:: gdscript

    var red = Color(Color.red, 0.2) # 20% opaque red.

 .. code-tab:: csharp

    var red = new Color(Colors.Red, 0.2f); // 20% opaque red.



----

- :ref:`Color<class_Color>` **Color** **(** :ref:`Color<class_Color>` from **)**

Constructs a ``Color`` as a copy of the given ``Color``.

----

- :ref:`Color<class_Color>` **Color** **(** :ref:`String<class_String>` code **)**

Constructs a ``Color`` either from an HTML color code or from a standardized color name. Supported color names are the same as the constants.

----

- :ref:`Color<class_Color>` **Color** **(** :ref:`String<class_String>` code, :ref:`float<class_float>` alpha **)**

Constructs a ``Color`` either from an HTML color code or from a standardized color name, with ``alpha`` on the range of 0 to 1. Supported color names are the same as the constants.

----

- :ref:`Color<class_Color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)**

Constructs a ``Color`` from RGB values, typically between 0 and 1. Alpha will be 1.


.. tabs::

 .. code-tab:: gdscript

    var color = Color(0.2, 1.0, 0.7) # Similar to `Color8(51, 255, 178, 255)`

 .. code-tab:: csharp

    var color = new Color(0.2f, 1.0f, 0.7f); // Similar to `Color.Color8(51, 255, 178, 255)`



----

- :ref:`Color<class_Color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)**

Constructs a ``Color`` from RGBA values, typically between 0 and 1.


.. tabs::

 .. code-tab:: gdscript

    var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to `Color8(51, 255, 178, 204)`

 .. code-tab:: csharp

    var color = new Color(0.2f, 1.0f, 0.7f, 0.8f); // Similar to `Color.Color8(51, 255, 178, 255, 204)`



Method Descriptions
-------------------

.. _class_Color_method_blend:

- :ref:`Color<class_Color>` **blend** **(** :ref:`Color<class_Color>` over **)** |const|

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.


.. tabs::

 .. code-tab:: gdscript

    var bg = Color(0.0, 1.0, 0.0, 0.5) # Green with alpha of 50%
    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%

 .. code-tab:: 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%



----

.. _class_Color_method_clamp:

- :ref:`Color<class_Color>` **clamp** **(** :ref:`Color<class_Color>` min=Color(0, 0, 0, 0), :ref:`Color<class_Color>` max=Color(1, 1, 1, 1) **)** |const|

Returns a new color with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp<class_@GlobalScope_method_clamp>` on each component.

----

.. _class_Color_method_darkened:

- :ref:`Color<class_Color>` **darkened** **(** :ref:`float<class_float>` amount **)** |const|

Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1).


.. tabs::

 .. code-tab:: gdscript

    var green = Color(0.0, 1.0, 0.0)
    var darkgreen = green.darkened(0.2) # 20% darker than regular green

 .. code-tab:: csharp

    var green = new Color(0.0f, 1.0f, 0.0f);
    Color darkgreen = green.Darkened(0.2f); // 20% darker than regular green



----

.. _class_Color_method_find_named_color:

- :ref:`int<class_int>` **find_named_color** **(** :ref:`String<class_String>` name **)** |static|

----

.. _class_Color_method_from_hsv:

- :ref:`Color<class_Color>` **from_hsv** **(** :ref:`float<class_float>` h, :ref:`float<class_float>` s, :ref:`float<class_float>` v, :ref:`float<class_float>` alpha=1.0 **)** |static|

Constructs a color from an `HSV profile <https://en.wikipedia.org/wiki/HSL_and_HSV>`__. ``h`` (hue), ``s`` (saturation), and ``v`` (value) are typically between 0 and 1.


.. tabs::

 .. code-tab:: gdscript

    var color = Color.from_hsv(0.58, 0.5, 0.79, 0.8)

 .. code-tab:: csharp

    var color = Color.FromHsv(0.58f, 0.5f, 0.79f, 0.8f);



----

.. _class_Color_method_from_ok_hsl:

- :ref:`Color<class_Color>` **from_ok_hsl** **(** :ref:`float<class_float>` h, :ref:`float<class_float>` s, :ref:`float<class_float>` l, :ref:`float<class_float>` alpha=1.0 **)** |static|

Constructs a color from an `OK HSL profile <https://bottosson.github.io/posts/colorpicker/>`__. ``h`` (hue), ``s`` (saturation), and ``v`` (value) are typically between 0 and 1.


.. tabs::

 .. code-tab:: gdscript

    var color = Color.from_ok_hsl(0.58, 0.5, 0.79, 0.8)

 .. code-tab:: csharp

    var color = Color.FromOkHsl(0.58f, 0.5f, 0.79f, 0.8f);



----

.. _class_Color_method_from_rgbe9995:

- :ref:`Color<class_Color>` **from_rgbe9995** **(** :ref:`int<class_int>` rgbe **)** |static|

----

.. _class_Color_method_from_string:

- :ref:`Color<class_Color>` **from_string** **(** :ref:`String<class_String>` str, :ref:`Color<class_Color>` default **)** |static|

----

.. _class_Color_method_get_luminance:

- :ref:`float<class_float>` **get_luminance** **(** **)** |const|

Returns the luminance of the color in the ``[0.0, 1.0]`` range.

This is useful when determining light or dark color. Colors with a luminance smaller than 0.5 can be generally considered dark.

\ **Note:** :ref:`get_luminance<class_Color_method_get_luminance>` relies on the colour being in the linear color space to return an accurate relative luminance value. If the color is in the sRGB color space, use :ref:`srgb_to_linear<class_Color_method_srgb_to_linear>` to convert it to the linear color space first.

----

.. _class_Color_method_get_named_color:

- :ref:`Color<class_Color>` **get_named_color** **(** :ref:`int<class_int>` idx **)** |static|

----

.. _class_Color_method_get_named_color_count:

- :ref:`int<class_int>` **get_named_color_count** **(** **)** |static|

----

.. _class_Color_method_get_named_color_name:

- :ref:`String<class_String>` **get_named_color_name** **(** :ref:`int<class_int>` idx **)** |static|

----

.. _class_Color_method_hex:

- :ref:`Color<class_Color>` **hex** **(** :ref:`int<class_int>` hex **)** |static|

----

.. _class_Color_method_hex64:

- :ref:`Color<class_Color>` **hex64** **(** :ref:`int<class_int>` hex **)** |static|

----

.. _class_Color_method_html:

- :ref:`Color<class_Color>` **html** **(** :ref:`String<class_String>` rgba **)** |static|

Returns a new color from ``rgba``, an HTML hexadecimal color string. ``rgba`` is not case sensitive, and may be prefixed with a '#' character.

\ ``rgba`` must be a valid three-digit or six-digit hexadecimal color string, and may contain an alpha channel value. If ``rgba`` does not contain an alpha channel value, an alpha channel value of 1.0 is applied.

If ``rgba`` is invalid a Color(0.0, 0.0, 0.0, 1.0) is returned.

\ **Note:** This method is not implemented in C#, but the same functionality is provided in the class constructor.


.. tabs::

 .. code-tab:: 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)

 .. code-tab:: csharp

    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)



----

.. _class_Color_method_html_is_valid:

- :ref:`bool<class_bool>` **html_is_valid** **(** :ref:`String<class_String>` color **)** |static|

Returns ``true`` if ``color`` is a valid HTML hexadecimal color string. ``color`` 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.


.. tabs::

 .. code-tab:: 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

 .. code-tab:: 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



----

.. _class_Color_method_inverted:

- :ref:`Color<class_Color>` **inverted** **(** **)** |const|

Returns the inverted color ``(1 - r, 1 - g, 1 - b, a)``.


.. tabs::

 .. code-tab:: gdscript

    var color = Color(0.3, 0.4, 0.9)
    var inverted_color = color.inverted() # Equivalent to `Color(0.7, 0.6, 0.1)`

 .. code-tab:: csharp

    var color = new Color(0.3f, 0.4f, 0.9f);
    Color invertedColor = color.Inverted(); // Equivalent to `new Color(0.7f, 0.6f, 0.1f)`



----

.. _class_Color_method_is_equal_approx:

- :ref:`bool<class_bool>` **is_equal_approx** **(** :ref:`Color<class_Color>` to **)** |const|

Returns ``true`` if this color and ``color`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx<class_@GlobalScope_method_is_equal_approx>` on each component.

----

.. _class_Color_method_lerp:

- :ref:`Color<class_Color>` **lerp** **(** :ref:`Color<class_Color>` to, :ref:`float<class_float>` weight **)** |const|

Returns the linear interpolation with another color. The interpolation factor ``weight`` is between 0 and 1.


.. tabs::

 .. code-tab:: gdscript

    var c1 = Color(1.0, 0.0, 0.0)
    var c2 = Color(0.0, 1.0, 0.0)
    var lerp_color = c1.lerp(c2, 0.5) # Equivalent to `Color(0.5, 0.5, 0.0)`

 .. code-tab:: csharp

    var c1 = new Color(1.0f, 0.0f, 0.0f);
    var c2 = new Color(0.0f, 1.0f, 0.0f);
    Color lerpColor = c1.Lerp(c2, 0.5f); // Equivalent to `new Color(0.5f, 0.5f, 0.0f)`



----

.. _class_Color_method_lightened:

- :ref:`Color<class_Color>` **lightened** **(** :ref:`float<class_float>` amount **)** |const|

Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1).


.. tabs::

 .. code-tab:: gdscript

    var green = Color(0.0, 1.0, 0.0)
    var lightgreen = green.lightened(0.2) # 20% lighter than regular green

 .. code-tab:: csharp

    var green = new Color(0.0f, 1.0f, 0.0f);
    Color lightgreen = green.Lightened(0.2f); // 20% lighter than regular green



----

.. _class_Color_method_linear_to_srgb:

- :ref:`Color<class_Color>` **linear_to_srgb** **(** **)** |const|

Returns the color converted to the `sRGB <https://en.wikipedia.org/wiki/SRGB>`__ color space. This assumes the original color is in the linear color space. See also :ref:`srgb_to_linear<class_Color_method_srgb_to_linear>` which performs the opposite operation.

----

.. _class_Color_method_srgb_to_linear:

- :ref:`Color<class_Color>` **srgb_to_linear** **(** **)** |const|

Returns the color converted to the linear color space. This assumes the original color is in the sRGB color space. See also :ref:`linear_to_srgb<class_Color_method_linear_to_srgb>` which performs the opposite operation.

----

.. _class_Color_method_to_abgr32:

- :ref:`int<class_int>` **to_abgr32** **(** **)** |const|

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.


.. tabs::

 .. code-tab:: gdscript

    var color = Color(1, 0.5, 0.2)
    print(color.to_abgr32()) # Prints 4281565439

 .. code-tab:: csharp

    var color = new Color(1.0f, 0.5f, 0.2f);
    GD.Print(color.ToAbgr32()); // Prints 4281565439



----

.. _class_Color_method_to_abgr64:

- :ref:`int<class_int>` **to_abgr64** **(** **)** |const|

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.


.. tabs::

 .. code-tab:: gdscript

    var color = Color(1, 0.5, 0.2)
    print(color.to_abgr64()) # Prints -225178692812801

 .. code-tab:: csharp

    var color = new Color(1.0f, 0.5f, 0.2f);
    GD.Print(color.ToAbgr64()); // Prints -225178692812801



----

.. _class_Color_method_to_argb32:

- :ref:`int<class_int>` **to_argb32** **(** **)** |const|

Returns the color converted to a 32-bit integer in ARGB format (each byte represents a color channel). ARGB is more compatible with DirectX.


.. tabs::

 .. code-tab:: gdscript

    var color = Color(1, 0.5, 0.2)
    print(color.to_argb32()) # Prints 4294934323

 .. code-tab:: csharp

    var color = new Color(1.0f, 0.5f, 0.2f);
    GD.Print(color.ToArgb32()); // Prints 4294934323



----

.. _class_Color_method_to_argb64:

- :ref:`int<class_int>` **to_argb64** **(** **)** |const|

Returns the color converted to a 64-bit integer in ARGB format (each word represents a color channel). ARGB is more compatible with DirectX.


.. tabs::

 .. code-tab:: gdscript

    var color = Color(1, 0.5, 0.2)
    print(color.to_argb64()) # Prints -2147470541

 .. code-tab:: csharp

    var color = new Color(1.0f, 0.5f, 0.2f);
    GD.Print(color.ToArgb64()); // Prints -2147470541



----

.. _class_Color_method_to_html:

- :ref:`String<class_String>` **to_html** **(** :ref:`bool<class_bool>` with_alpha=true **)** |const|

Returns the color converted to an HTML hexadecimal color string in RGBA format (ex: ``ff34f822``).

Setting ``with_alpha`` to ``false`` excludes alpha from the hexadecimal string (and uses RGB instead of RGBA format).


.. tabs::

 .. code-tab:: 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"

 .. code-tab:: csharp

    var color = new Color(1, 1, 1, 0.5f);
    String withAlpha = color.ToHtml(); // Returns "ffffff7f"
    String withoutAlpha = color.ToHtml(false); // Returns "ffffff"



----

.. _class_Color_method_to_rgba32:

- :ref:`int<class_int>` **to_rgba32** **(** **)** |const|

Returns the color converted to a 32-bit integer in RGBA format (each byte represents a color channel). RGBA is Godot's default format.


.. tabs::

 .. code-tab:: gdscript

    var color = Color(1, 0.5, 0.2)
    print(color.to_rgba32()) # Prints 4286526463

 .. code-tab:: csharp

    var color = new Color(1, 0.5f, 0.2f);
    GD.Print(color.ToRgba32()); // Prints 4286526463



----

.. _class_Color_method_to_rgba64:

- :ref:`int<class_int>` **to_rgba64** **(** **)** |const|

Returns the color converted to a 64-bit integer in RGBA format (each word represents a color channel). RGBA is Godot's default format.


.. tabs::

 .. code-tab:: gdscript

    var color = Color(1, 0.5, 0.2)
    print(color.to_rgba64()) # Prints -140736629309441

 .. code-tab:: csharp

    var color = new Color(1, 0.5f, 0.2f);
    GD.Print(color.ToRgba64()); // Prints -140736629309441



Operator Descriptions
---------------------

.. _class_Color_operator_neq_bool:

- :ref:`bool<class_bool>` **operator !=** **(** :ref:`Color<class_Color>` right **)**

Returns ``true`` if the colors are not equal.

\ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Color_method_is_equal_approx>` instead, which is more reliable.

----

.. _class_Color_operator_mul_Color:

- :ref:`Color<class_Color>` **operator *** **(** :ref:`Color<class_Color>` right **)**

Multiplies each component of the ``Color`` by the components of the given ``Color``.

----

- :ref:`Color<class_Color>` **operator *** **(** :ref:`float<class_float>` right **)**

Multiplies each component of the ``Color`` by the given :ref:`float<class_float>`.

----

- :ref:`Color<class_Color>` **operator *** **(** :ref:`int<class_int>` right **)**

Multiplies each component of the ``Color`` by the given :ref:`int<class_int>`.

----

.. _class_Color_operator_sum_Color:

- :ref:`Color<class_Color>` **operator +** **(** :ref:`Color<class_Color>` right **)**

Adds each component of the ``Color`` with the components of the given ``Color``.

----

.. _class_Color_operator_dif_Color:

- :ref:`Color<class_Color>` **operator -** **(** :ref:`Color<class_Color>` right **)**

Subtracts each component of the ``Color`` by the components of the given ``Color``.

----

.. _class_Color_operator_div_Color:

- :ref:`Color<class_Color>` **operator /** **(** :ref:`Color<class_Color>` right **)**

Divides each component of the ``Color`` by the components of the given ``Color``.

----

- :ref:`Color<class_Color>` **operator /** **(** :ref:`float<class_float>` right **)**

Divides each component of the ``Color`` by the given :ref:`float<class_float>`.

----

- :ref:`Color<class_Color>` **operator /** **(** :ref:`int<class_int>` right **)**

Divides each component of the ``Color`` by the given :ref:`int<class_int>`.

----

.. _class_Color_operator_eq_bool:

- :ref:`bool<class_bool>` **operator ==** **(** :ref:`Color<class_Color>` right **)**

Returns ``true`` if the colors are exactly equal.

\ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Color_method_is_equal_approx>` instead, which is more reliable.

----

.. _class_Color_operator_idx_float:

- :ref:`float<class_float>` **operator []** **(** :ref:`int<class_int>` index **)**

Access color components using their index. ``c[0]`` is equivalent to ``c.r``, ``c[1]`` is equivalent to ``c.g``, ``c[2]`` is equivalent to ``c.b``, and ``c[3]`` is equivalent to ``c.a``.

----

.. _class_Color_operator_unplus_Color:

- :ref:`Color<class_Color>` **operator unary+** **(** **)**

Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable.

----

.. _class_Color_operator_unminus_Color:

- :ref:`Color<class_Color>` **operator unary-** **(** **)**

Inverts the given color. This is equivalent to ``Color.WHITE - c`` or ``Color(1 - c.r, 1 - c.g, 1 - c.b, 1 - c.a)``.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`