godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
4.2
godot-docs/classes/class_color.rst
Godot Organization 77af6c9b61 classref: Sync with current 4.2 branch (f9d101d)
2024-05-07 11:26:31 +00:00

2393 lines
70 KiB
ReStructuredText
Raw Permalink Blame History

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/Color.xml.
.. _class_Color:
Color
=====
A color represented in RGBA format.
.. rst-class:: classref-introduction-group
Description
-----------
A color represented in RGBA format by a red (:ref:`r<class_Color_property_r>`), green (:ref:`g<class_Color_property_g>`), blue (:ref:`b<class_Color_property_b>`), and alpha (:ref:`a<class_Color_property_a>`) component. Each component is a 32-bit floating-point value, usually ranging from ``0.0`` to ``1.0``. Some properties (such as :ref:`CanvasItem.modulate<class_CanvasItem_property_modulate>`) may support values greater than ``1.0``, for overbright or HDR (High Dynamic Range) colors.
Colors can be created in various ways: By the various **Color** constructors, by static methods such as :ref:`from_hsv<class_Color_method_from_hsv>`, and by using a name from the set of standardized colors based on `X11 color names <https://en.wikipedia.org/wiki/X11_color_names>`__ with the addition of :ref:`TRANSPARENT<class_Color_constant_TRANSPARENT>`. GDScript also provides :ref:`@GDScript.Color8<class_@GDScript_method_Color8>`, which uses integers from ``0`` to ``255`` and doesn't support overbright colors.
\ **Note:** In a boolean context, a Color will evaluate to ``false`` if it is 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>`__
.. note::
There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.
.. rst-class:: classref-introduction-group
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>`__
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+---------------------------+------------------------------------+---------+
| :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`` |
+---------------------------+------------------------------------+---------+
.. rst-class:: classref-reftable-group
Constructors
------------
.. table::
:widths: auto
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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 **)** |
+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Methods
-------
.. table::
:widths: auto
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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:`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:`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| |
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Operators
---------
.. table::
:widths: auto
+---------------------------+------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator !=<class_Color_operator_neq_Color>` **(** :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_float>` **(** :ref:`float<class_float>` right **)** |
+---------------------------+------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator *<class_Color_operator_mul_int>` **(** :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_float>` **(** :ref:`float<class_float>` right **)** |
+---------------------------+------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator /<class_Color_operator_div_int>` **(** :ref:`int<class_int>` right **)** |
+---------------------------+------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ==<class_Color_operator_eq_Color>` **(** :ref:`Color<class_Color>` right **)** |
+---------------------------+------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator []<class_Color_operator_idx_int>` **(** :ref:`int<class_int>` index **)** |
+---------------------------+------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator unary+<class_Color_operator_unplus>` **(** **)** |
+---------------------------+------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator unary-<class_Color_operator_unminus>` **(** **)** |
+---------------------------+------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Constants
---------
.. _class_Color_constant_ALICE_BLUE:
.. rst-class:: classref-constant
**ALICE_BLUE** = ``Color(0.941176, 0.972549, 1, 1)``
Alice blue color.
.. _class_Color_constant_ANTIQUE_WHITE:
.. rst-class:: classref-constant
**ANTIQUE_WHITE** = ``Color(0.980392, 0.921569, 0.843137, 1)``
Antique white color.
.. _class_Color_constant_AQUA:
.. rst-class:: classref-constant
**AQUA** = ``Color(0, 1, 1, 1)``
Aqua color.
.. _class_Color_constant_AQUAMARINE:
.. rst-class:: classref-constant
**AQUAMARINE** = ``Color(0.498039, 1, 0.831373, 1)``
Aquamarine color.
.. _class_Color_constant_AZURE:
.. rst-class:: classref-constant
**AZURE** = ``Color(0.941176, 1, 1, 1)``
Azure color.
.. _class_Color_constant_BEIGE:
.. rst-class:: classref-constant
**BEIGE** = ``Color(0.960784, 0.960784, 0.862745, 1)``
Beige color.
.. _class_Color_constant_BISQUE:
.. rst-class:: classref-constant
**BISQUE** = ``Color(1, 0.894118, 0.768627, 1)``
Bisque color.
.. _class_Color_constant_BLACK:
.. rst-class:: classref-constant
**BLACK** = ``Color(0, 0, 0, 1)``
Black color. In GDScript, this is the default value of any color.
.. _class_Color_constant_BLANCHED_ALMOND:
.. rst-class:: classref-constant
**BLANCHED_ALMOND** = ``Color(1, 0.921569, 0.803922, 1)``
Blanched almond color.
.. _class_Color_constant_BLUE:
.. rst-class:: classref-constant
**BLUE** = ``Color(0, 0, 1, 1)``
Blue color.
.. _class_Color_constant_BLUE_VIOLET:
.. rst-class:: classref-constant
**BLUE_VIOLET** = ``Color(0.541176, 0.168627, 0.886275, 1)``
Blue violet color.
.. _class_Color_constant_BROWN:
.. rst-class:: classref-constant
**BROWN** = ``Color(0.647059, 0.164706, 0.164706, 1)``
Brown color.
.. _class_Color_constant_BURLYWOOD:
.. rst-class:: classref-constant
**BURLYWOOD** = ``Color(0.870588, 0.721569, 0.529412, 1)``
Burlywood color.
.. _class_Color_constant_CADET_BLUE:
.. rst-class:: classref-constant
**CADET_BLUE** = ``Color(0.372549, 0.619608, 0.627451, 1)``
Cadet blue color.
.. _class_Color_constant_CHARTREUSE:
.. rst-class:: classref-constant
**CHARTREUSE** = ``Color(0.498039, 1, 0, 1)``
Chartreuse color.
.. _class_Color_constant_CHOCOLATE:
.. rst-class:: classref-constant
**CHOCOLATE** = ``Color(0.823529, 0.411765, 0.117647, 1)``
Chocolate color.
.. _class_Color_constant_CORAL:
.. rst-class:: classref-constant
**CORAL** = ``Color(1, 0.498039, 0.313726, 1)``
Coral color.
.. _class_Color_constant_CORNFLOWER_BLUE:
.. rst-class:: classref-constant
**CORNFLOWER_BLUE** = ``Color(0.392157, 0.584314, 0.929412, 1)``
Cornflower blue color.
.. _class_Color_constant_CORNSILK:
.. rst-class:: classref-constant
**CORNSILK** = ``Color(1, 0.972549, 0.862745, 1)``
Cornsilk color.
.. _class_Color_constant_CRIMSON:
.. rst-class:: classref-constant
**CRIMSON** = ``Color(0.862745, 0.0784314, 0.235294, 1)``
Crimson color.
.. _class_Color_constant_CYAN:
.. rst-class:: classref-constant
**CYAN** = ``Color(0, 1, 1, 1)``
Cyan color.
.. _class_Color_constant_DARK_BLUE:
.. rst-class:: classref-constant
**DARK_BLUE** = ``Color(0, 0, 0.545098, 1)``
Dark blue color.
.. _class_Color_constant_DARK_CYAN:
.. rst-class:: classref-constant
**DARK_CYAN** = ``Color(0, 0.545098, 0.545098, 1)``
Dark cyan color.
.. _class_Color_constant_DARK_GOLDENROD:
.. rst-class:: classref-constant
**DARK_GOLDENROD** = ``Color(0.721569, 0.52549, 0.0431373, 1)``
Dark goldenrod color.
.. _class_Color_constant_DARK_GRAY:
.. rst-class:: classref-constant
**DARK_GRAY** = ``Color(0.662745, 0.662745, 0.662745, 1)``
Dark gray color.
.. _class_Color_constant_DARK_GREEN:
.. rst-class:: classref-constant
**DARK_GREEN** = ``Color(0, 0.392157, 0, 1)``
Dark green color.
.. _class_Color_constant_DARK_KHAKI:
.. rst-class:: classref-constant
**DARK_KHAKI** = ``Color(0.741176, 0.717647, 0.419608, 1)``
Dark khaki color.
.. _class_Color_constant_DARK_MAGENTA:
.. rst-class:: classref-constant
**DARK_MAGENTA** = ``Color(0.545098, 0, 0.545098, 1)``
Dark magenta color.
.. _class_Color_constant_DARK_OLIVE_GREEN:
.. rst-class:: classref-constant
**DARK_OLIVE_GREEN** = ``Color(0.333333, 0.419608, 0.184314, 1)``
Dark olive green color.
.. _class_Color_constant_DARK_ORANGE:
.. rst-class:: classref-constant
**DARK_ORANGE** = ``Color(1, 0.54902, 0, 1)``
Dark orange color.
.. _class_Color_constant_DARK_ORCHID:
.. rst-class:: classref-constant
**DARK_ORCHID** = ``Color(0.6, 0.196078, 0.8, 1)``
Dark orchid color.
.. _class_Color_constant_DARK_RED:
.. rst-class:: classref-constant
**DARK_RED** = ``Color(0.545098, 0, 0, 1)``
Dark red color.
.. _class_Color_constant_DARK_SALMON:
.. rst-class:: classref-constant
**DARK_SALMON** = ``Color(0.913725, 0.588235, 0.478431, 1)``
Dark salmon color.
.. _class_Color_constant_DARK_SEA_GREEN:
.. rst-class:: classref-constant
**DARK_SEA_GREEN** = ``Color(0.560784, 0.737255, 0.560784, 1)``
Dark sea green color.
.. _class_Color_constant_DARK_SLATE_BLUE:
.. rst-class:: classref-constant
**DARK_SLATE_BLUE** = ``Color(0.282353, 0.239216, 0.545098, 1)``
Dark slate blue color.
.. _class_Color_constant_DARK_SLATE_GRAY:
.. rst-class:: classref-constant
**DARK_SLATE_GRAY** = ``Color(0.184314, 0.309804, 0.309804, 1)``
Dark slate gray color.
.. _class_Color_constant_DARK_TURQUOISE:
.. rst-class:: classref-constant
**DARK_TURQUOISE** = ``Color(0, 0.807843, 0.819608, 1)``
Dark turquoise color.
.. _class_Color_constant_DARK_VIOLET:
.. rst-class:: classref-constant
**DARK_VIOLET** = ``Color(0.580392, 0, 0.827451, 1)``
Dark violet color.
.. _class_Color_constant_DEEP_PINK:
.. rst-class:: classref-constant
**DEEP_PINK** = ``Color(1, 0.0784314, 0.576471, 1)``
Deep pink color.
.. _class_Color_constant_DEEP_SKY_BLUE:
.. rst-class:: classref-constant
**DEEP_SKY_BLUE** = ``Color(0, 0.74902, 1, 1)``
Deep sky blue color.
.. _class_Color_constant_DIM_GRAY:
.. rst-class:: classref-constant
**DIM_GRAY** = ``Color(0.411765, 0.411765, 0.411765, 1)``
Dim gray color.
.. _class_Color_constant_DODGER_BLUE:
.. rst-class:: classref-constant
**DODGER_BLUE** = ``Color(0.117647, 0.564706, 1, 1)``
Dodger blue color.
.. _class_Color_constant_FIREBRICK:
.. rst-class:: classref-constant
**FIREBRICK** = ``Color(0.698039, 0.133333, 0.133333, 1)``
Firebrick color.
.. _class_Color_constant_FLORAL_WHITE:
.. rst-class:: classref-constant
**FLORAL_WHITE** = ``Color(1, 0.980392, 0.941176, 1)``
Floral white color.
.. _class_Color_constant_FOREST_GREEN:
.. rst-class:: classref-constant
**FOREST_GREEN** = ``Color(0.133333, 0.545098, 0.133333, 1)``
Forest green color.
.. _class_Color_constant_FUCHSIA:
.. rst-class:: classref-constant
**FUCHSIA** = ``Color(1, 0, 1, 1)``
Fuchsia color.
.. _class_Color_constant_GAINSBORO:
.. rst-class:: classref-constant
**GAINSBORO** = ``Color(0.862745, 0.862745, 0.862745, 1)``
Gainsboro color.
.. _class_Color_constant_GHOST_WHITE:
.. rst-class:: classref-constant
**GHOST_WHITE** = ``Color(0.972549, 0.972549, 1, 1)``
Ghost white color.
.. _class_Color_constant_GOLD:
.. rst-class:: classref-constant
**GOLD** = ``Color(1, 0.843137, 0, 1)``
Gold color.
.. _class_Color_constant_GOLDENROD:
.. rst-class:: classref-constant
**GOLDENROD** = ``Color(0.854902, 0.647059, 0.12549, 1)``
Goldenrod color.
.. _class_Color_constant_GRAY:
.. rst-class:: classref-constant
**GRAY** = ``Color(0.745098, 0.745098, 0.745098, 1)``
Gray color.
.. _class_Color_constant_GREEN:
.. rst-class:: classref-constant
**GREEN** = ``Color(0, 1, 0, 1)``
Green color.
.. _class_Color_constant_GREEN_YELLOW:
.. rst-class:: classref-constant
**GREEN_YELLOW** = ``Color(0.678431, 1, 0.184314, 1)``
Green yellow color.
.. _class_Color_constant_HONEYDEW:
.. rst-class:: classref-constant
**HONEYDEW** = ``Color(0.941176, 1, 0.941176, 1)``
Honeydew color.
.. _class_Color_constant_HOT_PINK:
.. rst-class:: classref-constant
**HOT_PINK** = ``Color(1, 0.411765, 0.705882, 1)``
Hot pink color.
.. _class_Color_constant_INDIAN_RED:
.. rst-class:: classref-constant
**INDIAN_RED** = ``Color(0.803922, 0.360784, 0.360784, 1)``
Indian red color.
.. _class_Color_constant_INDIGO:
.. rst-class:: classref-constant
**INDIGO** = ``Color(0.294118, 0, 0.509804, 1)``
Indigo color.
.. _class_Color_constant_IVORY:
.. rst-class:: classref-constant
**IVORY** = ``Color(1, 1, 0.941176, 1)``
Ivory color.
.. _class_Color_constant_KHAKI:
.. rst-class:: classref-constant
**KHAKI** = ``Color(0.941176, 0.901961, 0.54902, 1)``
Khaki color.
.. _class_Color_constant_LAVENDER:
.. rst-class:: classref-constant
**LAVENDER** = ``Color(0.901961, 0.901961, 0.980392, 1)``
Lavender color.
.. _class_Color_constant_LAVENDER_BLUSH:
.. rst-class:: classref-constant
**LAVENDER_BLUSH** = ``Color(1, 0.941176, 0.960784, 1)``
Lavender blush color.
.. _class_Color_constant_LAWN_GREEN:
.. rst-class:: classref-constant
**LAWN_GREEN** = ``Color(0.486275, 0.988235, 0, 1)``
Lawn green color.
.. _class_Color_constant_LEMON_CHIFFON:
.. rst-class:: classref-constant
**LEMON_CHIFFON** = ``Color(1, 0.980392, 0.803922, 1)``
Lemon chiffon color.
.. _class_Color_constant_LIGHT_BLUE:
.. rst-class:: classref-constant
**LIGHT_BLUE** = ``Color(0.678431, 0.847059, 0.901961, 1)``
Light blue color.
.. _class_Color_constant_LIGHT_CORAL:
.. rst-class:: classref-constant
**LIGHT_CORAL** = ``Color(0.941176, 0.501961, 0.501961, 1)``
Light coral color.
.. _class_Color_constant_LIGHT_CYAN:
.. rst-class:: classref-constant
**LIGHT_CYAN** = ``Color(0.878431, 1, 1, 1)``
Light cyan color.
.. _class_Color_constant_LIGHT_GOLDENROD:
.. rst-class:: classref-constant
**LIGHT_GOLDENROD** = ``Color(0.980392, 0.980392, 0.823529, 1)``
Light goldenrod color.
.. _class_Color_constant_LIGHT_GRAY:
.. rst-class:: classref-constant
**LIGHT_GRAY** = ``Color(0.827451, 0.827451, 0.827451, 1)``
Light gray color.
.. _class_Color_constant_LIGHT_GREEN:
.. rst-class:: classref-constant
**LIGHT_GREEN** = ``Color(0.564706, 0.933333, 0.564706, 1)``
Light green color.
.. _class_Color_constant_LIGHT_PINK:
.. rst-class:: classref-constant
**LIGHT_PINK** = ``Color(1, 0.713726, 0.756863, 1)``
Light pink color.
.. _class_Color_constant_LIGHT_SALMON:
.. rst-class:: classref-constant
**LIGHT_SALMON** = ``Color(1, 0.627451, 0.478431, 1)``
Light salmon color.
.. _class_Color_constant_LIGHT_SEA_GREEN:
.. rst-class:: classref-constant
**LIGHT_SEA_GREEN** = ``Color(0.12549, 0.698039, 0.666667, 1)``
Light sea green color.
.. _class_Color_constant_LIGHT_SKY_BLUE:
.. rst-class:: classref-constant
**LIGHT_SKY_BLUE** = ``Color(0.529412, 0.807843, 0.980392, 1)``
Light sky blue color.
.. _class_Color_constant_LIGHT_SLATE_GRAY:
.. rst-class:: classref-constant
**LIGHT_SLATE_GRAY** = ``Color(0.466667, 0.533333, 0.6, 1)``
Light slate gray color.
.. _class_Color_constant_LIGHT_STEEL_BLUE:
.. rst-class:: classref-constant
**LIGHT_STEEL_BLUE** = ``Color(0.690196, 0.768627, 0.870588, 1)``
Light steel blue color.
.. _class_Color_constant_LIGHT_YELLOW:
.. rst-class:: classref-constant
**LIGHT_YELLOW** = ``Color(1, 1, 0.878431, 1)``
Light yellow color.
.. _class_Color_constant_LIME:
.. rst-class:: classref-constant
**LIME** = ``Color(0, 1, 0, 1)``
Lime color.
.. _class_Color_constant_LIME_GREEN:
.. rst-class:: classref-constant
**LIME_GREEN** = ``Color(0.196078, 0.803922, 0.196078, 1)``
Lime green color.
.. _class_Color_constant_LINEN:
.. rst-class:: classref-constant
**LINEN** = ``Color(0.980392, 0.941176, 0.901961, 1)``
Linen color.
.. _class_Color_constant_MAGENTA:
.. rst-class:: classref-constant
**MAGENTA** = ``Color(1, 0, 1, 1)``
Magenta color.
.. _class_Color_constant_MAROON:
.. rst-class:: classref-constant
**MAROON** = ``Color(0.690196, 0.188235, 0.376471, 1)``
Maroon color.
.. _class_Color_constant_MEDIUM_AQUAMARINE:
.. rst-class:: classref-constant
**MEDIUM_AQUAMARINE** = ``Color(0.4, 0.803922, 0.666667, 1)``
Medium aquamarine color.
.. _class_Color_constant_MEDIUM_BLUE:
.. rst-class:: classref-constant
**MEDIUM_BLUE** = ``Color(0, 0, 0.803922, 1)``
Medium blue color.
.. _class_Color_constant_MEDIUM_ORCHID:
.. rst-class:: classref-constant
**MEDIUM_ORCHID** = ``Color(0.729412, 0.333333, 0.827451, 1)``
Medium orchid color.
.. _class_Color_constant_MEDIUM_PURPLE:
.. rst-class:: classref-constant
**MEDIUM_PURPLE** = ``Color(0.576471, 0.439216, 0.858824, 1)``
Medium purple color.
.. _class_Color_constant_MEDIUM_SEA_GREEN:
.. rst-class:: classref-constant
**MEDIUM_SEA_GREEN** = ``Color(0.235294, 0.701961, 0.443137, 1)``
Medium sea green color.
.. _class_Color_constant_MEDIUM_SLATE_BLUE:
.. rst-class:: classref-constant
**MEDIUM_SLATE_BLUE** = ``Color(0.482353, 0.407843, 0.933333, 1)``
Medium slate blue color.
.. _class_Color_constant_MEDIUM_SPRING_GREEN:
.. rst-class:: classref-constant
**MEDIUM_SPRING_GREEN** = ``Color(0, 0.980392, 0.603922, 1)``
Medium spring green color.
.. _class_Color_constant_MEDIUM_TURQUOISE:
.. rst-class:: classref-constant
**MEDIUM_TURQUOISE** = ``Color(0.282353, 0.819608, 0.8, 1)``
Medium turquoise color.
.. _class_Color_constant_MEDIUM_VIOLET_RED:
.. rst-class:: classref-constant
**MEDIUM_VIOLET_RED** = ``Color(0.780392, 0.0823529, 0.521569, 1)``
Medium violet red color.
.. _class_Color_constant_MIDNIGHT_BLUE:
.. rst-class:: classref-constant
**MIDNIGHT_BLUE** = ``Color(0.0980392, 0.0980392, 0.439216, 1)``
Midnight blue color.
.. _class_Color_constant_MINT_CREAM:
.. rst-class:: classref-constant
**MINT_CREAM** = ``Color(0.960784, 1, 0.980392, 1)``
Mint cream color.
.. _class_Color_constant_MISTY_ROSE:
.. rst-class:: classref-constant
**MISTY_ROSE** = ``Color(1, 0.894118, 0.882353, 1)``
Misty rose color.
.. _class_Color_constant_MOCCASIN:
.. rst-class:: classref-constant
**MOCCASIN** = ``Color(1, 0.894118, 0.709804, 1)``
Moccasin color.
.. _class_Color_constant_NAVAJO_WHITE:
.. rst-class:: classref-constant
**NAVAJO_WHITE** = ``Color(1, 0.870588, 0.678431, 1)``
Navajo white color.
.. _class_Color_constant_NAVY_BLUE:
.. rst-class:: classref-constant
**NAVY_BLUE** = ``Color(0, 0, 0.501961, 1)``
Navy blue color.
.. _class_Color_constant_OLD_LACE:
.. rst-class:: classref-constant
**OLD_LACE** = ``Color(0.992157, 0.960784, 0.901961, 1)``
Old lace color.
.. _class_Color_constant_OLIVE:
.. rst-class:: classref-constant
**OLIVE** = ``Color(0.501961, 0.501961, 0, 1)``
Olive color.
.. _class_Color_constant_OLIVE_DRAB:
.. rst-class:: classref-constant
**OLIVE_DRAB** = ``Color(0.419608, 0.556863, 0.137255, 1)``
Olive drab color.
.. _class_Color_constant_ORANGE:
.. rst-class:: classref-constant
**ORANGE** = ``Color(1, 0.647059, 0, 1)``
Orange color.
.. _class_Color_constant_ORANGE_RED:
.. rst-class:: classref-constant
**ORANGE_RED** = ``Color(1, 0.270588, 0, 1)``
Orange red color.
.. _class_Color_constant_ORCHID:
.. rst-class:: classref-constant
**ORCHID** = ``Color(0.854902, 0.439216, 0.839216, 1)``
Orchid color.
.. _class_Color_constant_PALE_GOLDENROD:
.. rst-class:: classref-constant
**PALE_GOLDENROD** = ``Color(0.933333, 0.909804, 0.666667, 1)``
Pale goldenrod color.
.. _class_Color_constant_PALE_GREEN:
.. rst-class:: classref-constant
**PALE_GREEN** = ``Color(0.596078, 0.984314, 0.596078, 1)``
Pale green color.
.. _class_Color_constant_PALE_TURQUOISE:
.. rst-class:: classref-constant
**PALE_TURQUOISE** = ``Color(0.686275, 0.933333, 0.933333, 1)``
Pale turquoise color.
.. _class_Color_constant_PALE_VIOLET_RED:
.. rst-class:: classref-constant
**PALE_VIOLET_RED** = ``Color(0.858824, 0.439216, 0.576471, 1)``
Pale violet red color.
.. _class_Color_constant_PAPAYA_WHIP:
.. rst-class:: classref-constant
**PAPAYA_WHIP** = ``Color(1, 0.937255, 0.835294, 1)``
Papaya whip color.
.. _class_Color_constant_PEACH_PUFF:
.. rst-class:: classref-constant
**PEACH_PUFF** = ``Color(1, 0.854902, 0.72549, 1)``
Peach puff color.
.. _class_Color_constant_PERU:
.. rst-class:: classref-constant
**PERU** = ``Color(0.803922, 0.521569, 0.247059, 1)``
Peru color.
.. _class_Color_constant_PINK:
.. rst-class:: classref-constant
**PINK** = ``Color(1, 0.752941, 0.796078, 1)``
Pink color.
.. _class_Color_constant_PLUM:
.. rst-class:: classref-constant
**PLUM** = ``Color(0.866667, 0.627451, 0.866667, 1)``
Plum color.
.. _class_Color_constant_POWDER_BLUE:
.. rst-class:: classref-constant
**POWDER_BLUE** = ``Color(0.690196, 0.878431, 0.901961, 1)``
Powder blue color.
.. _class_Color_constant_PURPLE:
.. rst-class:: classref-constant
**PURPLE** = ``Color(0.627451, 0.12549, 0.941176, 1)``
Purple color.
.. _class_Color_constant_REBECCA_PURPLE:
.. rst-class:: classref-constant
**REBECCA_PURPLE** = ``Color(0.4, 0.2, 0.6, 1)``
Rebecca purple color.
.. _class_Color_constant_RED:
.. rst-class:: classref-constant
**RED** = ``Color(1, 0, 0, 1)``
Red color.
.. _class_Color_constant_ROSY_BROWN:
.. rst-class:: classref-constant
**ROSY_BROWN** = ``Color(0.737255, 0.560784, 0.560784, 1)``
Rosy brown color.
.. _class_Color_constant_ROYAL_BLUE:
.. rst-class:: classref-constant
**ROYAL_BLUE** = ``Color(0.254902, 0.411765, 0.882353, 1)``
Royal blue color.
.. _class_Color_constant_SADDLE_BROWN:
.. rst-class:: classref-constant
**SADDLE_BROWN** = ``Color(0.545098, 0.270588, 0.0745098, 1)``
Saddle brown color.
.. _class_Color_constant_SALMON:
.. rst-class:: classref-constant
**SALMON** = ``Color(0.980392, 0.501961, 0.447059, 1)``
Salmon color.
.. _class_Color_constant_SANDY_BROWN:
.. rst-class:: classref-constant
**SANDY_BROWN** = ``Color(0.956863, 0.643137, 0.376471, 1)``
Sandy brown color.
.. _class_Color_constant_SEA_GREEN:
.. rst-class:: classref-constant
**SEA_GREEN** = ``Color(0.180392, 0.545098, 0.341176, 1)``
Sea green color.
.. _class_Color_constant_SEASHELL:
.. rst-class:: classref-constant
**SEASHELL** = ``Color(1, 0.960784, 0.933333, 1)``
Seashell color.
.. _class_Color_constant_SIENNA:
.. rst-class:: classref-constant
**SIENNA** = ``Color(0.627451, 0.321569, 0.176471, 1)``
Sienna color.
.. _class_Color_constant_SILVER:
.. rst-class:: classref-constant
**SILVER** = ``Color(0.752941, 0.752941, 0.752941, 1)``
Silver color.
.. _class_Color_constant_SKY_BLUE:
.. rst-class:: classref-constant
**SKY_BLUE** = ``Color(0.529412, 0.807843, 0.921569, 1)``
Sky blue color.
.. _class_Color_constant_SLATE_BLUE:
.. rst-class:: classref-constant
**SLATE_BLUE** = ``Color(0.415686, 0.352941, 0.803922, 1)``
Slate blue color.
.. _class_Color_constant_SLATE_GRAY:
.. rst-class:: classref-constant
**SLATE_GRAY** = ``Color(0.439216, 0.501961, 0.564706, 1)``
Slate gray color.
.. _class_Color_constant_SNOW:
.. rst-class:: classref-constant
**SNOW** = ``Color(1, 0.980392, 0.980392, 1)``
Snow color.
.. _class_Color_constant_SPRING_GREEN:
.. rst-class:: classref-constant
**SPRING_GREEN** = ``Color(0, 1, 0.498039, 1)``
Spring green color.
.. _class_Color_constant_STEEL_BLUE:
.. rst-class:: classref-constant
**STEEL_BLUE** = ``Color(0.27451, 0.509804, 0.705882, 1)``
Steel blue color.
.. _class_Color_constant_TAN:
.. rst-class:: classref-constant
**TAN** = ``Color(0.823529, 0.705882, 0.54902, 1)``
Tan color.
.. _class_Color_constant_TEAL:
.. rst-class:: classref-constant
**TEAL** = ``Color(0, 0.501961, 0.501961, 1)``
Teal color.
.. _class_Color_constant_THISTLE:
.. rst-class:: classref-constant
**THISTLE** = ``Color(0.847059, 0.74902, 0.847059, 1)``
Thistle color.
.. _class_Color_constant_TOMATO:
.. rst-class:: classref-constant
**TOMATO** = ``Color(1, 0.388235, 0.278431, 1)``
Tomato color.
.. _class_Color_constant_TRANSPARENT:
.. rst-class:: classref-constant
**TRANSPARENT** = ``Color(1, 1, 1, 0)``
Transparent color (white with zero alpha).
.. _class_Color_constant_TURQUOISE:
.. rst-class:: classref-constant
**TURQUOISE** = ``Color(0.25098, 0.878431, 0.815686, 1)``
Turquoise color.
.. _class_Color_constant_VIOLET:
.. rst-class:: classref-constant
**VIOLET** = ``Color(0.933333, 0.509804, 0.933333, 1)``
Violet color.
.. _class_Color_constant_WEB_GRAY:
.. rst-class:: classref-constant
**WEB_GRAY** = ``Color(0.501961, 0.501961, 0.501961, 1)``
Web gray color.
.. _class_Color_constant_WEB_GREEN:
.. rst-class:: classref-constant
**WEB_GREEN** = ``Color(0, 0.501961, 0, 1)``
Web green color.
.. _class_Color_constant_WEB_MAROON:
.. rst-class:: classref-constant
**WEB_MAROON** = ``Color(0.501961, 0, 0, 1)``
Web maroon color.
.. _class_Color_constant_WEB_PURPLE:
.. rst-class:: classref-constant
**WEB_PURPLE** = ``Color(0.501961, 0, 0.501961, 1)``
Web purple color.
.. _class_Color_constant_WHEAT:
.. rst-class:: classref-constant
**WHEAT** = ``Color(0.960784, 0.870588, 0.701961, 1)``
Wheat color.
.. _class_Color_constant_WHITE:
.. rst-class:: classref-constant
**WHITE** = ``Color(1, 1, 1, 1)``
White color.
.. _class_Color_constant_WHITE_SMOKE:
.. rst-class:: classref-constant
**WHITE_SMOKE** = ``Color(0.960784, 0.960784, 0.960784, 1)``
White smoke color.
.. _class_Color_constant_YELLOW:
.. rst-class:: classref-constant
**YELLOW** = ``Color(1, 1, 0, 1)``
Yellow color.
.. _class_Color_constant_YELLOW_GREEN:
.. rst-class:: classref-constant
**YELLOW_GREEN** = ``Color(0.603922, 0.803922, 0.196078, 1)``
Yellow green color.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_Color_property_a:
.. rst-class:: classref-property
:ref:`float<class_float>` **a** = ``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.
.. rst-class:: classref-item-separator
----
.. _class_Color_property_a8:
.. rst-class:: classref-property
:ref:`int<class_int>` **a8** = ``255``
Wrapper for :ref:`a<class_Color_property_a>` that uses the range 0 to 255, instead of 0 to 1.
.. rst-class:: classref-item-separator
----
.. _class_Color_property_b:
.. rst-class:: classref-property
:ref:`float<class_float>` **b** = ``0.0``
The color's blue component, typically on the range of 0 to 1.
.. rst-class:: classref-item-separator
----
.. _class_Color_property_b8:
.. rst-class:: classref-property
:ref:`int<class_int>` **b8** = ``0``
Wrapper for :ref:`b<class_Color_property_b>` that uses the range 0 to 255, instead of 0 to 1.
.. rst-class:: classref-item-separator
----
.. _class_Color_property_g:
.. rst-class:: classref-property
:ref:`float<class_float>` **g** = ``0.0``
The color's green component, typically on the range of 0 to 1.
.. rst-class:: classref-item-separator
----
.. _class_Color_property_g8:
.. rst-class:: classref-property
:ref:`int<class_int>` **g8** = ``0``
Wrapper for :ref:`g<class_Color_property_g>` that uses the range 0 to 255, instead of 0 to 1.
.. rst-class:: classref-item-separator
----
.. _class_Color_property_h:
.. rst-class:: classref-property
:ref:`float<class_float>` **h** = ``0.0``
The HSV hue of this color, on the range 0 to 1.
.. rst-class:: classref-item-separator
----
.. _class_Color_property_r:
.. rst-class:: classref-property
:ref:`float<class_float>` **r** = ``0.0``
The color's red component, typically on the range of 0 to 1.
.. rst-class:: classref-item-separator
----
.. _class_Color_property_r8:
.. rst-class:: classref-property
:ref:`int<class_int>` **r8** = ``0``
Wrapper for :ref:`r<class_Color_property_r>` that uses the range 0 to 255, instead of 0 to 1.
.. rst-class:: classref-item-separator
----
.. _class_Color_property_s:
.. rst-class:: classref-property
:ref:`float<class_float>` **s** = ``0.0``
The HSV saturation of this color, on the range 0 to 1.
.. rst-class:: classref-item-separator
----
.. _class_Color_property_v:
.. rst-class:: classref-property
:ref:`float<class_float>` **v** = ``0.0``
The HSV value (brightness) of this color, on the range 0 to 1.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Constructor Descriptions
------------------------
.. _class_Color_constructor_Color:
.. rst-class:: classref-constructor
:ref:`Color<class_Color>` **Color** **(** **)**
Constructs a default **Color** from opaque black. This is the same as :ref:`BLACK<class_Color_constant_BLACK>`.
\ **Note:** in C#, constructs an empty color with all of its components set to ``0.0`` (transparent black).
.. rst-class:: classref-item-separator
----
.. rst-class:: classref-constructor
:ref:`Color<class_Color>` **Color** **(** :ref:`Color<class_Color>` from, :ref:`float<class_float>` alpha **)**
Constructs a **Color** from the existing color, with :ref:`a<class_Color_property_a>` set to the given ``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.
.. rst-class:: classref-item-separator
----
.. rst-class:: classref-constructor
:ref:`Color<class_Color>` **Color** **(** :ref:`Color<class_Color>` from **)**
Constructs a **Color** as a copy of the given **Color**.
.. rst-class:: classref-item-separator
----
.. rst-class:: classref-constructor
: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. The supported color names are the same as the constants.
.. rst-class:: classref-item-separator
----
.. rst-class:: classref-constructor
: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.0 to 1.0. The supported color names are the same as the constants.
.. rst-class:: classref-item-separator
----
.. rst-class:: classref-constructor
: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.0 and 1.0. :ref:`a<class_Color_property_a>` is set to 1.0.
.. 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)`
.. rst-class:: classref-item-separator
----
.. rst-class:: classref-constructor
: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.0 and 1.0.
.. 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)`
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Method Descriptions
-------------------
.. _class_Color_method_blend:
.. rst-class:: classref-method
:ref:`Color<class_Color>` **blend** **(** :ref:`Color<class_Color>` over **)** |const|
Returns a new color resulting from overlaying this color over the given color. In a painting program, you can imagine it as the ``over`` color painted over this color (including alpha).
.. 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%
.. rst-class:: classref-item-separator
----
.. _class_Color_method_clamp:
.. rst-class:: classref-method
: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.
.. rst-class:: classref-item-separator
----
.. _class_Color_method_darkened:
.. rst-class:: classref-method
:ref:`Color<class_Color>` **darkened** **(** :ref:`float<class_float>` amount **)** |const|
Returns a new color resulting from making this color darker by the specified ``amount`` (ratio from 0.0 to 1.0). See also :ref:`lightened<class_Color_method_lightened>`.
.. 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
.. rst-class:: classref-item-separator
----
.. _class_Color_method_from_hsv:
.. rst-class:: classref-method
: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>`__. The hue (``h``), saturation (``s``), and value (``v``) are typically between 0.0 and 1.0.
.. 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);
.. rst-class:: classref-item-separator
----
.. _class_Color_method_from_ok_hsl:
.. rst-class:: classref-method
: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/>`__. The hue (``h``), saturation (``s``), and lightness (``l``) are typically between 0.0 and 1.0.
.. 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);
.. rst-class:: classref-item-separator
----
.. _class_Color_method_from_rgbe9995:
.. rst-class:: classref-method
:ref:`Color<class_Color>` **from_rgbe9995** **(** :ref:`int<class_int>` rgbe **)** |static|
Decodes a **Color** from a RGBE9995 format integer. See :ref:`Image.FORMAT_RGBE9995<class_Image_constant_FORMAT_RGBE9995>`.
.. rst-class:: classref-item-separator
----
.. _class_Color_method_from_string:
.. rst-class:: classref-method
:ref:`Color<class_Color>` **from_string** **(** :ref:`String<class_String>` str, :ref:`Color<class_Color>` default **)** |static|
Creates a **Color** from the given string, which can be either an HTML color code or a named color (case-insensitive). Returns ``default`` if the color cannot be inferred from the string.
.. rst-class:: classref-item-separator
----
.. _class_Color_method_get_luminance:
.. rst-class:: classref-method
:ref:`float<class_float>` **get_luminance** **(** **)** |const|
Returns the light intensity of the color, as a value between 0.0 and 1.0 (inclusive). 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 color 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.
.. rst-class:: classref-item-separator
----
.. _class_Color_method_hex:
.. rst-class:: classref-method
:ref:`Color<class_Color>` **hex** **(** :ref:`int<class_int>` hex **)** |static|
Returns the **Color** associated with the provided ``hex`` integer in 32-bit RGBA format (8 bits per channel).
In GDScript and C#, the :ref:`int<class_int>` is best visualized with hexadecimal notation (``"0x"`` prefix, making it ``"0xRRGGBBAA"``).
.. tabs::
.. code-tab:: gdscript
var red = Color.hex(0xff0000ff)
var dark_cyan = Color.hex(0x008b8bff)
var my_color = Color.hex(0xbbefd2a4)
.. code-tab:: csharp
var red = new Color(0xff0000ff);
var dark_cyan = new Color(0x008b8bff);
var my_color = new Color(0xbbefd2a4);
.. rst-class:: classref-item-separator
----
.. _class_Color_method_hex64:
.. rst-class:: classref-method
:ref:`Color<class_Color>` **hex64** **(** :ref:`int<class_int>` hex **)** |static|
Returns the **Color** associated with the provided ``hex`` integer in 64-bit RGBA format (16 bits per channel).
In GDScript and C#, the :ref:`int<class_int>` is best visualized with hexadecimal notation (``"0x"`` prefix, making it ``"0xRRRRGGGGBBBBAAAA"``).
.. rst-class:: classref-item-separator
----
.. _class_Color_method_html:
.. rst-class:: classref-method
: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 by a hash sign (``#``).
\ ``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, returns an empty color.
.. tabs::
.. code-tab:: gdscript
var blue = Color.html("#0000ff") # blue is Color(0.0, 0.0, 1.0, 1.0)
var green = Color.html("#0F0") # green is Color(0.0, 1.0, 0.0, 1.0)
var col = Color.html("663399cc") # col is Color(0.4, 0.2, 0.6, 0.8)
.. code-tab:: csharp
var blue = Color.FromHtml("#0000ff"); // blue is Color(0.0, 0.0, 1.0, 1.0)
var green = Color.FromHtml("#0F0"); // green is Color(0.0, 1.0, 0.0, 1.0)
var col = Color.FromHtml("663399cc"); // col is Color(0.4, 0.2, 0.6, 0.8)
.. rst-class:: classref-item-separator
----
.. _class_Color_method_html_is_valid:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **html_is_valid** **(** :ref:`String<class_String>` color **)** |static|
Returns ``true`` if ``color`` is a valid HTML hexadecimal color string. The string must be a hexadecimal value (case-insensitive) of either 3, 4, 6 or 8 digits, and may be prefixed by a hash sign (``#``). This method is identical to :ref:`String.is_valid_html_color<class_String_method_is_valid_html_color>`.
.. tabs::
.. code-tab:: gdscript
Color.html_is_valid("#55aaFF") # Returns true
Color.html_is_valid("#55AAFF20") # Returns true
Color.html_is_valid("55AAFF") # Returns true
Color.html_is_valid("#F2C") # Returns true
Color.html_is_valid("#AABBC") # Returns false
Color.html_is_valid("#55aaFF5") # Returns false
.. code-tab:: csharp
Color.HtmlIsValid("#55AAFF"); // Returns true
Color.HtmlIsValid("#55AAFF20"); // Returns true
Color.HtmlIsValid("55AAFF"); // Returns true
Color.HtmlIsValid("#F2C"); // Returns true
Color.HtmlIsValid("#AABBC"); // Returns false
Color.HtmlIsValid("#55aaFF5"); // Returns false
.. rst-class:: classref-item-separator
----
.. _class_Color_method_inverted:
.. rst-class:: classref-method
:ref:`Color<class_Color>` **inverted** **(** **)** |const|
Returns the color with its :ref:`r<class_Color_property_r>`, :ref:`g<class_Color_property_g>`, and :ref:`b<class_Color_property_b>` components inverted (``(1 - r, 1 - g, 1 - b, a)``).
.. tabs::
.. code-tab:: gdscript
var black = Color.WHITE.inverted()
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 black = Colors.White.Inverted();
var color = new Color(0.3f, 0.4f, 0.9f);
Color invertedColor = color.Inverted(); // Equivalent to `new Color(0.7f, 0.6f, 0.1f)`
.. rst-class:: classref-item-separator
----
.. _class_Color_method_is_equal_approx:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_equal_approx** **(** :ref:`Color<class_Color>` to **)** |const|
Returns ``true`` if this color and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx<class_@GlobalScope_method_is_equal_approx>` on each component.
.. rst-class:: classref-item-separator
----
.. _class_Color_method_lerp:
.. rst-class:: classref-method
:ref:`Color<class_Color>` **lerp** **(** :ref:`Color<class_Color>` to, :ref:`float<class_float>` weight **)** |const|
Returns the linear interpolation between this color's components and ``to``'s components. The interpolation factor ``weight`` should be between 0.0 and 1.0 (inclusive). See also :ref:`@GlobalScope.lerp<class_@GlobalScope_method_lerp>`.
.. tabs::
.. code-tab:: gdscript
var red = Color(1.0, 0.0, 0.0)
var aqua = Color(0.0, 1.0, 0.8)
red.lerp(aqua, 0.2) # Returns Color(0.8, 0.2, 0.16)
red.lerp(aqua, 0.5) # Returns Color(0.5, 0.5, 0.4)
red.lerp(aqua, 1.0) # Returns Color(0.0, 1.0, 0.8)
.. code-tab:: csharp
var red = new Color(1.0f, 0.0f, 0.0f);
var aqua = new Color(0.0f, 1.0f, 0.8f);
red.Lerp(aqua, 0.2f); // Returns Color(0.8f, 0.2f, 0.16f)
red.Lerp(aqua, 0.5f); // Returns Color(0.5f, 0.5f, 0.4f)
red.Lerp(aqua, 1.0f); // Returns Color(0.0f, 1.0f, 0.8f)
.. rst-class:: classref-item-separator
----
.. _class_Color_method_lightened:
.. rst-class:: classref-method
:ref:`Color<class_Color>` **lightened** **(** :ref:`float<class_float>` amount **)** |const|
Returns a new color resulting from making this color lighter by the specified ``amount``, which should be a ratio from 0.0 to 1.0. See also :ref:`darkened<class_Color_method_darkened>`.
.. tabs::
.. code-tab:: gdscript
var green = Color(0.0, 1.0, 0.0)
var light_green = 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
.. rst-class:: classref-item-separator
----
.. _class_Color_method_linear_to_srgb:
.. rst-class:: classref-method
:ref:`Color<class_Color>` **linear_to_srgb** **(** **)** |const|
Returns the color converted to the `sRGB <https://en.wikipedia.org/wiki/SRGB>`__ color space. This method 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.
.. rst-class:: classref-item-separator
----
.. _class_Color_method_srgb_to_linear:
.. rst-class:: classref-method
:ref:`Color<class_Color>` **srgb_to_linear** **(** **)** |const|
Returns the color converted to the linear color space. This method assumes the original color already is in the sRGB color space. See also :ref:`linear_to_srgb<class_Color_method_linear_to_srgb>` which performs the opposite operation.
.. rst-class:: classref-item-separator
----
.. _class_Color_method_to_abgr32:
.. rst-class:: classref-method
:ref:`int<class_int>` **to_abgr32** **(** **)** |const|
Returns the color converted to a 32-bit integer in ABGR format (each component is 8 bits). ABGR is the reversed version of the default RGBA 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
.. rst-class:: classref-item-separator
----
.. _class_Color_method_to_abgr64:
.. rst-class:: classref-method
:ref:`int<class_int>` **to_abgr64** **(** **)** |const|
Returns the color converted to a 64-bit integer in ABGR format (each component is 16 bits). ABGR is the reversed version of the default RGBA 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
.. rst-class:: classref-item-separator
----
.. _class_Color_method_to_argb32:
.. rst-class:: classref-method
:ref:`int<class_int>` **to_argb32** **(** **)** |const|
Returns the color converted to a 32-bit integer in ARGB format (each component is 8 bits). 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
.. rst-class:: classref-item-separator
----
.. _class_Color_method_to_argb64:
.. rst-class:: classref-method
:ref:`int<class_int>` **to_argb64** **(** **)** |const|
Returns the color converted to a 64-bit integer in ARGB format (each component is 16 bits). 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
.. rst-class:: classref-item-separator
----
.. _class_Color_method_to_html:
.. rst-class:: classref-method
:ref:`String<class_String>` **to_html** **(** :ref:`bool<class_bool>` with_alpha=true **)** |const|
Returns the color converted to an HTML hexadecimal color :ref:`String<class_String>` in RGBA format, without the hash (``#``) prefix.
Setting ``with_alpha`` to ``false``, excludes alpha from the hexadecimal string, using RGB format instead of RGBA format.
.. tabs::
.. code-tab:: gdscript
var white = Color(1, 1, 1, 0.5)
var with_alpha = white.to_html() # Returns "ffffff7f"
var without_alpha = white.to_html(false) # Returns "ffffff"
.. code-tab:: csharp
var white = new Color(1, 1, 1, 0.5f);
string withAlpha = white.ToHtml(); // Returns "ffffff7f"
string withoutAlpha = white.ToHtml(false); // Returns "ffffff"
.. rst-class:: classref-item-separator
----
.. _class_Color_method_to_rgba32:
.. rst-class:: classref-method
:ref:`int<class_int>` **to_rgba32** **(** **)** |const|
Returns the color converted to a 32-bit integer in RGBA format (each component is 8 bits). 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
.. rst-class:: classref-item-separator
----
.. _class_Color_method_to_rgba64:
.. rst-class:: classref-method
:ref:`int<class_int>` **to_rgba64** **(** **)** |const|
Returns the color converted to a 64-bit integer in RGBA format (each component is 16 bits). 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
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Operator Descriptions
---------------------
.. _class_Color_operator_neq_Color:
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator !=** **(** :ref:`Color<class_Color>` right **)**
Returns ``true`` if the colors are not 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.
.. rst-class:: classref-item-separator
----
.. _class_Color_operator_mul_Color:
.. rst-class:: classref-operator
:ref:`Color<class_Color>` **operator *** **(** :ref:`Color<class_Color>` right **)**
Multiplies each component of the **Color** by the components of the given **Color**.
.. rst-class:: classref-item-separator
----
.. _class_Color_operator_mul_float:
.. rst-class:: classref-operator
:ref:`Color<class_Color>` **operator *** **(** :ref:`float<class_float>` right **)**
Multiplies each component of the **Color** by the given :ref:`float<class_float>`.
.. rst-class:: classref-item-separator
----
.. _class_Color_operator_mul_int:
.. rst-class:: classref-operator
:ref:`Color<class_Color>` **operator *** **(** :ref:`int<class_int>` right **)**
Multiplies each component of the **Color** by the given :ref:`int<class_int>`.
.. rst-class:: classref-item-separator
----
.. _class_Color_operator_sum_Color:
.. rst-class:: classref-operator
:ref:`Color<class_Color>` **operator +** **(** :ref:`Color<class_Color>` right **)**
Adds each component of the **Color** with the components of the given **Color**.
.. rst-class:: classref-item-separator
----
.. _class_Color_operator_dif_Color:
.. rst-class:: classref-operator
:ref:`Color<class_Color>` **operator -** **(** :ref:`Color<class_Color>` right **)**
Subtracts each component of the **Color** by the components of the given **Color**.
.. rst-class:: classref-item-separator
----
.. _class_Color_operator_div_Color:
.. rst-class:: classref-operator
:ref:`Color<class_Color>` **operator /** **(** :ref:`Color<class_Color>` right **)**
Divides each component of the **Color** by the components of the given **Color**.
.. rst-class:: classref-item-separator
----
.. _class_Color_operator_div_float:
.. rst-class:: classref-operator
:ref:`Color<class_Color>` **operator /** **(** :ref:`float<class_float>` right **)**
Divides each component of the **Color** by the given :ref:`float<class_float>`.
.. rst-class:: classref-item-separator
----
.. _class_Color_operator_div_int:
.. rst-class:: classref-operator
:ref:`Color<class_Color>` **operator /** **(** :ref:`int<class_int>` right **)**
Divides each component of the **Color** by the given :ref:`int<class_int>`.
.. rst-class:: classref-item-separator
----
.. _class_Color_operator_eq_Color:
.. rst-class:: classref-operator
: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.
.. rst-class:: classref-item-separator
----
.. _class_Color_operator_idx_int:
.. rst-class:: classref-operator
:ref:`float<class_float>` **operator []** **(** :ref:`int<class_int>` index **)**
Access color components using their index. ``[0]`` is equivalent to :ref:`r<class_Color_property_r>`, ``[1]`` is equivalent to :ref:`g<class_Color_property_g>`, ``[2]`` is equivalent to :ref:`b<class_Color_property_b>`, and ``[3]`` is equivalent to :ref:`a<class_Color_property_a>`.
.. rst-class:: classref-item-separator
----
.. _class_Color_operator_unplus:
.. rst-class:: classref-operator
: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.
.. rst-class:: classref-item-separator
----
.. _class_Color_operator_unminus:
.. rst-class:: classref-operator
: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)``. Unlike with :ref:`inverted<class_Color_method_inverted>`, the :ref:`a<class_Color_property_a>` component is inverted, too.
.. |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.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
Reference in New Issue View Git Blame Copy Permalink