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
3.3
godot-docs/classes/class_color.rst
Rémi Verschelde bdcc5caf17 classref: Sync with current 3.3 branch
2021-08-03 10:43:59 +02:00

1087 lines
37 KiB
ReStructuredText
Raw Permalink Blame History

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Color.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _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 transparency. 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 :ref:`@GDScript.ColorN<class_@GDScript_method_ColorN>` 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`` |
+---------------------------+------------------------------------+---------+
Methods
-------
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`String<class_String>` from **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`int<class_int>` from **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`blend<class_Color_method_blend>` **(** :ref:`Color<class_Color>` over **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`contrasted<class_Color_method_contrasted>` **(** **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`darkened<class_Color_method_darkened>` **(** :ref:`float<class_float>` amount **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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>` a=1.0 **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`gray<class_Color_method_gray>` **(** **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`inverted<class_Color_method_inverted>` **(** **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_equal_approx<class_Color_method_is_equal_approx>` **(** :ref:`Color<class_Color>` color **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`lightened<class_Color_method_lightened>` **(** :ref:`float<class_float>` amount **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`linear_interpolate<class_Color_method_linear_interpolate>` **(** :ref:`Color<class_Color>` to, :ref:`float<class_float>` weight **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`to_abgr32<class_Color_method_to_abgr32>` **(** **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`to_abgr64<class_Color_method_to_abgr64>` **(** **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`to_argb32<class_Color_method_to_argb32>` **(** **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`to_argb64<class_Color_method_to_argb64>` **(** **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`to_html<class_Color_method_to_html>` **(** :ref:`bool<class_bool>` with_alpha=true **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`to_rgba32<class_Color_method_to_rgba32>` **(** **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`to_rgba64<class_Color_method_to_rgba64>` **(** **)** |
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Constants
---------
.. _class_Color_constant_aliceblue:
.. _class_Color_constant_antiquewhite:
.. _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_blanchedalmond:
.. _class_Color_constant_blue:
.. _class_Color_constant_blueviolet:
.. _class_Color_constant_brown:
.. _class_Color_constant_burlywood:
.. _class_Color_constant_cadetblue:
.. _class_Color_constant_chartreuse:
.. _class_Color_constant_chocolate:
.. _class_Color_constant_coral:
.. _class_Color_constant_cornflower:
.. _class_Color_constant_cornsilk:
.. _class_Color_constant_crimson:
.. _class_Color_constant_cyan:
.. _class_Color_constant_darkblue:
.. _class_Color_constant_darkcyan:
.. _class_Color_constant_darkgoldenrod:
.. _class_Color_constant_darkgray:
.. _class_Color_constant_darkgreen:
.. _class_Color_constant_darkkhaki:
.. _class_Color_constant_darkmagenta:
.. _class_Color_constant_darkolivegreen:
.. _class_Color_constant_darkorange:
.. _class_Color_constant_darkorchid:
.. _class_Color_constant_darkred:
.. _class_Color_constant_darksalmon:
.. _class_Color_constant_darkseagreen:
.. _class_Color_constant_darkslateblue:
.. _class_Color_constant_darkslategray:
.. _class_Color_constant_darkturquoise:
.. _class_Color_constant_darkviolet:
.. _class_Color_constant_deeppink:
.. _class_Color_constant_deepskyblue:
.. _class_Color_constant_dimgray:
.. _class_Color_constant_dodgerblue:
.. _class_Color_constant_firebrick:
.. _class_Color_constant_floralwhite:
.. _class_Color_constant_forestgreen:
.. _class_Color_constant_fuchsia:
.. _class_Color_constant_gainsboro:
.. _class_Color_constant_ghostwhite:
.. _class_Color_constant_gold:
.. _class_Color_constant_goldenrod:
.. _class_Color_constant_gray:
.. _class_Color_constant_green:
.. _class_Color_constant_greenyellow:
.. _class_Color_constant_honeydew:
.. _class_Color_constant_hotpink:
.. _class_Color_constant_indianred:
.. _class_Color_constant_indigo:
.. _class_Color_constant_ivory:
.. _class_Color_constant_khaki:
.. _class_Color_constant_lavender:
.. _class_Color_constant_lavenderblush:
.. _class_Color_constant_lawngreen:
.. _class_Color_constant_lemonchiffon:
.. _class_Color_constant_lightblue:
.. _class_Color_constant_lightcoral:
.. _class_Color_constant_lightcyan:
.. _class_Color_constant_lightgoldenrod:
.. _class_Color_constant_lightgray:
.. _class_Color_constant_lightgreen:
.. _class_Color_constant_lightpink:
.. _class_Color_constant_lightsalmon:
.. _class_Color_constant_lightseagreen:
.. _class_Color_constant_lightskyblue:
.. _class_Color_constant_lightslategray:
.. _class_Color_constant_lightsteelblue:
.. _class_Color_constant_lightyellow:
.. _class_Color_constant_lime:
.. _class_Color_constant_limegreen:
.. _class_Color_constant_linen:
.. _class_Color_constant_magenta:
.. _class_Color_constant_maroon:
.. _class_Color_constant_mediumaquamarine:
.. _class_Color_constant_mediumblue:
.. _class_Color_constant_mediumorchid:
.. _class_Color_constant_mediumpurple:
.. _class_Color_constant_mediumseagreen:
.. _class_Color_constant_mediumslateblue:
.. _class_Color_constant_mediumspringgreen:
.. _class_Color_constant_mediumturquoise:
.. _class_Color_constant_mediumvioletred:
.. _class_Color_constant_midnightblue:
.. _class_Color_constant_mintcream:
.. _class_Color_constant_mistyrose:
.. _class_Color_constant_moccasin:
.. _class_Color_constant_navajowhite:
.. _class_Color_constant_navyblue:
.. _class_Color_constant_oldlace:
.. _class_Color_constant_olive:
.. _class_Color_constant_olivedrab:
.. _class_Color_constant_orange:
.. _class_Color_constant_orangered:
.. _class_Color_constant_orchid:
.. _class_Color_constant_palegoldenrod:
.. _class_Color_constant_palegreen:
.. _class_Color_constant_paleturquoise:
.. _class_Color_constant_palevioletred:
.. _class_Color_constant_papayawhip:
.. _class_Color_constant_peachpuff:
.. _class_Color_constant_peru:
.. _class_Color_constant_pink:
.. _class_Color_constant_plum:
.. _class_Color_constant_powderblue:
.. _class_Color_constant_purple:
.. _class_Color_constant_rebeccapurple:
.. _class_Color_constant_red:
.. _class_Color_constant_rosybrown:
.. _class_Color_constant_royalblue:
.. _class_Color_constant_saddlebrown:
.. _class_Color_constant_salmon:
.. _class_Color_constant_sandybrown:
.. _class_Color_constant_seagreen:
.. _class_Color_constant_seashell:
.. _class_Color_constant_sienna:
.. _class_Color_constant_silver:
.. _class_Color_constant_skyblue:
.. _class_Color_constant_slateblue:
.. _class_Color_constant_slategray:
.. _class_Color_constant_snow:
.. _class_Color_constant_springgreen:
.. _class_Color_constant_steelblue:
.. _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_webgray:
.. _class_Color_constant_webgreen:
.. _class_Color_constant_webmaroon:
.. _class_Color_constant_webpurple:
.. _class_Color_constant_wheat:
.. _class_Color_constant_white:
.. _class_Color_constant_whitesmoke:
.. _class_Color_constant_yellow:
.. _class_Color_constant_yellowgreen:
- **aliceblue** = **Color( 0.94, 0.97, 1, 1 )** --- Alice blue color.
- **antiquewhite** = **Color( 0.98, 0.92, 0.84, 1 )** --- Antique white color.
- **aqua** = **Color( 0, 1, 1, 1 )** --- Aqua color.
- **aquamarine** = **Color( 0.5, 1, 0.83, 1 )** --- Aquamarine color.
- **azure** = **Color( 0.94, 1, 1, 1 )** --- Azure color.
- **beige** = **Color( 0.96, 0.96, 0.86, 1 )** --- Beige color.
- **bisque** = **Color( 1, 0.89, 0.77, 1 )** --- Bisque color.
- **black** = **Color( 0, 0, 0, 1 )** --- Black color.
- **blanchedalmond** = **Color( 1, 0.92, 0.8, 1 )** --- Blanche almond color.
- **blue** = **Color( 0, 0, 1, 1 )** --- Blue color.
- **blueviolet** = **Color( 0.54, 0.17, 0.89, 1 )** --- Blue violet color.
- **brown** = **Color( 0.65, 0.16, 0.16, 1 )** --- Brown color.
- **burlywood** = **Color( 0.87, 0.72, 0.53, 1 )** --- Burly wood color.
- **cadetblue** = **Color( 0.37, 0.62, 0.63, 1 )** --- Cadet blue color.
- **chartreuse** = **Color( 0.5, 1, 0, 1 )** --- Chartreuse color.
- **chocolate** = **Color( 0.82, 0.41, 0.12, 1 )** --- Chocolate color.
- **coral** = **Color( 1, 0.5, 0.31, 1 )** --- Coral color.
- **cornflower** = **Color( 0.39, 0.58, 0.93, 1 )** --- Cornflower color.
- **cornsilk** = **Color( 1, 0.97, 0.86, 1 )** --- Corn silk color.
- **crimson** = **Color( 0.86, 0.08, 0.24, 1 )** --- Crimson color.
- **cyan** = **Color( 0, 1, 1, 1 )** --- Cyan color.
- **darkblue** = **Color( 0, 0, 0.55, 1 )** --- Dark blue color.
- **darkcyan** = **Color( 0, 0.55, 0.55, 1 )** --- Dark cyan color.
- **darkgoldenrod** = **Color( 0.72, 0.53, 0.04, 1 )** --- Dark goldenrod color.
- **darkgray** = **Color( 0.66, 0.66, 0.66, 1 )** --- Dark gray color.
- **darkgreen** = **Color( 0, 0.39, 0, 1 )** --- Dark green color.
- **darkkhaki** = **Color( 0.74, 0.72, 0.42, 1 )** --- Dark khaki color.
- **darkmagenta** = **Color( 0.55, 0, 0.55, 1 )** --- Dark magenta color.
- **darkolivegreen** = **Color( 0.33, 0.42, 0.18, 1 )** --- Dark olive green color.
- **darkorange** = **Color( 1, 0.55, 0, 1 )** --- Dark orange color.
- **darkorchid** = **Color( 0.6, 0.2, 0.8, 1 )** --- Dark orchid color.
- **darkred** = **Color( 0.55, 0, 0, 1 )** --- Dark red color.
- **darksalmon** = **Color( 0.91, 0.59, 0.48, 1 )** --- Dark salmon color.
- **darkseagreen** = **Color( 0.56, 0.74, 0.56, 1 )** --- Dark sea green color.
- **darkslateblue** = **Color( 0.28, 0.24, 0.55, 1 )** --- Dark slate blue color.
- **darkslategray** = **Color( 0.18, 0.31, 0.31, 1 )** --- Dark slate gray color.
- **darkturquoise** = **Color( 0, 0.81, 0.82, 1 )** --- Dark turquoise color.
- **darkviolet** = **Color( 0.58, 0, 0.83, 1 )** --- Dark violet color.
- **deeppink** = **Color( 1, 0.08, 0.58, 1 )** --- Deep pink color.
- **deepskyblue** = **Color( 0, 0.75, 1, 1 )** --- Deep sky blue color.
- **dimgray** = **Color( 0.41, 0.41, 0.41, 1 )** --- Dim gray color.
- **dodgerblue** = **Color( 0.12, 0.56, 1, 1 )** --- Dodger blue color.
- **firebrick** = **Color( 0.7, 0.13, 0.13, 1 )** --- Firebrick color.
- **floralwhite** = **Color( 1, 0.98, 0.94, 1 )** --- Floral white color.
- **forestgreen** = **Color( 0.13, 0.55, 0.13, 1 )** --- Forest green color.
- **fuchsia** = **Color( 1, 0, 1, 1 )** --- Fuchsia color.
- **gainsboro** = **Color( 0.86, 0.86, 0.86, 1 )** --- Gainsboro color.
- **ghostwhite** = **Color( 0.97, 0.97, 1, 1 )** --- Ghost white color.
- **gold** = **Color( 1, 0.84, 0, 1 )** --- Gold color.
- **goldenrod** = **Color( 0.85, 0.65, 0.13, 1 )** --- Goldenrod color.
- **gray** = **Color( 0.75, 0.75, 0.75, 1 )** --- Gray color.
- **green** = **Color( 0, 1, 0, 1 )** --- Green color.
- **greenyellow** = **Color( 0.68, 1, 0.18, 1 )** --- Green yellow color.
- **honeydew** = **Color( 0.94, 1, 0.94, 1 )** --- Honeydew color.
- **hotpink** = **Color( 1, 0.41, 0.71, 1 )** --- Hot pink color.
- **indianred** = **Color( 0.8, 0.36, 0.36, 1 )** --- Indian red color.
- **indigo** = **Color( 0.29, 0, 0.51, 1 )** --- Indigo color.
- **ivory** = **Color( 1, 1, 0.94, 1 )** --- Ivory color.
- **khaki** = **Color( 0.94, 0.9, 0.55, 1 )** --- Khaki color.
- **lavender** = **Color( 0.9, 0.9, 0.98, 1 )** --- Lavender color.
- **lavenderblush** = **Color( 1, 0.94, 0.96, 1 )** --- Lavender blush color.
- **lawngreen** = **Color( 0.49, 0.99, 0, 1 )** --- Lawn green color.
- **lemonchiffon** = **Color( 1, 0.98, 0.8, 1 )** --- Lemon chiffon color.
- **lightblue** = **Color( 0.68, 0.85, 0.9, 1 )** --- Light blue color.
- **lightcoral** = **Color( 0.94, 0.5, 0.5, 1 )** --- Light coral color.
- **lightcyan** = **Color( 0.88, 1, 1, 1 )** --- Light cyan color.
- **lightgoldenrod** = **Color( 0.98, 0.98, 0.82, 1 )** --- Light goldenrod color.
- **lightgray** = **Color( 0.83, 0.83, 0.83, 1 )** --- Light gray color.
- **lightgreen** = **Color( 0.56, 0.93, 0.56, 1 )** --- Light green color.
- **lightpink** = **Color( 1, 0.71, 0.76, 1 )** --- Light pink color.
- **lightsalmon** = **Color( 1, 0.63, 0.48, 1 )** --- Light salmon color.
- **lightseagreen** = **Color( 0.13, 0.7, 0.67, 1 )** --- Light sea green color.
- **lightskyblue** = **Color( 0.53, 0.81, 0.98, 1 )** --- Light sky blue color.
- **lightslategray** = **Color( 0.47, 0.53, 0.6, 1 )** --- Light slate gray color.
- **lightsteelblue** = **Color( 0.69, 0.77, 0.87, 1 )** --- Light steel blue color.
- **lightyellow** = **Color( 1, 1, 0.88, 1 )** --- Light yellow color.
- **lime** = **Color( 0, 1, 0, 1 )** --- Lime color.
- **limegreen** = **Color( 0.2, 0.8, 0.2, 1 )** --- Lime green color.
- **linen** = **Color( 0.98, 0.94, 0.9, 1 )** --- Linen color.
- **magenta** = **Color( 1, 0, 1, 1 )** --- Magenta color.
- **maroon** = **Color( 0.69, 0.19, 0.38, 1 )** --- Maroon color.
- **mediumaquamarine** = **Color( 0.4, 0.8, 0.67, 1 )** --- Medium aquamarine color.
- **mediumblue** = **Color( 0, 0, 0.8, 1 )** --- Medium blue color.
- **mediumorchid** = **Color( 0.73, 0.33, 0.83, 1 )** --- Medium orchid color.
- **mediumpurple** = **Color( 0.58, 0.44, 0.86, 1 )** --- Medium purple color.
- **mediumseagreen** = **Color( 0.24, 0.7, 0.44, 1 )** --- Medium sea green color.
- **mediumslateblue** = **Color( 0.48, 0.41, 0.93, 1 )** --- Medium slate blue color.
- **mediumspringgreen** = **Color( 0, 0.98, 0.6, 1 )** --- Medium spring green color.
- **mediumturquoise** = **Color( 0.28, 0.82, 0.8, 1 )** --- Medium turquoise color.
- **mediumvioletred** = **Color( 0.78, 0.08, 0.52, 1 )** --- Medium violet red color.
- **midnightblue** = **Color( 0.1, 0.1, 0.44, 1 )** --- Midnight blue color.
- **mintcream** = **Color( 0.96, 1, 0.98, 1 )** --- Mint cream color.
- **mistyrose** = **Color( 1, 0.89, 0.88, 1 )** --- Misty rose color.
- **moccasin** = **Color( 1, 0.89, 0.71, 1 )** --- Moccasin color.
- **navajowhite** = **Color( 1, 0.87, 0.68, 1 )** --- Navajo white color.
- **navyblue** = **Color( 0, 0, 0.5, 1 )** --- Navy blue color.
- **oldlace** = **Color( 0.99, 0.96, 0.9, 1 )** --- Old lace color.
- **olive** = **Color( 0.5, 0.5, 0, 1 )** --- Olive color.
- **olivedrab** = **Color( 0.42, 0.56, 0.14, 1 )** --- Olive drab color.
- **orange** = **Color( 1, 0.65, 0, 1 )** --- Orange color.
- **orangered** = **Color( 1, 0.27, 0, 1 )** --- Orange red color.
- **orchid** = **Color( 0.85, 0.44, 0.84, 1 )** --- Orchid color.
- **palegoldenrod** = **Color( 0.93, 0.91, 0.67, 1 )** --- Pale goldenrod color.
- **palegreen** = **Color( 0.6, 0.98, 0.6, 1 )** --- Pale green color.
- **paleturquoise** = **Color( 0.69, 0.93, 0.93, 1 )** --- Pale turquoise color.
- **palevioletred** = **Color( 0.86, 0.44, 0.58, 1 )** --- Pale violet red color.
- **papayawhip** = **Color( 1, 0.94, 0.84, 1 )** --- Papaya whip color.
- **peachpuff** = **Color( 1, 0.85, 0.73, 1 )** --- Peach puff color.
- **peru** = **Color( 0.8, 0.52, 0.25, 1 )** --- Peru color.
- **pink** = **Color( 1, 0.75, 0.8, 1 )** --- Pink color.
- **plum** = **Color( 0.87, 0.63, 0.87, 1 )** --- Plum color.
- **powderblue** = **Color( 0.69, 0.88, 0.9, 1 )** --- Powder blue color.
- **purple** = **Color( 0.63, 0.13, 0.94, 1 )** --- Purple color.
- **rebeccapurple** = **Color( 0.4, 0.2, 0.6, 1 )** --- Rebecca purple color.
- **red** = **Color( 1, 0, 0, 1 )** --- Red color.
- **rosybrown** = **Color( 0.74, 0.56, 0.56, 1 )** --- Rosy brown color.
- **royalblue** = **Color( 0.25, 0.41, 0.88, 1 )** --- Royal blue color.
- **saddlebrown** = **Color( 0.55, 0.27, 0.07, 1 )** --- Saddle brown color.
- **salmon** = **Color( 0.98, 0.5, 0.45, 1 )** --- Salmon color.
- **sandybrown** = **Color( 0.96, 0.64, 0.38, 1 )** --- Sandy brown color.
- **seagreen** = **Color( 0.18, 0.55, 0.34, 1 )** --- Sea green color.
- **seashell** = **Color( 1, 0.96, 0.93, 1 )** --- Seashell color.
- **sienna** = **Color( 0.63, 0.32, 0.18, 1 )** --- Sienna color.
- **silver** = **Color( 0.75, 0.75, 0.75, 1 )** --- Silver color.
- **skyblue** = **Color( 0.53, 0.81, 0.92, 1 )** --- Sky blue color.
- **slateblue** = **Color( 0.42, 0.35, 0.8, 1 )** --- Slate blue color.
- **slategray** = **Color( 0.44, 0.5, 0.56, 1 )** --- Slate gray color.
- **snow** = **Color( 1, 0.98, 0.98, 1 )** --- Snow color.
- **springgreen** = **Color( 0, 1, 0.5, 1 )** --- Spring green color.
- **steelblue** = **Color( 0.27, 0.51, 0.71, 1 )** --- Steel blue color.
- **tan** = **Color( 0.82, 0.71, 0.55, 1 )** --- Tan color.
- **teal** = **Color( 0, 0.5, 0.5, 1 )** --- Teal color.
- **thistle** = **Color( 0.85, 0.75, 0.85, 1 )** --- Thistle color.
- **tomato** = **Color( 1, 0.39, 0.28, 1 )** --- Tomato color.
- **transparent** = **Color( 1, 1, 1, 0 )** --- Transparent color (white with no alpha).
- **turquoise** = **Color( 0.25, 0.88, 0.82, 1 )** --- Turquoise color.
- **violet** = **Color( 0.93, 0.51, 0.93, 1 )** --- Violet color.
- **webgray** = **Color( 0.5, 0.5, 0.5, 1 )** --- Web gray color.
- **webgreen** = **Color( 0, 0.5, 0, 1 )** --- Web green color.
- **webmaroon** = **Color( 0.5, 0, 0, 1 )** --- Web maroon color.
- **webpurple** = **Color( 0.5, 0, 0.5, 1 )** --- Web purple color.
- **wheat** = **Color( 0.96, 0.87, 0.7, 1 )** --- Wheat color.
- **white** = **Color( 1, 1, 1, 1 )** --- White color.
- **whitesmoke** = **Color( 0.96, 0.96, 0.96, 1 )** --- White smoke color.
- **yellow** = **Color( 1, 1, 0, 1 )** --- Yellow color.
- **yellowgreen** = **Color( 0.6, 0.8, 0.2, 1 )** --- Yellow green color.
Property Descriptions
---------------------
.. _class_Color_property_a:
- :ref:`float<class_float>` **a**
+-----------+---------+
| *Default* | ``1.0`` |
+-----------+---------+
The color's alpha (transparency) component, typically on the range of 0 to 1.
----
.. _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.
Method Descriptions
-------------------
.. _class_Color_method_Color:
- :ref:`Color<class_Color>` **Color** **(** :ref:`String<class_String>` from **)**
Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also :ref:`@GDScript.ColorN<class_@GDScript_method_ColorN>`.
::
# Each of the following creates the same color RGBA(178, 217, 10, 255).
var c1 = Color("#ffb2d90a") # ARGB format with "#".
var c2 = Color("ffb2d90a") # ARGB format.
var c3 = Color("#b2d90a") # RGB format with "#".
var c4 = Color("b2d90a") # RGB format.
----
- :ref:`Color<class_Color>` **Color** **(** :ref:`int<class_int>` from **)**
Constructs a color from a 32-bit integer in RGBA format (each byte represents a color channel).
::
var c = Color(274) # Similar to Color(0.0, 0.0, 0.004, 0.07)
----
- :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.
::
var color = Color(0.2, 1.0, 0.7) # Similar to 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.
::
var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to Color8(51, 255, 178, 204)
----
.. _class_Color_method_blend:
- :ref:`Color<class_Color>` **blend** **(** :ref:`Color<class_Color>` over **)**
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.
::
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%
----
.. _class_Color_method_contrasted:
- :ref:`Color<class_Color>` **contrasted** **(** **)**
Returns the most contrasting color.
::
var c = Color(0.3, 0.4, 0.9)
var contrasted_color = c.contrasted() # Equivalent to RGBA(204, 229, 102, 255)
----
.. _class_Color_method_darkened:
- :ref:`Color<class_Color>` **darkened** **(** :ref:`float<class_float>` amount **)**
Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1).
::
var green = Color(0.0, 1.0, 0.0)
var darkgreen = green.darkened(0.2) # 20% darker than regular green
----
.. _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>` a=1.0 **)**
Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values between 0 and 1.
::
var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8) # Equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8)
----
.. _class_Color_method_gray:
- :ref:`float<class_float>` **gray** **(** **)**
Returns the color's grayscale representation.
The gray value is calculated as ``(r + g + b) / 3``.
::
var c = Color(0.2, 0.45, 0.82)
var gray = c.gray() # A value of 0.466667
----
.. _class_Color_method_inverted:
- :ref:`Color<class_Color>` **inverted** **(** **)**
Returns the inverted color ``(1 - r, 1 - g, 1 - b, a)``.
::
var color = Color(0.3, 0.4, 0.9)
var inverted_color = color.inverted() # Equivalent to Color(0.7, 0.6, 0.1)
----
.. _class_Color_method_is_equal_approx:
- :ref:`bool<class_bool>` **is_equal_approx** **(** :ref:`Color<class_Color>` color **)**
Returns ``true`` if this color and ``color`` are approximately equal, by running :ref:`@GDScript.is_equal_approx<class_@GDScript_method_is_equal_approx>` on each component.
----
.. _class_Color_method_lightened:
- :ref:`Color<class_Color>` **lightened** **(** :ref:`float<class_float>` amount **)**
Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1).
::
var green = Color(0.0, 1.0, 0.0)
var lightgreen = green.lightened(0.2) # 20% lighter than regular green
----
.. _class_Color_method_linear_interpolate:
- :ref:`Color<class_Color>` **linear_interpolate** **(** :ref:`Color<class_Color>` to, :ref:`float<class_float>` weight **)**
Returns the linear interpolation with another color. The interpolation factor ``weight`` is between 0 and 1.
::
var c1 = Color(1.0, 0.0, 0.0)
var c2 = Color(0.0, 1.0, 0.0)
var li_c = c1.linear_interpolate(c2, 0.5) # Equivalent to Color(0.5, 0.5, 0.0)
----
.. _class_Color_method_to_abgr32:
- :ref:`int<class_int>` **to_abgr32** **(** **)**
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.
::
var color = Color(1, 0.5, 0.2)
print(color.to_abgr32()) # Prints 4281565439
----
.. _class_Color_method_to_abgr64:
- :ref:`int<class_int>` **to_abgr64** **(** **)**
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.
::
var color = Color(1, 0.5, 0.2)
print(color.to_abgr64()) # Prints -225178692812801
----
.. _class_Color_method_to_argb32:
- :ref:`int<class_int>` **to_argb32** **(** **)**
Returns the color converted to a 32-bit integer in ARGB format (each byte represents a color channel). ARGB is more compatible with DirectX.
::
var color = Color(1, 0.5, 0.2)
print(color.to_argb32()) # Prints 4294934323
----
.. _class_Color_method_to_argb64:
- :ref:`int<class_int>` **to_argb64** **(** **)**
Returns the color converted to a 64-bit integer in ARGB format (each word represents a color channel). ARGB is more compatible with DirectX.
::
var color = Color(1, 0.5, 0.2)
print(color.to_argb64()) # Prints -2147470541
----
.. _class_Color_method_to_html:
- :ref:`String<class_String>` **to_html** **(** :ref:`bool<class_bool>` with_alpha=true **)**
Returns the color's HTML hexadecimal color string in ARGB format (ex: ``ff34f822``).
Setting ``with_alpha`` to ``false`` excludes alpha from the hexadecimal string.
::
var c = Color(1, 1, 1, 0.5)
var s1 = c.to_html() # Returns "7fffffff"
var s2 = c.to_html(false) # Returns "ffffff"
----
.. _class_Color_method_to_rgba32:
- :ref:`int<class_int>` **to_rgba32** **(** **)**
Returns the color converted to a 32-bit integer in RGBA format (each byte represents a color channel). RGBA is Godot's default format.
::
var color = Color(1, 0.5, 0.2)
print(color.to_rgba32()) # Prints 4286526463
----
.. _class_Color_method_to_rgba64:
- :ref:`int<class_int>` **to_rgba64** **(** **)**
Returns the color converted to a 64-bit integer in RGBA format (each word represents a color channel). RGBA is Godot's default format.
::
var color = Color(1, 0.5, 0.2)
print(color.to_rgba64()) # Prints -140736629309441
.. |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.)`
Reference in New Issue View Git Blame Copy Permalink