123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/4.3/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/2768>`__
- - `Tween Interpolation Demo <https://godotengine.org/asset-library/asset/2733>`__
- - `GUI Drag And Drop Demo <https://godotengine.org/asset-library/asset/2767>`__
- .. 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>`\ (\ from\: :ref:`Color<class_Color>`, alpha\: :ref:`float<class_float>`\ ) |
- +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>`\ (\ from\: :ref:`Color<class_Color>`\ ) |
- +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>`\ (\ code\: :ref:`String<class_String>`\ ) |
- +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>`\ (\ code\: :ref:`String<class_String>`, alpha\: :ref:`float<class_float>`\ ) |
- +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>`\ (\ r\: :ref:`float<class_float>`, g\: :ref:`float<class_float>`, b\: :ref:`float<class_float>`\ ) |
- +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>`\ (\ r\: :ref:`float<class_float>`, g\: :ref:`float<class_float>`, b\: :ref:`float<class_float>`, a\: :ref:`float<class_float>`\ ) |
- +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- .. rst-class:: classref-reftable-group
- Methods
- -------
- .. table::
- :widths: auto
- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`blend<class_Color_method_blend>`\ (\ over\: :ref:`Color<class_Color>`\ ) |const| |
- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`clamp<class_Color_method_clamp>`\ (\ min\: :ref:`Color<class_Color>` = Color(0, 0, 0, 0), max\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |const| |
- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`darkened<class_Color_method_darkened>`\ (\ amount\: :ref:`float<class_float>`\ ) |const| |
- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`from_hsv<class_Color_method_from_hsv>`\ (\ h\: :ref:`float<class_float>`, s\: :ref:`float<class_float>`, v\: :ref:`float<class_float>`, alpha\: :ref:`float<class_float>` = 1.0\ ) |static| |
- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`from_ok_hsl<class_Color_method_from_ok_hsl>`\ (\ h\: :ref:`float<class_float>`, s\: :ref:`float<class_float>`, l\: :ref:`float<class_float>`, alpha\: :ref:`float<class_float>` = 1.0\ ) |static| |
- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`from_rgbe9995<class_Color_method_from_rgbe9995>`\ (\ rgbe\: :ref:`int<class_int>`\ ) |static| |
- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`from_string<class_Color_method_from_string>`\ (\ str\: :ref:`String<class_String>`, default\: :ref:`Color<class_Color>`\ ) |static| |
- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_luminance<class_Color_method_get_luminance>`\ (\ ) |const| |
- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`hex<class_Color_method_hex>`\ (\ hex\: :ref:`int<class_int>`\ ) |static| |
- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`hex64<class_Color_method_hex64>`\ (\ hex\: :ref:`int<class_int>`\ ) |static| |
- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`html<class_Color_method_html>`\ (\ rgba\: :ref:`String<class_String>`\ ) |static| |
- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`html_is_valid<class_Color_method_html_is_valid>`\ (\ color\: :ref:`String<class_String>`\ ) |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>`\ (\ to\: :ref:`Color<class_Color>`\ ) |const| |
- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`lerp<class_Color_method_lerp>`\ (\ to\: :ref:`Color<class_Color>`, weight\: :ref:`float<class_float>`\ ) |const| |
- +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`lightened<class_Color_method_lightened>`\ (\ amount\: :ref:`float<class_float>`\ ) |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>`\ (\ with_alpha\: :ref:`bool<class_bool>` = 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>`\ (\ right\: :ref:`Color<class_Color>`\ ) |
- +---------------------------+---------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`operator *<class_Color_operator_mul_Color>`\ (\ right\: :ref:`Color<class_Color>`\ ) |
- +---------------------------+---------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`operator *<class_Color_operator_mul_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
- +---------------------------+---------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`operator *<class_Color_operator_mul_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
- +---------------------------+---------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`operator +<class_Color_operator_sum_Color>`\ (\ right\: :ref:`Color<class_Color>`\ ) |
- +---------------------------+---------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`operator -<class_Color_operator_dif_Color>`\ (\ right\: :ref:`Color<class_Color>`\ ) |
- +---------------------------+---------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`operator /<class_Color_operator_div_Color>`\ (\ right\: :ref:`Color<class_Color>`\ ) |
- +---------------------------+---------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`operator /<class_Color_operator_div_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
- +---------------------------+---------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`operator /<class_Color_operator_div_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
- +---------------------------+---------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`operator ==<class_Color_operator_eq_Color>`\ (\ right\: :ref:`Color<class_Color>`\ ) |
- +---------------------------+---------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`operator []<class_Color_operator_idx_int>`\ (\ index\: :ref:`int<class_int>`\ ) |
- +---------------------------+---------------------------------------------------------------------------------------------+
- | :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)`` :ref:`🔗<class_Color_constant_ALICE_BLUE>`
- Alice blue color.
- .. _class_Color_constant_ANTIQUE_WHITE:
- .. rst-class:: classref-constant
- **ANTIQUE_WHITE** = ``Color(0.980392, 0.921569, 0.843137, 1)`` :ref:`🔗<class_Color_constant_ANTIQUE_WHITE>`
- Antique white color.
- .. _class_Color_constant_AQUA:
- .. rst-class:: classref-constant
- **AQUA** = ``Color(0, 1, 1, 1)`` :ref:`🔗<class_Color_constant_AQUA>`
- Aqua color.
- .. _class_Color_constant_AQUAMARINE:
- .. rst-class:: classref-constant
- **AQUAMARINE** = ``Color(0.498039, 1, 0.831373, 1)`` :ref:`🔗<class_Color_constant_AQUAMARINE>`
- Aquamarine color.
- .. _class_Color_constant_AZURE:
- .. rst-class:: classref-constant
- **AZURE** = ``Color(0.941176, 1, 1, 1)`` :ref:`🔗<class_Color_constant_AZURE>`
- Azure color.
- .. _class_Color_constant_BEIGE:
- .. rst-class:: classref-constant
- **BEIGE** = ``Color(0.960784, 0.960784, 0.862745, 1)`` :ref:`🔗<class_Color_constant_BEIGE>`
- Beige color.
- .. _class_Color_constant_BISQUE:
- .. rst-class:: classref-constant
- **BISQUE** = ``Color(1, 0.894118, 0.768627, 1)`` :ref:`🔗<class_Color_constant_BISQUE>`
- Bisque color.
- .. _class_Color_constant_BLACK:
- .. rst-class:: classref-constant
- **BLACK** = ``Color(0, 0, 0, 1)`` :ref:`🔗<class_Color_constant_BLACK>`
- 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)`` :ref:`🔗<class_Color_constant_BLANCHED_ALMOND>`
- Blanched almond color.
- .. _class_Color_constant_BLUE:
- .. rst-class:: classref-constant
- **BLUE** = ``Color(0, 0, 1, 1)`` :ref:`🔗<class_Color_constant_BLUE>`
- Blue color.
- .. _class_Color_constant_BLUE_VIOLET:
- .. rst-class:: classref-constant
- **BLUE_VIOLET** = ``Color(0.541176, 0.168627, 0.886275, 1)`` :ref:`🔗<class_Color_constant_BLUE_VIOLET>`
- Blue violet color.
- .. _class_Color_constant_BROWN:
- .. rst-class:: classref-constant
- **BROWN** = ``Color(0.647059, 0.164706, 0.164706, 1)`` :ref:`🔗<class_Color_constant_BROWN>`
- Brown color.
- .. _class_Color_constant_BURLYWOOD:
- .. rst-class:: classref-constant
- **BURLYWOOD** = ``Color(0.870588, 0.721569, 0.529412, 1)`` :ref:`🔗<class_Color_constant_BURLYWOOD>`
- Burlywood color.
- .. _class_Color_constant_CADET_BLUE:
- .. rst-class:: classref-constant
- **CADET_BLUE** = ``Color(0.372549, 0.619608, 0.627451, 1)`` :ref:`🔗<class_Color_constant_CADET_BLUE>`
- Cadet blue color.
- .. _class_Color_constant_CHARTREUSE:
- .. rst-class:: classref-constant
- **CHARTREUSE** = ``Color(0.498039, 1, 0, 1)`` :ref:`🔗<class_Color_constant_CHARTREUSE>`
- Chartreuse color.
- .. _class_Color_constant_CHOCOLATE:
- .. rst-class:: classref-constant
- **CHOCOLATE** = ``Color(0.823529, 0.411765, 0.117647, 1)`` :ref:`🔗<class_Color_constant_CHOCOLATE>`
- Chocolate color.
- .. _class_Color_constant_CORAL:
- .. rst-class:: classref-constant
- **CORAL** = ``Color(1, 0.498039, 0.313726, 1)`` :ref:`🔗<class_Color_constant_CORAL>`
- Coral color.
- .. _class_Color_constant_CORNFLOWER_BLUE:
- .. rst-class:: classref-constant
- **CORNFLOWER_BLUE** = ``Color(0.392157, 0.584314, 0.929412, 1)`` :ref:`🔗<class_Color_constant_CORNFLOWER_BLUE>`
- Cornflower blue color.
- .. _class_Color_constant_CORNSILK:
- .. rst-class:: classref-constant
- **CORNSILK** = ``Color(1, 0.972549, 0.862745, 1)`` :ref:`🔗<class_Color_constant_CORNSILK>`
- Cornsilk color.
- .. _class_Color_constant_CRIMSON:
- .. rst-class:: classref-constant
- **CRIMSON** = ``Color(0.862745, 0.0784314, 0.235294, 1)`` :ref:`🔗<class_Color_constant_CRIMSON>`
- Crimson color.
- .. _class_Color_constant_CYAN:
- .. rst-class:: classref-constant
- **CYAN** = ``Color(0, 1, 1, 1)`` :ref:`🔗<class_Color_constant_CYAN>`
- Cyan color.
- .. _class_Color_constant_DARK_BLUE:
- .. rst-class:: classref-constant
- **DARK_BLUE** = ``Color(0, 0, 0.545098, 1)`` :ref:`🔗<class_Color_constant_DARK_BLUE>`
- Dark blue color.
- .. _class_Color_constant_DARK_CYAN:
- .. rst-class:: classref-constant
- **DARK_CYAN** = ``Color(0, 0.545098, 0.545098, 1)`` :ref:`🔗<class_Color_constant_DARK_CYAN>`
- Dark cyan color.
- .. _class_Color_constant_DARK_GOLDENROD:
- .. rst-class:: classref-constant
- **DARK_GOLDENROD** = ``Color(0.721569, 0.52549, 0.0431373, 1)`` :ref:`🔗<class_Color_constant_DARK_GOLDENROD>`
- Dark goldenrod color.
- .. _class_Color_constant_DARK_GRAY:
- .. rst-class:: classref-constant
- **DARK_GRAY** = ``Color(0.662745, 0.662745, 0.662745, 1)`` :ref:`🔗<class_Color_constant_DARK_GRAY>`
- Dark gray color.
- .. _class_Color_constant_DARK_GREEN:
- .. rst-class:: classref-constant
- **DARK_GREEN** = ``Color(0, 0.392157, 0, 1)`` :ref:`🔗<class_Color_constant_DARK_GREEN>`
- Dark green color.
- .. _class_Color_constant_DARK_KHAKI:
- .. rst-class:: classref-constant
- **DARK_KHAKI** = ``Color(0.741176, 0.717647, 0.419608, 1)`` :ref:`🔗<class_Color_constant_DARK_KHAKI>`
- Dark khaki color.
- .. _class_Color_constant_DARK_MAGENTA:
- .. rst-class:: classref-constant
- **DARK_MAGENTA** = ``Color(0.545098, 0, 0.545098, 1)`` :ref:`🔗<class_Color_constant_DARK_MAGENTA>`
- Dark magenta color.
- .. _class_Color_constant_DARK_OLIVE_GREEN:
- .. rst-class:: classref-constant
- **DARK_OLIVE_GREEN** = ``Color(0.333333, 0.419608, 0.184314, 1)`` :ref:`🔗<class_Color_constant_DARK_OLIVE_GREEN>`
- Dark olive green color.
- .. _class_Color_constant_DARK_ORANGE:
- .. rst-class:: classref-constant
- **DARK_ORANGE** = ``Color(1, 0.54902, 0, 1)`` :ref:`🔗<class_Color_constant_DARK_ORANGE>`
- Dark orange color.
- .. _class_Color_constant_DARK_ORCHID:
- .. rst-class:: classref-constant
- **DARK_ORCHID** = ``Color(0.6, 0.196078, 0.8, 1)`` :ref:`🔗<class_Color_constant_DARK_ORCHID>`
- Dark orchid color.
- .. _class_Color_constant_DARK_RED:
- .. rst-class:: classref-constant
- **DARK_RED** = ``Color(0.545098, 0, 0, 1)`` :ref:`🔗<class_Color_constant_DARK_RED>`
- Dark red color.
- .. _class_Color_constant_DARK_SALMON:
- .. rst-class:: classref-constant
- **DARK_SALMON** = ``Color(0.913725, 0.588235, 0.478431, 1)`` :ref:`🔗<class_Color_constant_DARK_SALMON>`
- Dark salmon color.
- .. _class_Color_constant_DARK_SEA_GREEN:
- .. rst-class:: classref-constant
- **DARK_SEA_GREEN** = ``Color(0.560784, 0.737255, 0.560784, 1)`` :ref:`🔗<class_Color_constant_DARK_SEA_GREEN>`
- 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)`` :ref:`🔗<class_Color_constant_DARK_SLATE_BLUE>`
- 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)`` :ref:`🔗<class_Color_constant_DARK_SLATE_GRAY>`
- Dark slate gray color.
- .. _class_Color_constant_DARK_TURQUOISE:
- .. rst-class:: classref-constant
- **DARK_TURQUOISE** = ``Color(0, 0.807843, 0.819608, 1)`` :ref:`🔗<class_Color_constant_DARK_TURQUOISE>`
- Dark turquoise color.
- .. _class_Color_constant_DARK_VIOLET:
- .. rst-class:: classref-constant
- **DARK_VIOLET** = ``Color(0.580392, 0, 0.827451, 1)`` :ref:`🔗<class_Color_constant_DARK_VIOLET>`
- Dark violet color.
- .. _class_Color_constant_DEEP_PINK:
- .. rst-class:: classref-constant
- **DEEP_PINK** = ``Color(1, 0.0784314, 0.576471, 1)`` :ref:`🔗<class_Color_constant_DEEP_PINK>`
- Deep pink color.
- .. _class_Color_constant_DEEP_SKY_BLUE:
- .. rst-class:: classref-constant
- **DEEP_SKY_BLUE** = ``Color(0, 0.74902, 1, 1)`` :ref:`🔗<class_Color_constant_DEEP_SKY_BLUE>`
- Deep sky blue color.
- .. _class_Color_constant_DIM_GRAY:
- .. rst-class:: classref-constant
- **DIM_GRAY** = ``Color(0.411765, 0.411765, 0.411765, 1)`` :ref:`🔗<class_Color_constant_DIM_GRAY>`
- Dim gray color.
- .. _class_Color_constant_DODGER_BLUE:
- .. rst-class:: classref-constant
- **DODGER_BLUE** = ``Color(0.117647, 0.564706, 1, 1)`` :ref:`🔗<class_Color_constant_DODGER_BLUE>`
- Dodger blue color.
- .. _class_Color_constant_FIREBRICK:
- .. rst-class:: classref-constant
- **FIREBRICK** = ``Color(0.698039, 0.133333, 0.133333, 1)`` :ref:`🔗<class_Color_constant_FIREBRICK>`
- Firebrick color.
- .. _class_Color_constant_FLORAL_WHITE:
- .. rst-class:: classref-constant
- **FLORAL_WHITE** = ``Color(1, 0.980392, 0.941176, 1)`` :ref:`🔗<class_Color_constant_FLORAL_WHITE>`
- Floral white color.
- .. _class_Color_constant_FOREST_GREEN:
- .. rst-class:: classref-constant
- **FOREST_GREEN** = ``Color(0.133333, 0.545098, 0.133333, 1)`` :ref:`🔗<class_Color_constant_FOREST_GREEN>`
- Forest green color.
- .. _class_Color_constant_FUCHSIA:
- .. rst-class:: classref-constant
- **FUCHSIA** = ``Color(1, 0, 1, 1)`` :ref:`🔗<class_Color_constant_FUCHSIA>`
- Fuchsia color.
- .. _class_Color_constant_GAINSBORO:
- .. rst-class:: classref-constant
- **GAINSBORO** = ``Color(0.862745, 0.862745, 0.862745, 1)`` :ref:`🔗<class_Color_constant_GAINSBORO>`
- Gainsboro color.
- .. _class_Color_constant_GHOST_WHITE:
- .. rst-class:: classref-constant
- **GHOST_WHITE** = ``Color(0.972549, 0.972549, 1, 1)`` :ref:`🔗<class_Color_constant_GHOST_WHITE>`
- Ghost white color.
- .. _class_Color_constant_GOLD:
- .. rst-class:: classref-constant
- **GOLD** = ``Color(1, 0.843137, 0, 1)`` :ref:`🔗<class_Color_constant_GOLD>`
- Gold color.
- .. _class_Color_constant_GOLDENROD:
- .. rst-class:: classref-constant
- **GOLDENROD** = ``Color(0.854902, 0.647059, 0.12549, 1)`` :ref:`🔗<class_Color_constant_GOLDENROD>`
- Goldenrod color.
- .. _class_Color_constant_GRAY:
- .. rst-class:: classref-constant
- **GRAY** = ``Color(0.745098, 0.745098, 0.745098, 1)`` :ref:`🔗<class_Color_constant_GRAY>`
- Gray color.
- .. _class_Color_constant_GREEN:
- .. rst-class:: classref-constant
- **GREEN** = ``Color(0, 1, 0, 1)`` :ref:`🔗<class_Color_constant_GREEN>`
- Green color.
- .. _class_Color_constant_GREEN_YELLOW:
- .. rst-class:: classref-constant
- **GREEN_YELLOW** = ``Color(0.678431, 1, 0.184314, 1)`` :ref:`🔗<class_Color_constant_GREEN_YELLOW>`
- Green yellow color.
- .. _class_Color_constant_HONEYDEW:
- .. rst-class:: classref-constant
- **HONEYDEW** = ``Color(0.941176, 1, 0.941176, 1)`` :ref:`🔗<class_Color_constant_HONEYDEW>`
- Honeydew color.
- .. _class_Color_constant_HOT_PINK:
- .. rst-class:: classref-constant
- **HOT_PINK** = ``Color(1, 0.411765, 0.705882, 1)`` :ref:`🔗<class_Color_constant_HOT_PINK>`
- Hot pink color.
- .. _class_Color_constant_INDIAN_RED:
- .. rst-class:: classref-constant
- **INDIAN_RED** = ``Color(0.803922, 0.360784, 0.360784, 1)`` :ref:`🔗<class_Color_constant_INDIAN_RED>`
- Indian red color.
- .. _class_Color_constant_INDIGO:
- .. rst-class:: classref-constant
- **INDIGO** = ``Color(0.294118, 0, 0.509804, 1)`` :ref:`🔗<class_Color_constant_INDIGO>`
- Indigo color.
- .. _class_Color_constant_IVORY:
- .. rst-class:: classref-constant
- **IVORY** = ``Color(1, 1, 0.941176, 1)`` :ref:`🔗<class_Color_constant_IVORY>`
- Ivory color.
- .. _class_Color_constant_KHAKI:
- .. rst-class:: classref-constant
- **KHAKI** = ``Color(0.941176, 0.901961, 0.54902, 1)`` :ref:`🔗<class_Color_constant_KHAKI>`
- Khaki color.
- .. _class_Color_constant_LAVENDER:
- .. rst-class:: classref-constant
- **LAVENDER** = ``Color(0.901961, 0.901961, 0.980392, 1)`` :ref:`🔗<class_Color_constant_LAVENDER>`
- Lavender color.
- .. _class_Color_constant_LAVENDER_BLUSH:
- .. rst-class:: classref-constant
- **LAVENDER_BLUSH** = ``Color(1, 0.941176, 0.960784, 1)`` :ref:`🔗<class_Color_constant_LAVENDER_BLUSH>`
- Lavender blush color.
- .. _class_Color_constant_LAWN_GREEN:
- .. rst-class:: classref-constant
- **LAWN_GREEN** = ``Color(0.486275, 0.988235, 0, 1)`` :ref:`🔗<class_Color_constant_LAWN_GREEN>`
- Lawn green color.
- .. _class_Color_constant_LEMON_CHIFFON:
- .. rst-class:: classref-constant
- **LEMON_CHIFFON** = ``Color(1, 0.980392, 0.803922, 1)`` :ref:`🔗<class_Color_constant_LEMON_CHIFFON>`
- Lemon chiffon color.
- .. _class_Color_constant_LIGHT_BLUE:
- .. rst-class:: classref-constant
- **LIGHT_BLUE** = ``Color(0.678431, 0.847059, 0.901961, 1)`` :ref:`🔗<class_Color_constant_LIGHT_BLUE>`
- Light blue color.
- .. _class_Color_constant_LIGHT_CORAL:
- .. rst-class:: classref-constant
- **LIGHT_CORAL** = ``Color(0.941176, 0.501961, 0.501961, 1)`` :ref:`🔗<class_Color_constant_LIGHT_CORAL>`
- Light coral color.
- .. _class_Color_constant_LIGHT_CYAN:
- .. rst-class:: classref-constant
- **LIGHT_CYAN** = ``Color(0.878431, 1, 1, 1)`` :ref:`🔗<class_Color_constant_LIGHT_CYAN>`
- Light cyan color.
- .. _class_Color_constant_LIGHT_GOLDENROD:
- .. rst-class:: classref-constant
- **LIGHT_GOLDENROD** = ``Color(0.980392, 0.980392, 0.823529, 1)`` :ref:`🔗<class_Color_constant_LIGHT_GOLDENROD>`
- Light goldenrod color.
- .. _class_Color_constant_LIGHT_GRAY:
- .. rst-class:: classref-constant
- **LIGHT_GRAY** = ``Color(0.827451, 0.827451, 0.827451, 1)`` :ref:`🔗<class_Color_constant_LIGHT_GRAY>`
- Light gray color.
- .. _class_Color_constant_LIGHT_GREEN:
- .. rst-class:: classref-constant
- **LIGHT_GREEN** = ``Color(0.564706, 0.933333, 0.564706, 1)`` :ref:`🔗<class_Color_constant_LIGHT_GREEN>`
- Light green color.
- .. _class_Color_constant_LIGHT_PINK:
- .. rst-class:: classref-constant
- **LIGHT_PINK** = ``Color(1, 0.713726, 0.756863, 1)`` :ref:`🔗<class_Color_constant_LIGHT_PINK>`
- Light pink color.
- .. _class_Color_constant_LIGHT_SALMON:
- .. rst-class:: classref-constant
- **LIGHT_SALMON** = ``Color(1, 0.627451, 0.478431, 1)`` :ref:`🔗<class_Color_constant_LIGHT_SALMON>`
- Light salmon color.
- .. _class_Color_constant_LIGHT_SEA_GREEN:
- .. rst-class:: classref-constant
- **LIGHT_SEA_GREEN** = ``Color(0.12549, 0.698039, 0.666667, 1)`` :ref:`🔗<class_Color_constant_LIGHT_SEA_GREEN>`
- 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)`` :ref:`🔗<class_Color_constant_LIGHT_SKY_BLUE>`
- 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)`` :ref:`🔗<class_Color_constant_LIGHT_SLATE_GRAY>`
- 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)`` :ref:`🔗<class_Color_constant_LIGHT_STEEL_BLUE>`
- Light steel blue color.
- .. _class_Color_constant_LIGHT_YELLOW:
- .. rst-class:: classref-constant
- **LIGHT_YELLOW** = ``Color(1, 1, 0.878431, 1)`` :ref:`🔗<class_Color_constant_LIGHT_YELLOW>`
- Light yellow color.
- .. _class_Color_constant_LIME:
- .. rst-class:: classref-constant
- **LIME** = ``Color(0, 1, 0, 1)`` :ref:`🔗<class_Color_constant_LIME>`
- Lime color.
- .. _class_Color_constant_LIME_GREEN:
- .. rst-class:: classref-constant
- **LIME_GREEN** = ``Color(0.196078, 0.803922, 0.196078, 1)`` :ref:`🔗<class_Color_constant_LIME_GREEN>`
- Lime green color.
- .. _class_Color_constant_LINEN:
- .. rst-class:: classref-constant
- **LINEN** = ``Color(0.980392, 0.941176, 0.901961, 1)`` :ref:`🔗<class_Color_constant_LINEN>`
- Linen color.
- .. _class_Color_constant_MAGENTA:
- .. rst-class:: classref-constant
- **MAGENTA** = ``Color(1, 0, 1, 1)`` :ref:`🔗<class_Color_constant_MAGENTA>`
- Magenta color.
- .. _class_Color_constant_MAROON:
- .. rst-class:: classref-constant
- **MAROON** = ``Color(0.690196, 0.188235, 0.376471, 1)`` :ref:`🔗<class_Color_constant_MAROON>`
- Maroon color.
- .. _class_Color_constant_MEDIUM_AQUAMARINE:
- .. rst-class:: classref-constant
- **MEDIUM_AQUAMARINE** = ``Color(0.4, 0.803922, 0.666667, 1)`` :ref:`🔗<class_Color_constant_MEDIUM_AQUAMARINE>`
- Medium aquamarine color.
- .. _class_Color_constant_MEDIUM_BLUE:
- .. rst-class:: classref-constant
- **MEDIUM_BLUE** = ``Color(0, 0, 0.803922, 1)`` :ref:`🔗<class_Color_constant_MEDIUM_BLUE>`
- Medium blue color.
- .. _class_Color_constant_MEDIUM_ORCHID:
- .. rst-class:: classref-constant
- **MEDIUM_ORCHID** = ``Color(0.729412, 0.333333, 0.827451, 1)`` :ref:`🔗<class_Color_constant_MEDIUM_ORCHID>`
- Medium orchid color.
- .. _class_Color_constant_MEDIUM_PURPLE:
- .. rst-class:: classref-constant
- **MEDIUM_PURPLE** = ``Color(0.576471, 0.439216, 0.858824, 1)`` :ref:`🔗<class_Color_constant_MEDIUM_PURPLE>`
- Medium purple color.
- .. _class_Color_constant_MEDIUM_SEA_GREEN:
- .. rst-class:: classref-constant
- **MEDIUM_SEA_GREEN** = ``Color(0.235294, 0.701961, 0.443137, 1)`` :ref:`🔗<class_Color_constant_MEDIUM_SEA_GREEN>`
- 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)`` :ref:`🔗<class_Color_constant_MEDIUM_SLATE_BLUE>`
- Medium slate blue color.
- .. _class_Color_constant_MEDIUM_SPRING_GREEN:
- .. rst-class:: classref-constant
- **MEDIUM_SPRING_GREEN** = ``Color(0, 0.980392, 0.603922, 1)`` :ref:`🔗<class_Color_constant_MEDIUM_SPRING_GREEN>`
- Medium spring green color.
- .. _class_Color_constant_MEDIUM_TURQUOISE:
- .. rst-class:: classref-constant
- **MEDIUM_TURQUOISE** = ``Color(0.282353, 0.819608, 0.8, 1)`` :ref:`🔗<class_Color_constant_MEDIUM_TURQUOISE>`
- Medium turquoise color.
- .. _class_Color_constant_MEDIUM_VIOLET_RED:
- .. rst-class:: classref-constant
- **MEDIUM_VIOLET_RED** = ``Color(0.780392, 0.0823529, 0.521569, 1)`` :ref:`🔗<class_Color_constant_MEDIUM_VIOLET_RED>`
- Medium violet red color.
- .. _class_Color_constant_MIDNIGHT_BLUE:
- .. rst-class:: classref-constant
- **MIDNIGHT_BLUE** = ``Color(0.0980392, 0.0980392, 0.439216, 1)`` :ref:`🔗<class_Color_constant_MIDNIGHT_BLUE>`
- Midnight blue color.
- .. _class_Color_constant_MINT_CREAM:
- .. rst-class:: classref-constant
- **MINT_CREAM** = ``Color(0.960784, 1, 0.980392, 1)`` :ref:`🔗<class_Color_constant_MINT_CREAM>`
- Mint cream color.
- .. _class_Color_constant_MISTY_ROSE:
- .. rst-class:: classref-constant
- **MISTY_ROSE** = ``Color(1, 0.894118, 0.882353, 1)`` :ref:`🔗<class_Color_constant_MISTY_ROSE>`
- Misty rose color.
- .. _class_Color_constant_MOCCASIN:
- .. rst-class:: classref-constant
- **MOCCASIN** = ``Color(1, 0.894118, 0.709804, 1)`` :ref:`🔗<class_Color_constant_MOCCASIN>`
- Moccasin color.
- .. _class_Color_constant_NAVAJO_WHITE:
- .. rst-class:: classref-constant
- **NAVAJO_WHITE** = ``Color(1, 0.870588, 0.678431, 1)`` :ref:`🔗<class_Color_constant_NAVAJO_WHITE>`
- Navajo white color.
- .. _class_Color_constant_NAVY_BLUE:
- .. rst-class:: classref-constant
- **NAVY_BLUE** = ``Color(0, 0, 0.501961, 1)`` :ref:`🔗<class_Color_constant_NAVY_BLUE>`
- Navy blue color.
- .. _class_Color_constant_OLD_LACE:
- .. rst-class:: classref-constant
- **OLD_LACE** = ``Color(0.992157, 0.960784, 0.901961, 1)`` :ref:`🔗<class_Color_constant_OLD_LACE>`
- Old lace color.
- .. _class_Color_constant_OLIVE:
- .. rst-class:: classref-constant
- **OLIVE** = ``Color(0.501961, 0.501961, 0, 1)`` :ref:`🔗<class_Color_constant_OLIVE>`
- Olive color.
- .. _class_Color_constant_OLIVE_DRAB:
- .. rst-class:: classref-constant
- **OLIVE_DRAB** = ``Color(0.419608, 0.556863, 0.137255, 1)`` :ref:`🔗<class_Color_constant_OLIVE_DRAB>`
- Olive drab color.
- .. _class_Color_constant_ORANGE:
- .. rst-class:: classref-constant
- **ORANGE** = ``Color(1, 0.647059, 0, 1)`` :ref:`🔗<class_Color_constant_ORANGE>`
- Orange color.
- .. _class_Color_constant_ORANGE_RED:
- .. rst-class:: classref-constant
- **ORANGE_RED** = ``Color(1, 0.270588, 0, 1)`` :ref:`🔗<class_Color_constant_ORANGE_RED>`
- Orange red color.
- .. _class_Color_constant_ORCHID:
- .. rst-class:: classref-constant
- **ORCHID** = ``Color(0.854902, 0.439216, 0.839216, 1)`` :ref:`🔗<class_Color_constant_ORCHID>`
- Orchid color.
- .. _class_Color_constant_PALE_GOLDENROD:
- .. rst-class:: classref-constant
- **PALE_GOLDENROD** = ``Color(0.933333, 0.909804, 0.666667, 1)`` :ref:`🔗<class_Color_constant_PALE_GOLDENROD>`
- Pale goldenrod color.
- .. _class_Color_constant_PALE_GREEN:
- .. rst-class:: classref-constant
- **PALE_GREEN** = ``Color(0.596078, 0.984314, 0.596078, 1)`` :ref:`🔗<class_Color_constant_PALE_GREEN>`
- Pale green color.
- .. _class_Color_constant_PALE_TURQUOISE:
- .. rst-class:: classref-constant
- **PALE_TURQUOISE** = ``Color(0.686275, 0.933333, 0.933333, 1)`` :ref:`🔗<class_Color_constant_PALE_TURQUOISE>`
- Pale turquoise color.
- .. _class_Color_constant_PALE_VIOLET_RED:
- .. rst-class:: classref-constant
- **PALE_VIOLET_RED** = ``Color(0.858824, 0.439216, 0.576471, 1)`` :ref:`🔗<class_Color_constant_PALE_VIOLET_RED>`
- Pale violet red color.
- .. _class_Color_constant_PAPAYA_WHIP:
- .. rst-class:: classref-constant
- **PAPAYA_WHIP** = ``Color(1, 0.937255, 0.835294, 1)`` :ref:`🔗<class_Color_constant_PAPAYA_WHIP>`
- Papaya whip color.
- .. _class_Color_constant_PEACH_PUFF:
- .. rst-class:: classref-constant
- **PEACH_PUFF** = ``Color(1, 0.854902, 0.72549, 1)`` :ref:`🔗<class_Color_constant_PEACH_PUFF>`
- Peach puff color.
- .. _class_Color_constant_PERU:
- .. rst-class:: classref-constant
- **PERU** = ``Color(0.803922, 0.521569, 0.247059, 1)`` :ref:`🔗<class_Color_constant_PERU>`
- Peru color.
- .. _class_Color_constant_PINK:
- .. rst-class:: classref-constant
- **PINK** = ``Color(1, 0.752941, 0.796078, 1)`` :ref:`🔗<class_Color_constant_PINK>`
- Pink color.
- .. _class_Color_constant_PLUM:
- .. rst-class:: classref-constant
- **PLUM** = ``Color(0.866667, 0.627451, 0.866667, 1)`` :ref:`🔗<class_Color_constant_PLUM>`
- Plum color.
- .. _class_Color_constant_POWDER_BLUE:
- .. rst-class:: classref-constant
- **POWDER_BLUE** = ``Color(0.690196, 0.878431, 0.901961, 1)`` :ref:`🔗<class_Color_constant_POWDER_BLUE>`
- Powder blue color.
- .. _class_Color_constant_PURPLE:
- .. rst-class:: classref-constant
- **PURPLE** = ``Color(0.627451, 0.12549, 0.941176, 1)`` :ref:`🔗<class_Color_constant_PURPLE>`
- Purple color.
- .. _class_Color_constant_REBECCA_PURPLE:
- .. rst-class:: classref-constant
- **REBECCA_PURPLE** = ``Color(0.4, 0.2, 0.6, 1)`` :ref:`🔗<class_Color_constant_REBECCA_PURPLE>`
- Rebecca purple color.
- .. _class_Color_constant_RED:
- .. rst-class:: classref-constant
- **RED** = ``Color(1, 0, 0, 1)`` :ref:`🔗<class_Color_constant_RED>`
- Red color.
- .. _class_Color_constant_ROSY_BROWN:
- .. rst-class:: classref-constant
- **ROSY_BROWN** = ``Color(0.737255, 0.560784, 0.560784, 1)`` :ref:`🔗<class_Color_constant_ROSY_BROWN>`
- Rosy brown color.
- .. _class_Color_constant_ROYAL_BLUE:
- .. rst-class:: classref-constant
- **ROYAL_BLUE** = ``Color(0.254902, 0.411765, 0.882353, 1)`` :ref:`🔗<class_Color_constant_ROYAL_BLUE>`
- Royal blue color.
- .. _class_Color_constant_SADDLE_BROWN:
- .. rst-class:: classref-constant
- **SADDLE_BROWN** = ``Color(0.545098, 0.270588, 0.0745098, 1)`` :ref:`🔗<class_Color_constant_SADDLE_BROWN>`
- Saddle brown color.
- .. _class_Color_constant_SALMON:
- .. rst-class:: classref-constant
- **SALMON** = ``Color(0.980392, 0.501961, 0.447059, 1)`` :ref:`🔗<class_Color_constant_SALMON>`
- Salmon color.
- .. _class_Color_constant_SANDY_BROWN:
- .. rst-class:: classref-constant
- **SANDY_BROWN** = ``Color(0.956863, 0.643137, 0.376471, 1)`` :ref:`🔗<class_Color_constant_SANDY_BROWN>`
- Sandy brown color.
- .. _class_Color_constant_SEA_GREEN:
- .. rst-class:: classref-constant
- **SEA_GREEN** = ``Color(0.180392, 0.545098, 0.341176, 1)`` :ref:`🔗<class_Color_constant_SEA_GREEN>`
- Sea green color.
- .. _class_Color_constant_SEASHELL:
- .. rst-class:: classref-constant
- **SEASHELL** = ``Color(1, 0.960784, 0.933333, 1)`` :ref:`🔗<class_Color_constant_SEASHELL>`
- Seashell color.
- .. _class_Color_constant_SIENNA:
- .. rst-class:: classref-constant
- **SIENNA** = ``Color(0.627451, 0.321569, 0.176471, 1)`` :ref:`🔗<class_Color_constant_SIENNA>`
- Sienna color.
- .. _class_Color_constant_SILVER:
- .. rst-class:: classref-constant
- **SILVER** = ``Color(0.752941, 0.752941, 0.752941, 1)`` :ref:`🔗<class_Color_constant_SILVER>`
- Silver color.
- .. _class_Color_constant_SKY_BLUE:
- .. rst-class:: classref-constant
- **SKY_BLUE** = ``Color(0.529412, 0.807843, 0.921569, 1)`` :ref:`🔗<class_Color_constant_SKY_BLUE>`
- Sky blue color.
- .. _class_Color_constant_SLATE_BLUE:
- .. rst-class:: classref-constant
- **SLATE_BLUE** = ``Color(0.415686, 0.352941, 0.803922, 1)`` :ref:`🔗<class_Color_constant_SLATE_BLUE>`
- Slate blue color.
- .. _class_Color_constant_SLATE_GRAY:
- .. rst-class:: classref-constant
- **SLATE_GRAY** = ``Color(0.439216, 0.501961, 0.564706, 1)`` :ref:`🔗<class_Color_constant_SLATE_GRAY>`
- Slate gray color.
- .. _class_Color_constant_SNOW:
- .. rst-class:: classref-constant
- **SNOW** = ``Color(1, 0.980392, 0.980392, 1)`` :ref:`🔗<class_Color_constant_SNOW>`
- Snow color.
- .. _class_Color_constant_SPRING_GREEN:
- .. rst-class:: classref-constant
- **SPRING_GREEN** = ``Color(0, 1, 0.498039, 1)`` :ref:`🔗<class_Color_constant_SPRING_GREEN>`
- Spring green color.
- .. _class_Color_constant_STEEL_BLUE:
- .. rst-class:: classref-constant
- **STEEL_BLUE** = ``Color(0.27451, 0.509804, 0.705882, 1)`` :ref:`🔗<class_Color_constant_STEEL_BLUE>`
- Steel blue color.
- .. _class_Color_constant_TAN:
- .. rst-class:: classref-constant
- **TAN** = ``Color(0.823529, 0.705882, 0.54902, 1)`` :ref:`🔗<class_Color_constant_TAN>`
- Tan color.
- .. _class_Color_constant_TEAL:
- .. rst-class:: classref-constant
- **TEAL** = ``Color(0, 0.501961, 0.501961, 1)`` :ref:`🔗<class_Color_constant_TEAL>`
- Teal color.
- .. _class_Color_constant_THISTLE:
- .. rst-class:: classref-constant
- **THISTLE** = ``Color(0.847059, 0.74902, 0.847059, 1)`` :ref:`🔗<class_Color_constant_THISTLE>`
- Thistle color.
- .. _class_Color_constant_TOMATO:
- .. rst-class:: classref-constant
- **TOMATO** = ``Color(1, 0.388235, 0.278431, 1)`` :ref:`🔗<class_Color_constant_TOMATO>`
- Tomato color.
- .. _class_Color_constant_TRANSPARENT:
- .. rst-class:: classref-constant
- **TRANSPARENT** = ``Color(1, 1, 1, 0)`` :ref:`🔗<class_Color_constant_TRANSPARENT>`
- Transparent color (white with zero alpha).
- .. _class_Color_constant_TURQUOISE:
- .. rst-class:: classref-constant
- **TURQUOISE** = ``Color(0.25098, 0.878431, 0.815686, 1)`` :ref:`🔗<class_Color_constant_TURQUOISE>`
- Turquoise color.
- .. _class_Color_constant_VIOLET:
- .. rst-class:: classref-constant
- **VIOLET** = ``Color(0.933333, 0.509804, 0.933333, 1)`` :ref:`🔗<class_Color_constant_VIOLET>`
- Violet color.
- .. _class_Color_constant_WEB_GRAY:
- .. rst-class:: classref-constant
- **WEB_GRAY** = ``Color(0.501961, 0.501961, 0.501961, 1)`` :ref:`🔗<class_Color_constant_WEB_GRAY>`
- Web gray color.
- .. _class_Color_constant_WEB_GREEN:
- .. rst-class:: classref-constant
- **WEB_GREEN** = ``Color(0, 0.501961, 0, 1)`` :ref:`🔗<class_Color_constant_WEB_GREEN>`
- Web green color.
- .. _class_Color_constant_WEB_MAROON:
- .. rst-class:: classref-constant
- **WEB_MAROON** = ``Color(0.501961, 0, 0, 1)`` :ref:`🔗<class_Color_constant_WEB_MAROON>`
- Web maroon color.
- .. _class_Color_constant_WEB_PURPLE:
- .. rst-class:: classref-constant
- **WEB_PURPLE** = ``Color(0.501961, 0, 0.501961, 1)`` :ref:`🔗<class_Color_constant_WEB_PURPLE>`
- Web purple color.
- .. _class_Color_constant_WHEAT:
- .. rst-class:: classref-constant
- **WHEAT** = ``Color(0.960784, 0.870588, 0.701961, 1)`` :ref:`🔗<class_Color_constant_WHEAT>`
- Wheat color.
- .. _class_Color_constant_WHITE:
- .. rst-class:: classref-constant
- **WHITE** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_Color_constant_WHITE>`
- White color.
- .. _class_Color_constant_WHITE_SMOKE:
- .. rst-class:: classref-constant
- **WHITE_SMOKE** = ``Color(0.960784, 0.960784, 0.960784, 1)`` :ref:`🔗<class_Color_constant_WHITE_SMOKE>`
- White smoke color.
- .. _class_Color_constant_YELLOW:
- .. rst-class:: classref-constant
- **YELLOW** = ``Color(1, 1, 0, 1)`` :ref:`🔗<class_Color_constant_YELLOW>`
- Yellow color.
- .. _class_Color_constant_YELLOW_GREEN:
- .. rst-class:: classref-constant
- **YELLOW_GREEN** = ``Color(0.603922, 0.803922, 0.196078, 1)`` :ref:`🔗<class_Color_constant_YELLOW_GREEN>`
- 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`` :ref:`🔗<class_Color_property_a>`
- 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`` :ref:`🔗<class_Color_property_a8>`
- 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`` :ref:`🔗<class_Color_property_b>`
- 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`` :ref:`🔗<class_Color_property_b8>`
- 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`` :ref:`🔗<class_Color_property_g>`
- 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`` :ref:`🔗<class_Color_property_g8>`
- 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`` :ref:`🔗<class_Color_property_h>`
- 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`` :ref:`🔗<class_Color_property_r>`
- 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`` :ref:`🔗<class_Color_property_r8>`
- 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`` :ref:`🔗<class_Color_property_s>`
- 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`` :ref:`🔗<class_Color_property_v>`
- 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**\ (\ ) :ref:`🔗<class_Color_constructor_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**\ (\ from\: :ref:`Color<class_Color>`, alpha\: :ref:`float<class_float>`\ )
- 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**\ (\ from\: :ref:`Color<class_Color>`\ )
- Constructs a **Color** as a copy of the given **Color**.
- .. rst-class:: classref-item-separator
- ----
- .. rst-class:: classref-constructor
- :ref:`Color<class_Color>` **Color**\ (\ code\: :ref:`String<class_String>`\ )
- 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**\ (\ code\: :ref:`String<class_String>`, alpha\: :ref:`float<class_float>`\ )
- 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**\ (\ r\: :ref:`float<class_float>`, g\: :ref:`float<class_float>`, b\: :ref:`float<class_float>`\ )
- 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**\ (\ r\: :ref:`float<class_float>`, g\: :ref:`float<class_float>`, b\: :ref:`float<class_float>`, a\: :ref:`float<class_float>`\ )
- 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**\ (\ over\: :ref:`Color<class_Color>`\ ) |const| :ref:`🔗<class_Color_method_blend>`
- 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**\ (\ min\: :ref:`Color<class_Color>` = Color(0, 0, 0, 0), max\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |const| :ref:`🔗<class_Color_method_clamp>`
- 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**\ (\ amount\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_Color_method_darkened>`
- 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**\ (\ h\: :ref:`float<class_float>`, s\: :ref:`float<class_float>`, v\: :ref:`float<class_float>`, alpha\: :ref:`float<class_float>` = 1.0\ ) |static| :ref:`🔗<class_Color_method_from_hsv>`
- 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**\ (\ h\: :ref:`float<class_float>`, s\: :ref:`float<class_float>`, l\: :ref:`float<class_float>`, alpha\: :ref:`float<class_float>` = 1.0\ ) |static| :ref:`🔗<class_Color_method_from_ok_hsl>`
- 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**\ (\ rgbe\: :ref:`int<class_int>`\ ) |static| :ref:`🔗<class_Color_method_from_rgbe9995>`
- Decodes a **Color** from an 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**\ (\ str\: :ref:`String<class_String>`, default\: :ref:`Color<class_Color>`\ ) |static| :ref:`🔗<class_Color_method_from_string>`
- 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.
- If you want to create a color from String in a constant expression, use the equivalent constructor instead (i.e. ``Color("color string")``).
- .. rst-class:: classref-item-separator
- ----
- .. _class_Color_method_get_luminance:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **get_luminance**\ (\ ) |const| :ref:`🔗<class_Color_method_get_luminance>`
- 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**\ (\ hex\: :ref:`int<class_int>`\ ) |static| :ref:`🔗<class_Color_method_hex>`
- Returns the **Color** associated with the provided ``hex`` integer in 32-bit RGBA format (8 bits per channel). This method is the inverse of :ref:`to_rgba32<class_Color_method_to_rgba32>`.
- 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);
- If you want to use hex notation in a constant expression, use the equivalent constructor instead (i.e. ``Color(0xRRGGBBAA)``).
- .. rst-class:: classref-item-separator
- ----
- .. _class_Color_method_hex64:
- .. rst-class:: classref-method
- :ref:`Color<class_Color>` **hex64**\ (\ hex\: :ref:`int<class_int>`\ ) |static| :ref:`🔗<class_Color_method_hex64>`
- Returns the **Color** associated with the provided ``hex`` integer in 64-bit RGBA format (16 bits per channel). This method is the inverse of :ref:`to_rgba64<class_Color_method_to_rgba64>`.
- 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**\ (\ rgba\: :ref:`String<class_String>`\ ) |static| :ref:`🔗<class_Color_method_html>`
- 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**\ (\ color\: :ref:`String<class_String>`\ ) |static| :ref:`🔗<class_Color_method_html_is_valid>`
- 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| :ref:`🔗<class_Color_method_inverted>`
- 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**\ (\ to\: :ref:`Color<class_Color>`\ ) |const| :ref:`🔗<class_Color_method_is_equal_approx>`
- 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**\ (\ to\: :ref:`Color<class_Color>`, weight\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_Color_method_lerp>`
- 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**\ (\ amount\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_Color_method_lightened>`
- 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| :ref:`🔗<class_Color_method_linear_to_srgb>`
- 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| :ref:`🔗<class_Color_method_srgb_to_linear>`
- 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| :ref:`🔗<class_Color_method_to_abgr32>`
- 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| :ref:`🔗<class_Color_method_to_abgr64>`
- 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| :ref:`🔗<class_Color_method_to_argb32>`
- 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| :ref:`🔗<class_Color_method_to_argb64>`
- 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**\ (\ with_alpha\: :ref:`bool<class_bool>` = true\ ) |const| :ref:`🔗<class_Color_method_to_html>`
- 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| :ref:`🔗<class_Color_method_to_rgba32>`
- Returns the color converted to a 32-bit integer in RGBA format (each component is 8 bits). RGBA is Godot's default format. This method is the inverse of :ref:`hex<class_Color_method_hex>`.
- .. 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| :ref:`🔗<class_Color_method_to_rgba64>`
- Returns the color converted to a 64-bit integer in RGBA format (each component is 16 bits). RGBA is Godot's default format. This method is the inverse of :ref:`hex64<class_Color_method_hex64>`.
- .. 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 !=**\ (\ right\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_Color_operator_neq_Color>`
- 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 ***\ (\ right\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_Color_operator_mul_Color>`
- 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 ***\ (\ right\: :ref:`float<class_float>`\ ) :ref:`🔗<class_Color_operator_mul_float>`
- 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 ***\ (\ right\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Color_operator_mul_int>`
- 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 +**\ (\ right\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_Color_operator_sum_Color>`
- 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 -**\ (\ right\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_Color_operator_dif_Color>`
- 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 /**\ (\ right\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_Color_operator_div_Color>`
- 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 /**\ (\ right\: :ref:`float<class_float>`\ ) :ref:`🔗<class_Color_operator_div_float>`
- 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 /**\ (\ right\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Color_operator_div_int>`
- 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 ==**\ (\ right\: :ref:`Color<class_Color>`\ ) :ref:`🔗<class_Color_operator_eq_Color>`
- 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 []**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_Color_operator_idx_int>`
- 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+**\ (\ ) :ref:`🔗<class_Color_operator_unplus>`
- 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-**\ (\ ) :ref:`🔗<class_Color_operator_unminus>`
- 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.)`
- .. |void| replace:: :abbr:`void (No return value.)`
|