class_color.rst 79 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.3/doc/classes/Color.xml.
  6. .. _class_Color:
  7. Color
  8. =====
  9. A color represented in RGBA format.
  10. .. rst-class:: classref-introduction-group
  11. Description
  12. -----------
  13. 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.
  14. 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.
  15. \ **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``.
  16. \ `Color constants cheatsheet <https://raw.githubusercontent.com/godotengine/godot-docs/master/img/color_constants.png>`__
  17. .. note::
  18. There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.
  19. .. rst-class:: classref-introduction-group
  20. Tutorials
  21. ---------
  22. - `2D GD Paint Demo <https://godotengine.org/asset-library/asset/2768>`__
  23. - `Tween Interpolation Demo <https://godotengine.org/asset-library/asset/2733>`__
  24. - `GUI Drag And Drop Demo <https://godotengine.org/asset-library/asset/2767>`__
  25. .. rst-class:: classref-reftable-group
  26. Properties
  27. ----------
  28. .. table::
  29. :widths: auto
  30. +---------------------------+------------------------------------+---------+
  31. | :ref:`float<class_float>` | :ref:`a<class_Color_property_a>` | ``1.0`` |
  32. +---------------------------+------------------------------------+---------+
  33. | :ref:`int<class_int>` | :ref:`a8<class_Color_property_a8>` | ``255`` |
  34. +---------------------------+------------------------------------+---------+
  35. | :ref:`float<class_float>` | :ref:`b<class_Color_property_b>` | ``0.0`` |
  36. +---------------------------+------------------------------------+---------+
  37. | :ref:`int<class_int>` | :ref:`b8<class_Color_property_b8>` | ``0`` |
  38. +---------------------------+------------------------------------+---------+
  39. | :ref:`float<class_float>` | :ref:`g<class_Color_property_g>` | ``0.0`` |
  40. +---------------------------+------------------------------------+---------+
  41. | :ref:`int<class_int>` | :ref:`g8<class_Color_property_g8>` | ``0`` |
  42. +---------------------------+------------------------------------+---------+
  43. | :ref:`float<class_float>` | :ref:`h<class_Color_property_h>` | ``0.0`` |
  44. +---------------------------+------------------------------------+---------+
  45. | :ref:`float<class_float>` | :ref:`r<class_Color_property_r>` | ``0.0`` |
  46. +---------------------------+------------------------------------+---------+
  47. | :ref:`int<class_int>` | :ref:`r8<class_Color_property_r8>` | ``0`` |
  48. +---------------------------+------------------------------------+---------+
  49. | :ref:`float<class_float>` | :ref:`s<class_Color_property_s>` | ``0.0`` |
  50. +---------------------------+------------------------------------+---------+
  51. | :ref:`float<class_float>` | :ref:`v<class_Color_property_v>` | ``0.0`` |
  52. +---------------------------+------------------------------------+---------+
  53. .. rst-class:: classref-reftable-group
  54. Constructors
  55. ------------
  56. .. table::
  57. :widths: auto
  58. +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>`\ (\ ) |
  60. +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>`\ (\ from\: :ref:`Color<class_Color>`, alpha\: :ref:`float<class_float>`\ ) |
  62. +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>`\ (\ from\: :ref:`Color<class_Color>`\ ) |
  64. +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>`\ (\ code\: :ref:`String<class_String>`\ ) |
  66. +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>`\ (\ code\: :ref:`String<class_String>`, alpha\: :ref:`float<class_float>`\ ) |
  68. +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | :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>`\ ) |
  70. +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | :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>`\ ) |
  72. +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. .. rst-class:: classref-reftable-group
  74. Methods
  75. -------
  76. .. table::
  77. :widths: auto
  78. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | :ref:`Color<class_Color>` | :ref:`blend<class_Color_method_blend>`\ (\ over\: :ref:`Color<class_Color>`\ ) |const| |
  80. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | :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| |
  82. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | :ref:`Color<class_Color>` | :ref:`darkened<class_Color_method_darkened>`\ (\ amount\: :ref:`float<class_float>`\ ) |const| |
  84. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | :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| |
  86. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | :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| |
  88. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | :ref:`Color<class_Color>` | :ref:`from_rgbe9995<class_Color_method_from_rgbe9995>`\ (\ rgbe\: :ref:`int<class_int>`\ ) |static| |
  90. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`Color<class_Color>` | :ref:`from_string<class_Color_method_from_string>`\ (\ str\: :ref:`String<class_String>`, default\: :ref:`Color<class_Color>`\ ) |static| |
  92. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | :ref:`float<class_float>` | :ref:`get_luminance<class_Color_method_get_luminance>`\ (\ ) |const| |
  94. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | :ref:`Color<class_Color>` | :ref:`hex<class_Color_method_hex>`\ (\ hex\: :ref:`int<class_int>`\ ) |static| |
  96. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | :ref:`Color<class_Color>` | :ref:`hex64<class_Color_method_hex64>`\ (\ hex\: :ref:`int<class_int>`\ ) |static| |
  98. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | :ref:`Color<class_Color>` | :ref:`html<class_Color_method_html>`\ (\ rgba\: :ref:`String<class_String>`\ ) |static| |
  100. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | :ref:`bool<class_bool>` | :ref:`html_is_valid<class_Color_method_html_is_valid>`\ (\ color\: :ref:`String<class_String>`\ ) |static| |
  102. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | :ref:`Color<class_Color>` | :ref:`inverted<class_Color_method_inverted>`\ (\ ) |const| |
  104. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | :ref:`bool<class_bool>` | :ref:`is_equal_approx<class_Color_method_is_equal_approx>`\ (\ to\: :ref:`Color<class_Color>`\ ) |const| |
  106. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`Color<class_Color>` | :ref:`lerp<class_Color_method_lerp>`\ (\ to\: :ref:`Color<class_Color>`, weight\: :ref:`float<class_float>`\ ) |const| |
  108. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`Color<class_Color>` | :ref:`lightened<class_Color_method_lightened>`\ (\ amount\: :ref:`float<class_float>`\ ) |const| |
  110. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`Color<class_Color>` | :ref:`linear_to_srgb<class_Color_method_linear_to_srgb>`\ (\ ) |const| |
  112. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`Color<class_Color>` | :ref:`srgb_to_linear<class_Color_method_srgb_to_linear>`\ (\ ) |const| |
  114. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`int<class_int>` | :ref:`to_abgr32<class_Color_method_to_abgr32>`\ (\ ) |const| |
  116. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`int<class_int>` | :ref:`to_abgr64<class_Color_method_to_abgr64>`\ (\ ) |const| |
  118. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`int<class_int>` | :ref:`to_argb32<class_Color_method_to_argb32>`\ (\ ) |const| |
  120. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`int<class_int>` | :ref:`to_argb64<class_Color_method_to_argb64>`\ (\ ) |const| |
  122. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`String<class_String>` | :ref:`to_html<class_Color_method_to_html>`\ (\ with_alpha\: :ref:`bool<class_bool>` = true\ ) |const| |
  124. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`int<class_int>` | :ref:`to_rgba32<class_Color_method_to_rgba32>`\ (\ ) |const| |
  126. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`int<class_int>` | :ref:`to_rgba64<class_Color_method_to_rgba64>`\ (\ ) |const| |
  128. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. .. rst-class:: classref-reftable-group
  130. Operators
  131. ---------
  132. .. table::
  133. :widths: auto
  134. +---------------------------+---------------------------------------------------------------------------------------------+
  135. | :ref:`bool<class_bool>` | :ref:`operator !=<class_Color_operator_neq_Color>`\ (\ right\: :ref:`Color<class_Color>`\ ) |
  136. +---------------------------+---------------------------------------------------------------------------------------------+
  137. | :ref:`Color<class_Color>` | :ref:`operator *<class_Color_operator_mul_Color>`\ (\ right\: :ref:`Color<class_Color>`\ ) |
  138. +---------------------------+---------------------------------------------------------------------------------------------+
  139. | :ref:`Color<class_Color>` | :ref:`operator *<class_Color_operator_mul_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
  140. +---------------------------+---------------------------------------------------------------------------------------------+
  141. | :ref:`Color<class_Color>` | :ref:`operator *<class_Color_operator_mul_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
  142. +---------------------------+---------------------------------------------------------------------------------------------+
  143. | :ref:`Color<class_Color>` | :ref:`operator +<class_Color_operator_sum_Color>`\ (\ right\: :ref:`Color<class_Color>`\ ) |
  144. +---------------------------+---------------------------------------------------------------------------------------------+
  145. | :ref:`Color<class_Color>` | :ref:`operator -<class_Color_operator_dif_Color>`\ (\ right\: :ref:`Color<class_Color>`\ ) |
  146. +---------------------------+---------------------------------------------------------------------------------------------+
  147. | :ref:`Color<class_Color>` | :ref:`operator /<class_Color_operator_div_Color>`\ (\ right\: :ref:`Color<class_Color>`\ ) |
  148. +---------------------------+---------------------------------------------------------------------------------------------+
  149. | :ref:`Color<class_Color>` | :ref:`operator /<class_Color_operator_div_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
  150. +---------------------------+---------------------------------------------------------------------------------------------+
  151. | :ref:`Color<class_Color>` | :ref:`operator /<class_Color_operator_div_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
  152. +---------------------------+---------------------------------------------------------------------------------------------+
  153. | :ref:`bool<class_bool>` | :ref:`operator ==<class_Color_operator_eq_Color>`\ (\ right\: :ref:`Color<class_Color>`\ ) |
  154. +---------------------------+---------------------------------------------------------------------------------------------+
  155. | :ref:`float<class_float>` | :ref:`operator []<class_Color_operator_idx_int>`\ (\ index\: :ref:`int<class_int>`\ ) |
  156. +---------------------------+---------------------------------------------------------------------------------------------+
  157. | :ref:`Color<class_Color>` | :ref:`operator unary+<class_Color_operator_unplus>`\ (\ ) |
  158. +---------------------------+---------------------------------------------------------------------------------------------+
  159. | :ref:`Color<class_Color>` | :ref:`operator unary-<class_Color_operator_unminus>`\ (\ ) |
  160. +---------------------------+---------------------------------------------------------------------------------------------+
  161. .. rst-class:: classref-section-separator
  162. ----
  163. .. rst-class:: classref-descriptions-group
  164. Constants
  165. ---------
  166. .. _class_Color_constant_ALICE_BLUE:
  167. .. rst-class:: classref-constant
  168. **ALICE_BLUE** = ``Color(0.941176, 0.972549, 1, 1)`` :ref:`๐Ÿ”—<class_Color_constant_ALICE_BLUE>`
  169. Alice blue color.
  170. .. _class_Color_constant_ANTIQUE_WHITE:
  171. .. rst-class:: classref-constant
  172. **ANTIQUE_WHITE** = ``Color(0.980392, 0.921569, 0.843137, 1)`` :ref:`๐Ÿ”—<class_Color_constant_ANTIQUE_WHITE>`
  173. Antique white color.
  174. .. _class_Color_constant_AQUA:
  175. .. rst-class:: classref-constant
  176. **AQUA** = ``Color(0, 1, 1, 1)`` :ref:`๐Ÿ”—<class_Color_constant_AQUA>`
  177. Aqua color.
  178. .. _class_Color_constant_AQUAMARINE:
  179. .. rst-class:: classref-constant
  180. **AQUAMARINE** = ``Color(0.498039, 1, 0.831373, 1)`` :ref:`๐Ÿ”—<class_Color_constant_AQUAMARINE>`
  181. Aquamarine color.
  182. .. _class_Color_constant_AZURE:
  183. .. rst-class:: classref-constant
  184. **AZURE** = ``Color(0.941176, 1, 1, 1)`` :ref:`๐Ÿ”—<class_Color_constant_AZURE>`
  185. Azure color.
  186. .. _class_Color_constant_BEIGE:
  187. .. rst-class:: classref-constant
  188. **BEIGE** = ``Color(0.960784, 0.960784, 0.862745, 1)`` :ref:`๐Ÿ”—<class_Color_constant_BEIGE>`
  189. Beige color.
  190. .. _class_Color_constant_BISQUE:
  191. .. rst-class:: classref-constant
  192. **BISQUE** = ``Color(1, 0.894118, 0.768627, 1)`` :ref:`๐Ÿ”—<class_Color_constant_BISQUE>`
  193. Bisque color.
  194. .. _class_Color_constant_BLACK:
  195. .. rst-class:: classref-constant
  196. **BLACK** = ``Color(0, 0, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_BLACK>`
  197. Black color. In GDScript, this is the default value of any color.
  198. .. _class_Color_constant_BLANCHED_ALMOND:
  199. .. rst-class:: classref-constant
  200. **BLANCHED_ALMOND** = ``Color(1, 0.921569, 0.803922, 1)`` :ref:`๐Ÿ”—<class_Color_constant_BLANCHED_ALMOND>`
  201. Blanched almond color.
  202. .. _class_Color_constant_BLUE:
  203. .. rst-class:: classref-constant
  204. **BLUE** = ``Color(0, 0, 1, 1)`` :ref:`๐Ÿ”—<class_Color_constant_BLUE>`
  205. Blue color.
  206. .. _class_Color_constant_BLUE_VIOLET:
  207. .. rst-class:: classref-constant
  208. **BLUE_VIOLET** = ``Color(0.541176, 0.168627, 0.886275, 1)`` :ref:`๐Ÿ”—<class_Color_constant_BLUE_VIOLET>`
  209. Blue violet color.
  210. .. _class_Color_constant_BROWN:
  211. .. rst-class:: classref-constant
  212. **BROWN** = ``Color(0.647059, 0.164706, 0.164706, 1)`` :ref:`๐Ÿ”—<class_Color_constant_BROWN>`
  213. Brown color.
  214. .. _class_Color_constant_BURLYWOOD:
  215. .. rst-class:: classref-constant
  216. **BURLYWOOD** = ``Color(0.870588, 0.721569, 0.529412, 1)`` :ref:`๐Ÿ”—<class_Color_constant_BURLYWOOD>`
  217. Burlywood color.
  218. .. _class_Color_constant_CADET_BLUE:
  219. .. rst-class:: classref-constant
  220. **CADET_BLUE** = ``Color(0.372549, 0.619608, 0.627451, 1)`` :ref:`๐Ÿ”—<class_Color_constant_CADET_BLUE>`
  221. Cadet blue color.
  222. .. _class_Color_constant_CHARTREUSE:
  223. .. rst-class:: classref-constant
  224. **CHARTREUSE** = ``Color(0.498039, 1, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_CHARTREUSE>`
  225. Chartreuse color.
  226. .. _class_Color_constant_CHOCOLATE:
  227. .. rst-class:: classref-constant
  228. **CHOCOLATE** = ``Color(0.823529, 0.411765, 0.117647, 1)`` :ref:`๐Ÿ”—<class_Color_constant_CHOCOLATE>`
  229. Chocolate color.
  230. .. _class_Color_constant_CORAL:
  231. .. rst-class:: classref-constant
  232. **CORAL** = ``Color(1, 0.498039, 0.313726, 1)`` :ref:`๐Ÿ”—<class_Color_constant_CORAL>`
  233. Coral color.
  234. .. _class_Color_constant_CORNFLOWER_BLUE:
  235. .. rst-class:: classref-constant
  236. **CORNFLOWER_BLUE** = ``Color(0.392157, 0.584314, 0.929412, 1)`` :ref:`๐Ÿ”—<class_Color_constant_CORNFLOWER_BLUE>`
  237. Cornflower blue color.
  238. .. _class_Color_constant_CORNSILK:
  239. .. rst-class:: classref-constant
  240. **CORNSILK** = ``Color(1, 0.972549, 0.862745, 1)`` :ref:`๐Ÿ”—<class_Color_constant_CORNSILK>`
  241. Cornsilk color.
  242. .. _class_Color_constant_CRIMSON:
  243. .. rst-class:: classref-constant
  244. **CRIMSON** = ``Color(0.862745, 0.0784314, 0.235294, 1)`` :ref:`๐Ÿ”—<class_Color_constant_CRIMSON>`
  245. Crimson color.
  246. .. _class_Color_constant_CYAN:
  247. .. rst-class:: classref-constant
  248. **CYAN** = ``Color(0, 1, 1, 1)`` :ref:`๐Ÿ”—<class_Color_constant_CYAN>`
  249. Cyan color.
  250. .. _class_Color_constant_DARK_BLUE:
  251. .. rst-class:: classref-constant
  252. **DARK_BLUE** = ``Color(0, 0, 0.545098, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_BLUE>`
  253. Dark blue color.
  254. .. _class_Color_constant_DARK_CYAN:
  255. .. rst-class:: classref-constant
  256. **DARK_CYAN** = ``Color(0, 0.545098, 0.545098, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_CYAN>`
  257. Dark cyan color.
  258. .. _class_Color_constant_DARK_GOLDENROD:
  259. .. rst-class:: classref-constant
  260. **DARK_GOLDENROD** = ``Color(0.721569, 0.52549, 0.0431373, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_GOLDENROD>`
  261. Dark goldenrod color.
  262. .. _class_Color_constant_DARK_GRAY:
  263. .. rst-class:: classref-constant
  264. **DARK_GRAY** = ``Color(0.662745, 0.662745, 0.662745, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_GRAY>`
  265. Dark gray color.
  266. .. _class_Color_constant_DARK_GREEN:
  267. .. rst-class:: classref-constant
  268. **DARK_GREEN** = ``Color(0, 0.392157, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_GREEN>`
  269. Dark green color.
  270. .. _class_Color_constant_DARK_KHAKI:
  271. .. rst-class:: classref-constant
  272. **DARK_KHAKI** = ``Color(0.741176, 0.717647, 0.419608, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_KHAKI>`
  273. Dark khaki color.
  274. .. _class_Color_constant_DARK_MAGENTA:
  275. .. rst-class:: classref-constant
  276. **DARK_MAGENTA** = ``Color(0.545098, 0, 0.545098, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_MAGENTA>`
  277. Dark magenta color.
  278. .. _class_Color_constant_DARK_OLIVE_GREEN:
  279. .. rst-class:: classref-constant
  280. **DARK_OLIVE_GREEN** = ``Color(0.333333, 0.419608, 0.184314, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_OLIVE_GREEN>`
  281. Dark olive green color.
  282. .. _class_Color_constant_DARK_ORANGE:
  283. .. rst-class:: classref-constant
  284. **DARK_ORANGE** = ``Color(1, 0.54902, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_ORANGE>`
  285. Dark orange color.
  286. .. _class_Color_constant_DARK_ORCHID:
  287. .. rst-class:: classref-constant
  288. **DARK_ORCHID** = ``Color(0.6, 0.196078, 0.8, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_ORCHID>`
  289. Dark orchid color.
  290. .. _class_Color_constant_DARK_RED:
  291. .. rst-class:: classref-constant
  292. **DARK_RED** = ``Color(0.545098, 0, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_RED>`
  293. Dark red color.
  294. .. _class_Color_constant_DARK_SALMON:
  295. .. rst-class:: classref-constant
  296. **DARK_SALMON** = ``Color(0.913725, 0.588235, 0.478431, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_SALMON>`
  297. Dark salmon color.
  298. .. _class_Color_constant_DARK_SEA_GREEN:
  299. .. rst-class:: classref-constant
  300. **DARK_SEA_GREEN** = ``Color(0.560784, 0.737255, 0.560784, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_SEA_GREEN>`
  301. Dark sea green color.
  302. .. _class_Color_constant_DARK_SLATE_BLUE:
  303. .. rst-class:: classref-constant
  304. **DARK_SLATE_BLUE** = ``Color(0.282353, 0.239216, 0.545098, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_SLATE_BLUE>`
  305. Dark slate blue color.
  306. .. _class_Color_constant_DARK_SLATE_GRAY:
  307. .. rst-class:: classref-constant
  308. **DARK_SLATE_GRAY** = ``Color(0.184314, 0.309804, 0.309804, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_SLATE_GRAY>`
  309. Dark slate gray color.
  310. .. _class_Color_constant_DARK_TURQUOISE:
  311. .. rst-class:: classref-constant
  312. **DARK_TURQUOISE** = ``Color(0, 0.807843, 0.819608, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_TURQUOISE>`
  313. Dark turquoise color.
  314. .. _class_Color_constant_DARK_VIOLET:
  315. .. rst-class:: classref-constant
  316. **DARK_VIOLET** = ``Color(0.580392, 0, 0.827451, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DARK_VIOLET>`
  317. Dark violet color.
  318. .. _class_Color_constant_DEEP_PINK:
  319. .. rst-class:: classref-constant
  320. **DEEP_PINK** = ``Color(1, 0.0784314, 0.576471, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DEEP_PINK>`
  321. Deep pink color.
  322. .. _class_Color_constant_DEEP_SKY_BLUE:
  323. .. rst-class:: classref-constant
  324. **DEEP_SKY_BLUE** = ``Color(0, 0.74902, 1, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DEEP_SKY_BLUE>`
  325. Deep sky blue color.
  326. .. _class_Color_constant_DIM_GRAY:
  327. .. rst-class:: classref-constant
  328. **DIM_GRAY** = ``Color(0.411765, 0.411765, 0.411765, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DIM_GRAY>`
  329. Dim gray color.
  330. .. _class_Color_constant_DODGER_BLUE:
  331. .. rst-class:: classref-constant
  332. **DODGER_BLUE** = ``Color(0.117647, 0.564706, 1, 1)`` :ref:`๐Ÿ”—<class_Color_constant_DODGER_BLUE>`
  333. Dodger blue color.
  334. .. _class_Color_constant_FIREBRICK:
  335. .. rst-class:: classref-constant
  336. **FIREBRICK** = ``Color(0.698039, 0.133333, 0.133333, 1)`` :ref:`๐Ÿ”—<class_Color_constant_FIREBRICK>`
  337. Firebrick color.
  338. .. _class_Color_constant_FLORAL_WHITE:
  339. .. rst-class:: classref-constant
  340. **FLORAL_WHITE** = ``Color(1, 0.980392, 0.941176, 1)`` :ref:`๐Ÿ”—<class_Color_constant_FLORAL_WHITE>`
  341. Floral white color.
  342. .. _class_Color_constant_FOREST_GREEN:
  343. .. rst-class:: classref-constant
  344. **FOREST_GREEN** = ``Color(0.133333, 0.545098, 0.133333, 1)`` :ref:`๐Ÿ”—<class_Color_constant_FOREST_GREEN>`
  345. Forest green color.
  346. .. _class_Color_constant_FUCHSIA:
  347. .. rst-class:: classref-constant
  348. **FUCHSIA** = ``Color(1, 0, 1, 1)`` :ref:`๐Ÿ”—<class_Color_constant_FUCHSIA>`
  349. Fuchsia color.
  350. .. _class_Color_constant_GAINSBORO:
  351. .. rst-class:: classref-constant
  352. **GAINSBORO** = ``Color(0.862745, 0.862745, 0.862745, 1)`` :ref:`๐Ÿ”—<class_Color_constant_GAINSBORO>`
  353. Gainsboro color.
  354. .. _class_Color_constant_GHOST_WHITE:
  355. .. rst-class:: classref-constant
  356. **GHOST_WHITE** = ``Color(0.972549, 0.972549, 1, 1)`` :ref:`๐Ÿ”—<class_Color_constant_GHOST_WHITE>`
  357. Ghost white color.
  358. .. _class_Color_constant_GOLD:
  359. .. rst-class:: classref-constant
  360. **GOLD** = ``Color(1, 0.843137, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_GOLD>`
  361. Gold color.
  362. .. _class_Color_constant_GOLDENROD:
  363. .. rst-class:: classref-constant
  364. **GOLDENROD** = ``Color(0.854902, 0.647059, 0.12549, 1)`` :ref:`๐Ÿ”—<class_Color_constant_GOLDENROD>`
  365. Goldenrod color.
  366. .. _class_Color_constant_GRAY:
  367. .. rst-class:: classref-constant
  368. **GRAY** = ``Color(0.745098, 0.745098, 0.745098, 1)`` :ref:`๐Ÿ”—<class_Color_constant_GRAY>`
  369. Gray color.
  370. .. _class_Color_constant_GREEN:
  371. .. rst-class:: classref-constant
  372. **GREEN** = ``Color(0, 1, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_GREEN>`
  373. Green color.
  374. .. _class_Color_constant_GREEN_YELLOW:
  375. .. rst-class:: classref-constant
  376. **GREEN_YELLOW** = ``Color(0.678431, 1, 0.184314, 1)`` :ref:`๐Ÿ”—<class_Color_constant_GREEN_YELLOW>`
  377. Green yellow color.
  378. .. _class_Color_constant_HONEYDEW:
  379. .. rst-class:: classref-constant
  380. **HONEYDEW** = ``Color(0.941176, 1, 0.941176, 1)`` :ref:`๐Ÿ”—<class_Color_constant_HONEYDEW>`
  381. Honeydew color.
  382. .. _class_Color_constant_HOT_PINK:
  383. .. rst-class:: classref-constant
  384. **HOT_PINK** = ``Color(1, 0.411765, 0.705882, 1)`` :ref:`๐Ÿ”—<class_Color_constant_HOT_PINK>`
  385. Hot pink color.
  386. .. _class_Color_constant_INDIAN_RED:
  387. .. rst-class:: classref-constant
  388. **INDIAN_RED** = ``Color(0.803922, 0.360784, 0.360784, 1)`` :ref:`๐Ÿ”—<class_Color_constant_INDIAN_RED>`
  389. Indian red color.
  390. .. _class_Color_constant_INDIGO:
  391. .. rst-class:: classref-constant
  392. **INDIGO** = ``Color(0.294118, 0, 0.509804, 1)`` :ref:`๐Ÿ”—<class_Color_constant_INDIGO>`
  393. Indigo color.
  394. .. _class_Color_constant_IVORY:
  395. .. rst-class:: classref-constant
  396. **IVORY** = ``Color(1, 1, 0.941176, 1)`` :ref:`๐Ÿ”—<class_Color_constant_IVORY>`
  397. Ivory color.
  398. .. _class_Color_constant_KHAKI:
  399. .. rst-class:: classref-constant
  400. **KHAKI** = ``Color(0.941176, 0.901961, 0.54902, 1)`` :ref:`๐Ÿ”—<class_Color_constant_KHAKI>`
  401. Khaki color.
  402. .. _class_Color_constant_LAVENDER:
  403. .. rst-class:: classref-constant
  404. **LAVENDER** = ``Color(0.901961, 0.901961, 0.980392, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LAVENDER>`
  405. Lavender color.
  406. .. _class_Color_constant_LAVENDER_BLUSH:
  407. .. rst-class:: classref-constant
  408. **LAVENDER_BLUSH** = ``Color(1, 0.941176, 0.960784, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LAVENDER_BLUSH>`
  409. Lavender blush color.
  410. .. _class_Color_constant_LAWN_GREEN:
  411. .. rst-class:: classref-constant
  412. **LAWN_GREEN** = ``Color(0.486275, 0.988235, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LAWN_GREEN>`
  413. Lawn green color.
  414. .. _class_Color_constant_LEMON_CHIFFON:
  415. .. rst-class:: classref-constant
  416. **LEMON_CHIFFON** = ``Color(1, 0.980392, 0.803922, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LEMON_CHIFFON>`
  417. Lemon chiffon color.
  418. .. _class_Color_constant_LIGHT_BLUE:
  419. .. rst-class:: classref-constant
  420. **LIGHT_BLUE** = ``Color(0.678431, 0.847059, 0.901961, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIGHT_BLUE>`
  421. Light blue color.
  422. .. _class_Color_constant_LIGHT_CORAL:
  423. .. rst-class:: classref-constant
  424. **LIGHT_CORAL** = ``Color(0.941176, 0.501961, 0.501961, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIGHT_CORAL>`
  425. Light coral color.
  426. .. _class_Color_constant_LIGHT_CYAN:
  427. .. rst-class:: classref-constant
  428. **LIGHT_CYAN** = ``Color(0.878431, 1, 1, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIGHT_CYAN>`
  429. Light cyan color.
  430. .. _class_Color_constant_LIGHT_GOLDENROD:
  431. .. rst-class:: classref-constant
  432. **LIGHT_GOLDENROD** = ``Color(0.980392, 0.980392, 0.823529, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIGHT_GOLDENROD>`
  433. Light goldenrod color.
  434. .. _class_Color_constant_LIGHT_GRAY:
  435. .. rst-class:: classref-constant
  436. **LIGHT_GRAY** = ``Color(0.827451, 0.827451, 0.827451, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIGHT_GRAY>`
  437. Light gray color.
  438. .. _class_Color_constant_LIGHT_GREEN:
  439. .. rst-class:: classref-constant
  440. **LIGHT_GREEN** = ``Color(0.564706, 0.933333, 0.564706, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIGHT_GREEN>`
  441. Light green color.
  442. .. _class_Color_constant_LIGHT_PINK:
  443. .. rst-class:: classref-constant
  444. **LIGHT_PINK** = ``Color(1, 0.713726, 0.756863, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIGHT_PINK>`
  445. Light pink color.
  446. .. _class_Color_constant_LIGHT_SALMON:
  447. .. rst-class:: classref-constant
  448. **LIGHT_SALMON** = ``Color(1, 0.627451, 0.478431, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIGHT_SALMON>`
  449. Light salmon color.
  450. .. _class_Color_constant_LIGHT_SEA_GREEN:
  451. .. rst-class:: classref-constant
  452. **LIGHT_SEA_GREEN** = ``Color(0.12549, 0.698039, 0.666667, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIGHT_SEA_GREEN>`
  453. Light sea green color.
  454. .. _class_Color_constant_LIGHT_SKY_BLUE:
  455. .. rst-class:: classref-constant
  456. **LIGHT_SKY_BLUE** = ``Color(0.529412, 0.807843, 0.980392, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIGHT_SKY_BLUE>`
  457. Light sky blue color.
  458. .. _class_Color_constant_LIGHT_SLATE_GRAY:
  459. .. rst-class:: classref-constant
  460. **LIGHT_SLATE_GRAY** = ``Color(0.466667, 0.533333, 0.6, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIGHT_SLATE_GRAY>`
  461. Light slate gray color.
  462. .. _class_Color_constant_LIGHT_STEEL_BLUE:
  463. .. rst-class:: classref-constant
  464. **LIGHT_STEEL_BLUE** = ``Color(0.690196, 0.768627, 0.870588, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIGHT_STEEL_BLUE>`
  465. Light steel blue color.
  466. .. _class_Color_constant_LIGHT_YELLOW:
  467. .. rst-class:: classref-constant
  468. **LIGHT_YELLOW** = ``Color(1, 1, 0.878431, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIGHT_YELLOW>`
  469. Light yellow color.
  470. .. _class_Color_constant_LIME:
  471. .. rst-class:: classref-constant
  472. **LIME** = ``Color(0, 1, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIME>`
  473. Lime color.
  474. .. _class_Color_constant_LIME_GREEN:
  475. .. rst-class:: classref-constant
  476. **LIME_GREEN** = ``Color(0.196078, 0.803922, 0.196078, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LIME_GREEN>`
  477. Lime green color.
  478. .. _class_Color_constant_LINEN:
  479. .. rst-class:: classref-constant
  480. **LINEN** = ``Color(0.980392, 0.941176, 0.901961, 1)`` :ref:`๐Ÿ”—<class_Color_constant_LINEN>`
  481. Linen color.
  482. .. _class_Color_constant_MAGENTA:
  483. .. rst-class:: classref-constant
  484. **MAGENTA** = ``Color(1, 0, 1, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MAGENTA>`
  485. Magenta color.
  486. .. _class_Color_constant_MAROON:
  487. .. rst-class:: classref-constant
  488. **MAROON** = ``Color(0.690196, 0.188235, 0.376471, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MAROON>`
  489. Maroon color.
  490. .. _class_Color_constant_MEDIUM_AQUAMARINE:
  491. .. rst-class:: classref-constant
  492. **MEDIUM_AQUAMARINE** = ``Color(0.4, 0.803922, 0.666667, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MEDIUM_AQUAMARINE>`
  493. Medium aquamarine color.
  494. .. _class_Color_constant_MEDIUM_BLUE:
  495. .. rst-class:: classref-constant
  496. **MEDIUM_BLUE** = ``Color(0, 0, 0.803922, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MEDIUM_BLUE>`
  497. Medium blue color.
  498. .. _class_Color_constant_MEDIUM_ORCHID:
  499. .. rst-class:: classref-constant
  500. **MEDIUM_ORCHID** = ``Color(0.729412, 0.333333, 0.827451, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MEDIUM_ORCHID>`
  501. Medium orchid color.
  502. .. _class_Color_constant_MEDIUM_PURPLE:
  503. .. rst-class:: classref-constant
  504. **MEDIUM_PURPLE** = ``Color(0.576471, 0.439216, 0.858824, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MEDIUM_PURPLE>`
  505. Medium purple color.
  506. .. _class_Color_constant_MEDIUM_SEA_GREEN:
  507. .. rst-class:: classref-constant
  508. **MEDIUM_SEA_GREEN** = ``Color(0.235294, 0.701961, 0.443137, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MEDIUM_SEA_GREEN>`
  509. Medium sea green color.
  510. .. _class_Color_constant_MEDIUM_SLATE_BLUE:
  511. .. rst-class:: classref-constant
  512. **MEDIUM_SLATE_BLUE** = ``Color(0.482353, 0.407843, 0.933333, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MEDIUM_SLATE_BLUE>`
  513. Medium slate blue color.
  514. .. _class_Color_constant_MEDIUM_SPRING_GREEN:
  515. .. rst-class:: classref-constant
  516. **MEDIUM_SPRING_GREEN** = ``Color(0, 0.980392, 0.603922, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MEDIUM_SPRING_GREEN>`
  517. Medium spring green color.
  518. .. _class_Color_constant_MEDIUM_TURQUOISE:
  519. .. rst-class:: classref-constant
  520. **MEDIUM_TURQUOISE** = ``Color(0.282353, 0.819608, 0.8, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MEDIUM_TURQUOISE>`
  521. Medium turquoise color.
  522. .. _class_Color_constant_MEDIUM_VIOLET_RED:
  523. .. rst-class:: classref-constant
  524. **MEDIUM_VIOLET_RED** = ``Color(0.780392, 0.0823529, 0.521569, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MEDIUM_VIOLET_RED>`
  525. Medium violet red color.
  526. .. _class_Color_constant_MIDNIGHT_BLUE:
  527. .. rst-class:: classref-constant
  528. **MIDNIGHT_BLUE** = ``Color(0.0980392, 0.0980392, 0.439216, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MIDNIGHT_BLUE>`
  529. Midnight blue color.
  530. .. _class_Color_constant_MINT_CREAM:
  531. .. rst-class:: classref-constant
  532. **MINT_CREAM** = ``Color(0.960784, 1, 0.980392, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MINT_CREAM>`
  533. Mint cream color.
  534. .. _class_Color_constant_MISTY_ROSE:
  535. .. rst-class:: classref-constant
  536. **MISTY_ROSE** = ``Color(1, 0.894118, 0.882353, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MISTY_ROSE>`
  537. Misty rose color.
  538. .. _class_Color_constant_MOCCASIN:
  539. .. rst-class:: classref-constant
  540. **MOCCASIN** = ``Color(1, 0.894118, 0.709804, 1)`` :ref:`๐Ÿ”—<class_Color_constant_MOCCASIN>`
  541. Moccasin color.
  542. .. _class_Color_constant_NAVAJO_WHITE:
  543. .. rst-class:: classref-constant
  544. **NAVAJO_WHITE** = ``Color(1, 0.870588, 0.678431, 1)`` :ref:`๐Ÿ”—<class_Color_constant_NAVAJO_WHITE>`
  545. Navajo white color.
  546. .. _class_Color_constant_NAVY_BLUE:
  547. .. rst-class:: classref-constant
  548. **NAVY_BLUE** = ``Color(0, 0, 0.501961, 1)`` :ref:`๐Ÿ”—<class_Color_constant_NAVY_BLUE>`
  549. Navy blue color.
  550. .. _class_Color_constant_OLD_LACE:
  551. .. rst-class:: classref-constant
  552. **OLD_LACE** = ``Color(0.992157, 0.960784, 0.901961, 1)`` :ref:`๐Ÿ”—<class_Color_constant_OLD_LACE>`
  553. Old lace color.
  554. .. _class_Color_constant_OLIVE:
  555. .. rst-class:: classref-constant
  556. **OLIVE** = ``Color(0.501961, 0.501961, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_OLIVE>`
  557. Olive color.
  558. .. _class_Color_constant_OLIVE_DRAB:
  559. .. rst-class:: classref-constant
  560. **OLIVE_DRAB** = ``Color(0.419608, 0.556863, 0.137255, 1)`` :ref:`๐Ÿ”—<class_Color_constant_OLIVE_DRAB>`
  561. Olive drab color.
  562. .. _class_Color_constant_ORANGE:
  563. .. rst-class:: classref-constant
  564. **ORANGE** = ``Color(1, 0.647059, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_ORANGE>`
  565. Orange color.
  566. .. _class_Color_constant_ORANGE_RED:
  567. .. rst-class:: classref-constant
  568. **ORANGE_RED** = ``Color(1, 0.270588, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_ORANGE_RED>`
  569. Orange red color.
  570. .. _class_Color_constant_ORCHID:
  571. .. rst-class:: classref-constant
  572. **ORCHID** = ``Color(0.854902, 0.439216, 0.839216, 1)`` :ref:`๐Ÿ”—<class_Color_constant_ORCHID>`
  573. Orchid color.
  574. .. _class_Color_constant_PALE_GOLDENROD:
  575. .. rst-class:: classref-constant
  576. **PALE_GOLDENROD** = ``Color(0.933333, 0.909804, 0.666667, 1)`` :ref:`๐Ÿ”—<class_Color_constant_PALE_GOLDENROD>`
  577. Pale goldenrod color.
  578. .. _class_Color_constant_PALE_GREEN:
  579. .. rst-class:: classref-constant
  580. **PALE_GREEN** = ``Color(0.596078, 0.984314, 0.596078, 1)`` :ref:`๐Ÿ”—<class_Color_constant_PALE_GREEN>`
  581. Pale green color.
  582. .. _class_Color_constant_PALE_TURQUOISE:
  583. .. rst-class:: classref-constant
  584. **PALE_TURQUOISE** = ``Color(0.686275, 0.933333, 0.933333, 1)`` :ref:`๐Ÿ”—<class_Color_constant_PALE_TURQUOISE>`
  585. Pale turquoise color.
  586. .. _class_Color_constant_PALE_VIOLET_RED:
  587. .. rst-class:: classref-constant
  588. **PALE_VIOLET_RED** = ``Color(0.858824, 0.439216, 0.576471, 1)`` :ref:`๐Ÿ”—<class_Color_constant_PALE_VIOLET_RED>`
  589. Pale violet red color.
  590. .. _class_Color_constant_PAPAYA_WHIP:
  591. .. rst-class:: classref-constant
  592. **PAPAYA_WHIP** = ``Color(1, 0.937255, 0.835294, 1)`` :ref:`๐Ÿ”—<class_Color_constant_PAPAYA_WHIP>`
  593. Papaya whip color.
  594. .. _class_Color_constant_PEACH_PUFF:
  595. .. rst-class:: classref-constant
  596. **PEACH_PUFF** = ``Color(1, 0.854902, 0.72549, 1)`` :ref:`๐Ÿ”—<class_Color_constant_PEACH_PUFF>`
  597. Peach puff color.
  598. .. _class_Color_constant_PERU:
  599. .. rst-class:: classref-constant
  600. **PERU** = ``Color(0.803922, 0.521569, 0.247059, 1)`` :ref:`๐Ÿ”—<class_Color_constant_PERU>`
  601. Peru color.
  602. .. _class_Color_constant_PINK:
  603. .. rst-class:: classref-constant
  604. **PINK** = ``Color(1, 0.752941, 0.796078, 1)`` :ref:`๐Ÿ”—<class_Color_constant_PINK>`
  605. Pink color.
  606. .. _class_Color_constant_PLUM:
  607. .. rst-class:: classref-constant
  608. **PLUM** = ``Color(0.866667, 0.627451, 0.866667, 1)`` :ref:`๐Ÿ”—<class_Color_constant_PLUM>`
  609. Plum color.
  610. .. _class_Color_constant_POWDER_BLUE:
  611. .. rst-class:: classref-constant
  612. **POWDER_BLUE** = ``Color(0.690196, 0.878431, 0.901961, 1)`` :ref:`๐Ÿ”—<class_Color_constant_POWDER_BLUE>`
  613. Powder blue color.
  614. .. _class_Color_constant_PURPLE:
  615. .. rst-class:: classref-constant
  616. **PURPLE** = ``Color(0.627451, 0.12549, 0.941176, 1)`` :ref:`๐Ÿ”—<class_Color_constant_PURPLE>`
  617. Purple color.
  618. .. _class_Color_constant_REBECCA_PURPLE:
  619. .. rst-class:: classref-constant
  620. **REBECCA_PURPLE** = ``Color(0.4, 0.2, 0.6, 1)`` :ref:`๐Ÿ”—<class_Color_constant_REBECCA_PURPLE>`
  621. Rebecca purple color.
  622. .. _class_Color_constant_RED:
  623. .. rst-class:: classref-constant
  624. **RED** = ``Color(1, 0, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_RED>`
  625. Red color.
  626. .. _class_Color_constant_ROSY_BROWN:
  627. .. rst-class:: classref-constant
  628. **ROSY_BROWN** = ``Color(0.737255, 0.560784, 0.560784, 1)`` :ref:`๐Ÿ”—<class_Color_constant_ROSY_BROWN>`
  629. Rosy brown color.
  630. .. _class_Color_constant_ROYAL_BLUE:
  631. .. rst-class:: classref-constant
  632. **ROYAL_BLUE** = ``Color(0.254902, 0.411765, 0.882353, 1)`` :ref:`๐Ÿ”—<class_Color_constant_ROYAL_BLUE>`
  633. Royal blue color.
  634. .. _class_Color_constant_SADDLE_BROWN:
  635. .. rst-class:: classref-constant
  636. **SADDLE_BROWN** = ``Color(0.545098, 0.270588, 0.0745098, 1)`` :ref:`๐Ÿ”—<class_Color_constant_SADDLE_BROWN>`
  637. Saddle brown color.
  638. .. _class_Color_constant_SALMON:
  639. .. rst-class:: classref-constant
  640. **SALMON** = ``Color(0.980392, 0.501961, 0.447059, 1)`` :ref:`๐Ÿ”—<class_Color_constant_SALMON>`
  641. Salmon color.
  642. .. _class_Color_constant_SANDY_BROWN:
  643. .. rst-class:: classref-constant
  644. **SANDY_BROWN** = ``Color(0.956863, 0.643137, 0.376471, 1)`` :ref:`๐Ÿ”—<class_Color_constant_SANDY_BROWN>`
  645. Sandy brown color.
  646. .. _class_Color_constant_SEA_GREEN:
  647. .. rst-class:: classref-constant
  648. **SEA_GREEN** = ``Color(0.180392, 0.545098, 0.341176, 1)`` :ref:`๐Ÿ”—<class_Color_constant_SEA_GREEN>`
  649. Sea green color.
  650. .. _class_Color_constant_SEASHELL:
  651. .. rst-class:: classref-constant
  652. **SEASHELL** = ``Color(1, 0.960784, 0.933333, 1)`` :ref:`๐Ÿ”—<class_Color_constant_SEASHELL>`
  653. Seashell color.
  654. .. _class_Color_constant_SIENNA:
  655. .. rst-class:: classref-constant
  656. **SIENNA** = ``Color(0.627451, 0.321569, 0.176471, 1)`` :ref:`๐Ÿ”—<class_Color_constant_SIENNA>`
  657. Sienna color.
  658. .. _class_Color_constant_SILVER:
  659. .. rst-class:: classref-constant
  660. **SILVER** = ``Color(0.752941, 0.752941, 0.752941, 1)`` :ref:`๐Ÿ”—<class_Color_constant_SILVER>`
  661. Silver color.
  662. .. _class_Color_constant_SKY_BLUE:
  663. .. rst-class:: classref-constant
  664. **SKY_BLUE** = ``Color(0.529412, 0.807843, 0.921569, 1)`` :ref:`๐Ÿ”—<class_Color_constant_SKY_BLUE>`
  665. Sky blue color.
  666. .. _class_Color_constant_SLATE_BLUE:
  667. .. rst-class:: classref-constant
  668. **SLATE_BLUE** = ``Color(0.415686, 0.352941, 0.803922, 1)`` :ref:`๐Ÿ”—<class_Color_constant_SLATE_BLUE>`
  669. Slate blue color.
  670. .. _class_Color_constant_SLATE_GRAY:
  671. .. rst-class:: classref-constant
  672. **SLATE_GRAY** = ``Color(0.439216, 0.501961, 0.564706, 1)`` :ref:`๐Ÿ”—<class_Color_constant_SLATE_GRAY>`
  673. Slate gray color.
  674. .. _class_Color_constant_SNOW:
  675. .. rst-class:: classref-constant
  676. **SNOW** = ``Color(1, 0.980392, 0.980392, 1)`` :ref:`๐Ÿ”—<class_Color_constant_SNOW>`
  677. Snow color.
  678. .. _class_Color_constant_SPRING_GREEN:
  679. .. rst-class:: classref-constant
  680. **SPRING_GREEN** = ``Color(0, 1, 0.498039, 1)`` :ref:`๐Ÿ”—<class_Color_constant_SPRING_GREEN>`
  681. Spring green color.
  682. .. _class_Color_constant_STEEL_BLUE:
  683. .. rst-class:: classref-constant
  684. **STEEL_BLUE** = ``Color(0.27451, 0.509804, 0.705882, 1)`` :ref:`๐Ÿ”—<class_Color_constant_STEEL_BLUE>`
  685. Steel blue color.
  686. .. _class_Color_constant_TAN:
  687. .. rst-class:: classref-constant
  688. **TAN** = ``Color(0.823529, 0.705882, 0.54902, 1)`` :ref:`๐Ÿ”—<class_Color_constant_TAN>`
  689. Tan color.
  690. .. _class_Color_constant_TEAL:
  691. .. rst-class:: classref-constant
  692. **TEAL** = ``Color(0, 0.501961, 0.501961, 1)`` :ref:`๐Ÿ”—<class_Color_constant_TEAL>`
  693. Teal color.
  694. .. _class_Color_constant_THISTLE:
  695. .. rst-class:: classref-constant
  696. **THISTLE** = ``Color(0.847059, 0.74902, 0.847059, 1)`` :ref:`๐Ÿ”—<class_Color_constant_THISTLE>`
  697. Thistle color.
  698. .. _class_Color_constant_TOMATO:
  699. .. rst-class:: classref-constant
  700. **TOMATO** = ``Color(1, 0.388235, 0.278431, 1)`` :ref:`๐Ÿ”—<class_Color_constant_TOMATO>`
  701. Tomato color.
  702. .. _class_Color_constant_TRANSPARENT:
  703. .. rst-class:: classref-constant
  704. **TRANSPARENT** = ``Color(1, 1, 1, 0)`` :ref:`๐Ÿ”—<class_Color_constant_TRANSPARENT>`
  705. Transparent color (white with zero alpha).
  706. .. _class_Color_constant_TURQUOISE:
  707. .. rst-class:: classref-constant
  708. **TURQUOISE** = ``Color(0.25098, 0.878431, 0.815686, 1)`` :ref:`๐Ÿ”—<class_Color_constant_TURQUOISE>`
  709. Turquoise color.
  710. .. _class_Color_constant_VIOLET:
  711. .. rst-class:: classref-constant
  712. **VIOLET** = ``Color(0.933333, 0.509804, 0.933333, 1)`` :ref:`๐Ÿ”—<class_Color_constant_VIOLET>`
  713. Violet color.
  714. .. _class_Color_constant_WEB_GRAY:
  715. .. rst-class:: classref-constant
  716. **WEB_GRAY** = ``Color(0.501961, 0.501961, 0.501961, 1)`` :ref:`๐Ÿ”—<class_Color_constant_WEB_GRAY>`
  717. Web gray color.
  718. .. _class_Color_constant_WEB_GREEN:
  719. .. rst-class:: classref-constant
  720. **WEB_GREEN** = ``Color(0, 0.501961, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_WEB_GREEN>`
  721. Web green color.
  722. .. _class_Color_constant_WEB_MAROON:
  723. .. rst-class:: classref-constant
  724. **WEB_MAROON** = ``Color(0.501961, 0, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_WEB_MAROON>`
  725. Web maroon color.
  726. .. _class_Color_constant_WEB_PURPLE:
  727. .. rst-class:: classref-constant
  728. **WEB_PURPLE** = ``Color(0.501961, 0, 0.501961, 1)`` :ref:`๐Ÿ”—<class_Color_constant_WEB_PURPLE>`
  729. Web purple color.
  730. .. _class_Color_constant_WHEAT:
  731. .. rst-class:: classref-constant
  732. **WHEAT** = ``Color(0.960784, 0.870588, 0.701961, 1)`` :ref:`๐Ÿ”—<class_Color_constant_WHEAT>`
  733. Wheat color.
  734. .. _class_Color_constant_WHITE:
  735. .. rst-class:: classref-constant
  736. **WHITE** = ``Color(1, 1, 1, 1)`` :ref:`๐Ÿ”—<class_Color_constant_WHITE>`
  737. White color.
  738. .. _class_Color_constant_WHITE_SMOKE:
  739. .. rst-class:: classref-constant
  740. **WHITE_SMOKE** = ``Color(0.960784, 0.960784, 0.960784, 1)`` :ref:`๐Ÿ”—<class_Color_constant_WHITE_SMOKE>`
  741. White smoke color.
  742. .. _class_Color_constant_YELLOW:
  743. .. rst-class:: classref-constant
  744. **YELLOW** = ``Color(1, 1, 0, 1)`` :ref:`๐Ÿ”—<class_Color_constant_YELLOW>`
  745. Yellow color.
  746. .. _class_Color_constant_YELLOW_GREEN:
  747. .. rst-class:: classref-constant
  748. **YELLOW_GREEN** = ``Color(0.603922, 0.803922, 0.196078, 1)`` :ref:`๐Ÿ”—<class_Color_constant_YELLOW_GREEN>`
  749. Yellow green color.
  750. .. rst-class:: classref-section-separator
  751. ----
  752. .. rst-class:: classref-descriptions-group
  753. Property Descriptions
  754. ---------------------
  755. .. _class_Color_property_a:
  756. .. rst-class:: classref-property
  757. :ref:`float<class_float>` **a** = ``1.0`` :ref:`๐Ÿ”—<class_Color_property_a>`
  758. 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.
  759. .. rst-class:: classref-item-separator
  760. ----
  761. .. _class_Color_property_a8:
  762. .. rst-class:: classref-property
  763. :ref:`int<class_int>` **a8** = ``255`` :ref:`๐Ÿ”—<class_Color_property_a8>`
  764. Wrapper for :ref:`a<class_Color_property_a>` that uses the range 0 to 255, instead of 0 to 1.
  765. .. rst-class:: classref-item-separator
  766. ----
  767. .. _class_Color_property_b:
  768. .. rst-class:: classref-property
  769. :ref:`float<class_float>` **b** = ``0.0`` :ref:`๐Ÿ”—<class_Color_property_b>`
  770. The color's blue component, typically on the range of 0 to 1.
  771. .. rst-class:: classref-item-separator
  772. ----
  773. .. _class_Color_property_b8:
  774. .. rst-class:: classref-property
  775. :ref:`int<class_int>` **b8** = ``0`` :ref:`๐Ÿ”—<class_Color_property_b8>`
  776. Wrapper for :ref:`b<class_Color_property_b>` that uses the range 0 to 255, instead of 0 to 1.
  777. .. rst-class:: classref-item-separator
  778. ----
  779. .. _class_Color_property_g:
  780. .. rst-class:: classref-property
  781. :ref:`float<class_float>` **g** = ``0.0`` :ref:`๐Ÿ”—<class_Color_property_g>`
  782. The color's green component, typically on the range of 0 to 1.
  783. .. rst-class:: classref-item-separator
  784. ----
  785. .. _class_Color_property_g8:
  786. .. rst-class:: classref-property
  787. :ref:`int<class_int>` **g8** = ``0`` :ref:`๐Ÿ”—<class_Color_property_g8>`
  788. Wrapper for :ref:`g<class_Color_property_g>` that uses the range 0 to 255, instead of 0 to 1.
  789. .. rst-class:: classref-item-separator
  790. ----
  791. .. _class_Color_property_h:
  792. .. rst-class:: classref-property
  793. :ref:`float<class_float>` **h** = ``0.0`` :ref:`๐Ÿ”—<class_Color_property_h>`
  794. The HSV hue of this color, on the range 0 to 1.
  795. .. rst-class:: classref-item-separator
  796. ----
  797. .. _class_Color_property_r:
  798. .. rst-class:: classref-property
  799. :ref:`float<class_float>` **r** = ``0.0`` :ref:`๐Ÿ”—<class_Color_property_r>`
  800. The color's red component, typically on the range of 0 to 1.
  801. .. rst-class:: classref-item-separator
  802. ----
  803. .. _class_Color_property_r8:
  804. .. rst-class:: classref-property
  805. :ref:`int<class_int>` **r8** = ``0`` :ref:`๐Ÿ”—<class_Color_property_r8>`
  806. Wrapper for :ref:`r<class_Color_property_r>` that uses the range 0 to 255, instead of 0 to 1.
  807. .. rst-class:: classref-item-separator
  808. ----
  809. .. _class_Color_property_s:
  810. .. rst-class:: classref-property
  811. :ref:`float<class_float>` **s** = ``0.0`` :ref:`๐Ÿ”—<class_Color_property_s>`
  812. The HSV saturation of this color, on the range 0 to 1.
  813. .. rst-class:: classref-item-separator
  814. ----
  815. .. _class_Color_property_v:
  816. .. rst-class:: classref-property
  817. :ref:`float<class_float>` **v** = ``0.0`` :ref:`๐Ÿ”—<class_Color_property_v>`
  818. The HSV value (brightness) of this color, on the range 0 to 1.
  819. .. rst-class:: classref-section-separator
  820. ----
  821. .. rst-class:: classref-descriptions-group
  822. Constructor Descriptions
  823. ------------------------
  824. .. _class_Color_constructor_Color:
  825. .. rst-class:: classref-constructor
  826. :ref:`Color<class_Color>` **Color**\ (\ ) :ref:`๐Ÿ”—<class_Color_constructor_Color>`
  827. Constructs a default **Color** from opaque black. This is the same as :ref:`BLACK<class_Color_constant_BLACK>`.
  828. \ **Note:** in C#, constructs an empty color with all of its components set to ``0.0`` (transparent black).
  829. .. rst-class:: classref-item-separator
  830. ----
  831. .. rst-class:: classref-constructor
  832. :ref:`Color<class_Color>` **Color**\ (\ from\: :ref:`Color<class_Color>`, alpha\: :ref:`float<class_float>`\ )
  833. Constructs a **Color** from the existing color, with :ref:`a<class_Color_property_a>` set to the given ``alpha`` value.
  834. .. tabs::
  835. .. code-tab:: gdscript
  836. var red = Color(Color.RED, 0.2) # 20% opaque red.
  837. .. code-tab:: csharp
  838. var red = new Color(Colors.Red, 0.2f); // 20% opaque red.
  839. .. rst-class:: classref-item-separator
  840. ----
  841. .. rst-class:: classref-constructor
  842. :ref:`Color<class_Color>` **Color**\ (\ from\: :ref:`Color<class_Color>`\ )
  843. Constructs a **Color** as a copy of the given **Color**.
  844. .. rst-class:: classref-item-separator
  845. ----
  846. .. rst-class:: classref-constructor
  847. :ref:`Color<class_Color>` **Color**\ (\ code\: :ref:`String<class_String>`\ )
  848. 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.
  849. .. rst-class:: classref-item-separator
  850. ----
  851. .. rst-class:: classref-constructor
  852. :ref:`Color<class_Color>` **Color**\ (\ code\: :ref:`String<class_String>`, alpha\: :ref:`float<class_float>`\ )
  853. 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.
  854. .. rst-class:: classref-item-separator
  855. ----
  856. .. rst-class:: classref-constructor
  857. :ref:`Color<class_Color>` **Color**\ (\ r\: :ref:`float<class_float>`, g\: :ref:`float<class_float>`, b\: :ref:`float<class_float>`\ )
  858. Constructs a **Color** from RGB values, typically between 0.0 and 1.0. :ref:`a<class_Color_property_a>` is set to 1.0.
  859. .. tabs::
  860. .. code-tab:: gdscript
  861. var color = Color(0.2, 1.0, 0.7) # Similar to `Color8(51, 255, 178, 255)`
  862. .. code-tab:: csharp
  863. var color = new Color(0.2f, 1.0f, 0.7f); // Similar to `Color.Color8(51, 255, 178, 255)`
  864. .. rst-class:: classref-item-separator
  865. ----
  866. .. rst-class:: classref-constructor
  867. :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>`\ )
  868. Constructs a **Color** from RGBA values, typically between 0.0 and 1.0.
  869. .. tabs::
  870. .. code-tab:: gdscript
  871. var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to `Color8(51, 255, 178, 204)`
  872. .. code-tab:: csharp
  873. var color = new Color(0.2f, 1.0f, 0.7f, 0.8f); // Similar to `Color.Color8(51, 255, 178, 255, 204)`
  874. .. rst-class:: classref-section-separator
  875. ----
  876. .. rst-class:: classref-descriptions-group
  877. Method Descriptions
  878. -------------------
  879. .. _class_Color_method_blend:
  880. .. rst-class:: classref-method
  881. :ref:`Color<class_Color>` **blend**\ (\ over\: :ref:`Color<class_Color>`\ ) |const| :ref:`๐Ÿ”—<class_Color_method_blend>`
  882. 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).
  883. .. tabs::
  884. .. code-tab:: gdscript
  885. var bg = Color(0.0, 1.0, 0.0, 0.5) # Green with alpha of 50%
  886. var fg = Color(1.0, 0.0, 0.0, 0.5) # Red with alpha of 50%
  887. var blended_color = bg.blend(fg) # Brown with alpha of 75%
  888. .. code-tab:: csharp
  889. var bg = new Color(0.0f, 1.0f, 0.0f, 0.5f); // Green with alpha of 50%
  890. var fg = new Color(1.0f, 0.0f, 0.0f, 0.5f); // Red with alpha of 50%
  891. Color blendedColor = bg.Blend(fg); // Brown with alpha of 75%
  892. .. rst-class:: classref-item-separator
  893. ----
  894. .. _class_Color_method_clamp:
  895. .. rst-class:: classref-method
  896. :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>`
  897. 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.
  898. .. rst-class:: classref-item-separator
  899. ----
  900. .. _class_Color_method_darkened:
  901. .. rst-class:: classref-method
  902. :ref:`Color<class_Color>` **darkened**\ (\ amount\: :ref:`float<class_float>`\ ) |const| :ref:`๐Ÿ”—<class_Color_method_darkened>`
  903. 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>`.
  904. .. tabs::
  905. .. code-tab:: gdscript
  906. var green = Color(0.0, 1.0, 0.0)
  907. var darkgreen = green.darkened(0.2) # 20% darker than regular green
  908. .. code-tab:: csharp
  909. var green = new Color(0.0f, 1.0f, 0.0f);
  910. Color darkgreen = green.Darkened(0.2f); // 20% darker than regular green
  911. .. rst-class:: classref-item-separator
  912. ----
  913. .. _class_Color_method_from_hsv:
  914. .. rst-class:: classref-method
  915. :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>`
  916. 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.
  917. .. tabs::
  918. .. code-tab:: gdscript
  919. var color = Color.from_hsv(0.58, 0.5, 0.79, 0.8)
  920. .. code-tab:: csharp
  921. var color = Color.FromHsv(0.58f, 0.5f, 0.79f, 0.8f);
  922. .. rst-class:: classref-item-separator
  923. ----
  924. .. _class_Color_method_from_ok_hsl:
  925. .. rst-class:: classref-method
  926. :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>`
  927. 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.
  928. .. tabs::
  929. .. code-tab:: gdscript
  930. var color = Color.from_ok_hsl(0.58, 0.5, 0.79, 0.8)
  931. .. code-tab:: csharp
  932. var color = Color.FromOkHsl(0.58f, 0.5f, 0.79f, 0.8f);
  933. .. rst-class:: classref-item-separator
  934. ----
  935. .. _class_Color_method_from_rgbe9995:
  936. .. rst-class:: classref-method
  937. :ref:`Color<class_Color>` **from_rgbe9995**\ (\ rgbe\: :ref:`int<class_int>`\ ) |static| :ref:`๐Ÿ”—<class_Color_method_from_rgbe9995>`
  938. Decodes a **Color** from an RGBE9995 format integer. See :ref:`Image.FORMAT_RGBE9995<class_Image_constant_FORMAT_RGBE9995>`.
  939. .. rst-class:: classref-item-separator
  940. ----
  941. .. _class_Color_method_from_string:
  942. .. rst-class:: classref-method
  943. :ref:`Color<class_Color>` **from_string**\ (\ str\: :ref:`String<class_String>`, default\: :ref:`Color<class_Color>`\ ) |static| :ref:`๐Ÿ”—<class_Color_method_from_string>`
  944. 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.
  945. If you want to create a color from String in a constant expression, use the equivalent constructor instead (i.e. ``Color("color string")``).
  946. .. rst-class:: classref-item-separator
  947. ----
  948. .. _class_Color_method_get_luminance:
  949. .. rst-class:: classref-method
  950. :ref:`float<class_float>` **get_luminance**\ (\ ) |const| :ref:`๐Ÿ”—<class_Color_method_get_luminance>`
  951. 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.
  952. \ **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.
  953. .. rst-class:: classref-item-separator
  954. ----
  955. .. _class_Color_method_hex:
  956. .. rst-class:: classref-method
  957. :ref:`Color<class_Color>` **hex**\ (\ hex\: :ref:`int<class_int>`\ ) |static| :ref:`๐Ÿ”—<class_Color_method_hex>`
  958. 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>`.
  959. In GDScript and C#, the :ref:`int<class_int>` is best visualized with hexadecimal notation (``"0x"`` prefix, making it ``"0xRRGGBBAA"``).
  960. .. tabs::
  961. .. code-tab:: gdscript
  962. var red = Color.hex(0xff0000ff)
  963. var dark_cyan = Color.hex(0x008b8bff)
  964. var my_color = Color.hex(0xbbefd2a4)
  965. .. code-tab:: csharp
  966. var red = new Color(0xff0000ff);
  967. var dark_cyan = new Color(0x008b8bff);
  968. var my_color = new Color(0xbbefd2a4);
  969. If you want to use hex notation in a constant expression, use the equivalent constructor instead (i.e. ``Color(0xRRGGBBAA)``).
  970. .. rst-class:: classref-item-separator
  971. ----
  972. .. _class_Color_method_hex64:
  973. .. rst-class:: classref-method
  974. :ref:`Color<class_Color>` **hex64**\ (\ hex\: :ref:`int<class_int>`\ ) |static| :ref:`๐Ÿ”—<class_Color_method_hex64>`
  975. 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>`.
  976. In GDScript and C#, the :ref:`int<class_int>` is best visualized with hexadecimal notation (``"0x"`` prefix, making it ``"0xRRRRGGGGBBBBAAAA"``).
  977. .. rst-class:: classref-item-separator
  978. ----
  979. .. _class_Color_method_html:
  980. .. rst-class:: classref-method
  981. :ref:`Color<class_Color>` **html**\ (\ rgba\: :ref:`String<class_String>`\ ) |static| :ref:`๐Ÿ”—<class_Color_method_html>`
  982. Returns a new color from ``rgba``, an HTML hexadecimal color string. ``rgba`` is not case-sensitive, and may be prefixed by a hash sign (``#``).
  983. \ ``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.
  984. .. tabs::
  985. .. code-tab:: gdscript
  986. var blue = Color.html("#0000ff") # blue is Color(0.0, 0.0, 1.0, 1.0)
  987. var green = Color.html("#0F0") # green is Color(0.0, 1.0, 0.0, 1.0)
  988. var col = Color.html("663399cc") # col is Color(0.4, 0.2, 0.6, 0.8)
  989. .. code-tab:: csharp
  990. var blue = Color.FromHtml("#0000ff"); // blue is Color(0.0, 0.0, 1.0, 1.0)
  991. var green = Color.FromHtml("#0F0"); // green is Color(0.0, 1.0, 0.0, 1.0)
  992. var col = Color.FromHtml("663399cc"); // col is Color(0.4, 0.2, 0.6, 0.8)
  993. .. rst-class:: classref-item-separator
  994. ----
  995. .. _class_Color_method_html_is_valid:
  996. .. rst-class:: classref-method
  997. :ref:`bool<class_bool>` **html_is_valid**\ (\ color\: :ref:`String<class_String>`\ ) |static| :ref:`๐Ÿ”—<class_Color_method_html_is_valid>`
  998. 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>`.
  999. .. tabs::
  1000. .. code-tab:: gdscript
  1001. Color.html_is_valid("#55aaFF") # Returns true
  1002. Color.html_is_valid("#55AAFF20") # Returns true
  1003. Color.html_is_valid("55AAFF") # Returns true
  1004. Color.html_is_valid("#F2C") # Returns true
  1005. Color.html_is_valid("#AABBC") # Returns false
  1006. Color.html_is_valid("#55aaFF5") # Returns false
  1007. .. code-tab:: csharp
  1008. Color.HtmlIsValid("#55AAFF"); // Returns true
  1009. Color.HtmlIsValid("#55AAFF20"); // Returns true
  1010. Color.HtmlIsValid("55AAFF"); // Returns true
  1011. Color.HtmlIsValid("#F2C"); // Returns true
  1012. Color.HtmlIsValid("#AABBC"); // Returns false
  1013. Color.HtmlIsValid("#55aaFF5"); // Returns false
  1014. .. rst-class:: classref-item-separator
  1015. ----
  1016. .. _class_Color_method_inverted:
  1017. .. rst-class:: classref-method
  1018. :ref:`Color<class_Color>` **inverted**\ (\ ) |const| :ref:`๐Ÿ”—<class_Color_method_inverted>`
  1019. 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)``).
  1020. .. tabs::
  1021. .. code-tab:: gdscript
  1022. var black = Color.WHITE.inverted()
  1023. var color = Color(0.3, 0.4, 0.9)
  1024. var inverted_color = color.inverted() # Equivalent to `Color(0.7, 0.6, 0.1)`
  1025. .. code-tab:: csharp
  1026. var black = Colors.White.Inverted();
  1027. var color = new Color(0.3f, 0.4f, 0.9f);
  1028. Color invertedColor = color.Inverted(); // Equivalent to `new Color(0.7f, 0.6f, 0.1f)`
  1029. .. rst-class:: classref-item-separator
  1030. ----
  1031. .. _class_Color_method_is_equal_approx:
  1032. .. rst-class:: classref-method
  1033. :ref:`bool<class_bool>` **is_equal_approx**\ (\ to\: :ref:`Color<class_Color>`\ ) |const| :ref:`๐Ÿ”—<class_Color_method_is_equal_approx>`
  1034. 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.
  1035. .. rst-class:: classref-item-separator
  1036. ----
  1037. .. _class_Color_method_lerp:
  1038. .. rst-class:: classref-method
  1039. :ref:`Color<class_Color>` **lerp**\ (\ to\: :ref:`Color<class_Color>`, weight\: :ref:`float<class_float>`\ ) |const| :ref:`๐Ÿ”—<class_Color_method_lerp>`
  1040. 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>`.
  1041. .. tabs::
  1042. .. code-tab:: gdscript
  1043. var red = Color(1.0, 0.0, 0.0)
  1044. var aqua = Color(0.0, 1.0, 0.8)
  1045. red.lerp(aqua, 0.2) # Returns Color(0.8, 0.2, 0.16)
  1046. red.lerp(aqua, 0.5) # Returns Color(0.5, 0.5, 0.4)
  1047. red.lerp(aqua, 1.0) # Returns Color(0.0, 1.0, 0.8)
  1048. .. code-tab:: csharp
  1049. var red = new Color(1.0f, 0.0f, 0.0f);
  1050. var aqua = new Color(0.0f, 1.0f, 0.8f);
  1051. red.Lerp(aqua, 0.2f); // Returns Color(0.8f, 0.2f, 0.16f)
  1052. red.Lerp(aqua, 0.5f); // Returns Color(0.5f, 0.5f, 0.4f)
  1053. red.Lerp(aqua, 1.0f); // Returns Color(0.0f, 1.0f, 0.8f)
  1054. .. rst-class:: classref-item-separator
  1055. ----
  1056. .. _class_Color_method_lightened:
  1057. .. rst-class:: classref-method
  1058. :ref:`Color<class_Color>` **lightened**\ (\ amount\: :ref:`float<class_float>`\ ) |const| :ref:`๐Ÿ”—<class_Color_method_lightened>`
  1059. 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>`.
  1060. .. tabs::
  1061. .. code-tab:: gdscript
  1062. var green = Color(0.0, 1.0, 0.0)
  1063. var light_green = green.lightened(0.2) # 20% lighter than regular green
  1064. .. code-tab:: csharp
  1065. var green = new Color(0.0f, 1.0f, 0.0f);
  1066. Color lightGreen = green.Lightened(0.2f); // 20% lighter than regular green
  1067. .. rst-class:: classref-item-separator
  1068. ----
  1069. .. _class_Color_method_linear_to_srgb:
  1070. .. rst-class:: classref-method
  1071. :ref:`Color<class_Color>` **linear_to_srgb**\ (\ ) |const| :ref:`๐Ÿ”—<class_Color_method_linear_to_srgb>`
  1072. 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.
  1073. .. rst-class:: classref-item-separator
  1074. ----
  1075. .. _class_Color_method_srgb_to_linear:
  1076. .. rst-class:: classref-method
  1077. :ref:`Color<class_Color>` **srgb_to_linear**\ (\ ) |const| :ref:`๐Ÿ”—<class_Color_method_srgb_to_linear>`
  1078. 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.
  1079. .. rst-class:: classref-item-separator
  1080. ----
  1081. .. _class_Color_method_to_abgr32:
  1082. .. rst-class:: classref-method
  1083. :ref:`int<class_int>` **to_abgr32**\ (\ ) |const| :ref:`๐Ÿ”—<class_Color_method_to_abgr32>`
  1084. 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.
  1085. .. tabs::
  1086. .. code-tab:: gdscript
  1087. var color = Color(1, 0.5, 0.2)
  1088. print(color.to_abgr32()) # Prints 4281565439
  1089. .. code-tab:: csharp
  1090. var color = new Color(1.0f, 0.5f, 0.2f);
  1091. GD.Print(color.ToAbgr32()); // Prints 4281565439
  1092. .. rst-class:: classref-item-separator
  1093. ----
  1094. .. _class_Color_method_to_abgr64:
  1095. .. rst-class:: classref-method
  1096. :ref:`int<class_int>` **to_abgr64**\ (\ ) |const| :ref:`๐Ÿ”—<class_Color_method_to_abgr64>`
  1097. 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.
  1098. .. tabs::
  1099. .. code-tab:: gdscript
  1100. var color = Color(1, 0.5, 0.2)
  1101. print(color.to_abgr64()) # Prints -225178692812801
  1102. .. code-tab:: csharp
  1103. var color = new Color(1.0f, 0.5f, 0.2f);
  1104. GD.Print(color.ToAbgr64()); // Prints -225178692812801
  1105. .. rst-class:: classref-item-separator
  1106. ----
  1107. .. _class_Color_method_to_argb32:
  1108. .. rst-class:: classref-method
  1109. :ref:`int<class_int>` **to_argb32**\ (\ ) |const| :ref:`๐Ÿ”—<class_Color_method_to_argb32>`
  1110. Returns the color converted to a 32-bit integer in ARGB format (each component is 8 bits). ARGB is more compatible with DirectX.
  1111. .. tabs::
  1112. .. code-tab:: gdscript
  1113. var color = Color(1, 0.5, 0.2)
  1114. print(color.to_argb32()) # Prints 4294934323
  1115. .. code-tab:: csharp
  1116. var color = new Color(1.0f, 0.5f, 0.2f);
  1117. GD.Print(color.ToArgb32()); // Prints 4294934323
  1118. .. rst-class:: classref-item-separator
  1119. ----
  1120. .. _class_Color_method_to_argb64:
  1121. .. rst-class:: classref-method
  1122. :ref:`int<class_int>` **to_argb64**\ (\ ) |const| :ref:`๐Ÿ”—<class_Color_method_to_argb64>`
  1123. Returns the color converted to a 64-bit integer in ARGB format (each component is 16 bits). ARGB is more compatible with DirectX.
  1124. .. tabs::
  1125. .. code-tab:: gdscript
  1126. var color = Color(1, 0.5, 0.2)
  1127. print(color.to_argb64()) # Prints -2147470541
  1128. .. code-tab:: csharp
  1129. var color = new Color(1.0f, 0.5f, 0.2f);
  1130. GD.Print(color.ToArgb64()); // Prints -2147470541
  1131. .. rst-class:: classref-item-separator
  1132. ----
  1133. .. _class_Color_method_to_html:
  1134. .. rst-class:: classref-method
  1135. :ref:`String<class_String>` **to_html**\ (\ with_alpha\: :ref:`bool<class_bool>` = true\ ) |const| :ref:`๐Ÿ”—<class_Color_method_to_html>`
  1136. Returns the color converted to an HTML hexadecimal color :ref:`String<class_String>` in RGBA format, without the hash (``#``) prefix.
  1137. Setting ``with_alpha`` to ``false``, excludes alpha from the hexadecimal string, using RGB format instead of RGBA format.
  1138. .. tabs::
  1139. .. code-tab:: gdscript
  1140. var white = Color(1, 1, 1, 0.5)
  1141. var with_alpha = white.to_html() # Returns "ffffff7f"
  1142. var without_alpha = white.to_html(false) # Returns "ffffff"
  1143. .. code-tab:: csharp
  1144. var white = new Color(1, 1, 1, 0.5f);
  1145. string withAlpha = white.ToHtml(); // Returns "ffffff7f"
  1146. string withoutAlpha = white.ToHtml(false); // Returns "ffffff"
  1147. .. rst-class:: classref-item-separator
  1148. ----
  1149. .. _class_Color_method_to_rgba32:
  1150. .. rst-class:: classref-method
  1151. :ref:`int<class_int>` **to_rgba32**\ (\ ) |const| :ref:`๐Ÿ”—<class_Color_method_to_rgba32>`
  1152. 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>`.
  1153. .. tabs::
  1154. .. code-tab:: gdscript
  1155. var color = Color(1, 0.5, 0.2)
  1156. print(color.to_rgba32()) # Prints 4286526463
  1157. .. code-tab:: csharp
  1158. var color = new Color(1, 0.5f, 0.2f);
  1159. GD.Print(color.ToRgba32()); // Prints 4286526463
  1160. .. rst-class:: classref-item-separator
  1161. ----
  1162. .. _class_Color_method_to_rgba64:
  1163. .. rst-class:: classref-method
  1164. :ref:`int<class_int>` **to_rgba64**\ (\ ) |const| :ref:`๐Ÿ”—<class_Color_method_to_rgba64>`
  1165. 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>`.
  1166. .. tabs::
  1167. .. code-tab:: gdscript
  1168. var color = Color(1, 0.5, 0.2)
  1169. print(color.to_rgba64()) # Prints -140736629309441
  1170. .. code-tab:: csharp
  1171. var color = new Color(1, 0.5f, 0.2f);
  1172. GD.Print(color.ToRgba64()); // Prints -140736629309441
  1173. .. rst-class:: classref-section-separator
  1174. ----
  1175. .. rst-class:: classref-descriptions-group
  1176. Operator Descriptions
  1177. ---------------------
  1178. .. _class_Color_operator_neq_Color:
  1179. .. rst-class:: classref-operator
  1180. :ref:`bool<class_bool>` **operator !=**\ (\ right\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_Color_operator_neq_Color>`
  1181. Returns ``true`` if the colors are not exactly equal.
  1182. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Color_method_is_equal_approx>` instead, which is more reliable.
  1183. .. rst-class:: classref-item-separator
  1184. ----
  1185. .. _class_Color_operator_mul_Color:
  1186. .. rst-class:: classref-operator
  1187. :ref:`Color<class_Color>` **operator ***\ (\ right\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_Color_operator_mul_Color>`
  1188. Multiplies each component of the **Color** by the components of the given **Color**.
  1189. .. rst-class:: classref-item-separator
  1190. ----
  1191. .. _class_Color_operator_mul_float:
  1192. .. rst-class:: classref-operator
  1193. :ref:`Color<class_Color>` **operator ***\ (\ right\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_Color_operator_mul_float>`
  1194. Multiplies each component of the **Color** by the given :ref:`float<class_float>`.
  1195. .. rst-class:: classref-item-separator
  1196. ----
  1197. .. _class_Color_operator_mul_int:
  1198. .. rst-class:: classref-operator
  1199. :ref:`Color<class_Color>` **operator ***\ (\ right\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_Color_operator_mul_int>`
  1200. Multiplies each component of the **Color** by the given :ref:`int<class_int>`.
  1201. .. rst-class:: classref-item-separator
  1202. ----
  1203. .. _class_Color_operator_sum_Color:
  1204. .. rst-class:: classref-operator
  1205. :ref:`Color<class_Color>` **operator +**\ (\ right\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_Color_operator_sum_Color>`
  1206. Adds each component of the **Color** with the components of the given **Color**.
  1207. .. rst-class:: classref-item-separator
  1208. ----
  1209. .. _class_Color_operator_dif_Color:
  1210. .. rst-class:: classref-operator
  1211. :ref:`Color<class_Color>` **operator -**\ (\ right\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_Color_operator_dif_Color>`
  1212. Subtracts each component of the **Color** by the components of the given **Color**.
  1213. .. rst-class:: classref-item-separator
  1214. ----
  1215. .. _class_Color_operator_div_Color:
  1216. .. rst-class:: classref-operator
  1217. :ref:`Color<class_Color>` **operator /**\ (\ right\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_Color_operator_div_Color>`
  1218. Divides each component of the **Color** by the components of the given **Color**.
  1219. .. rst-class:: classref-item-separator
  1220. ----
  1221. .. _class_Color_operator_div_float:
  1222. .. rst-class:: classref-operator
  1223. :ref:`Color<class_Color>` **operator /**\ (\ right\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_Color_operator_div_float>`
  1224. Divides each component of the **Color** by the given :ref:`float<class_float>`.
  1225. .. rst-class:: classref-item-separator
  1226. ----
  1227. .. _class_Color_operator_div_int:
  1228. .. rst-class:: classref-operator
  1229. :ref:`Color<class_Color>` **operator /**\ (\ right\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_Color_operator_div_int>`
  1230. Divides each component of the **Color** by the given :ref:`int<class_int>`.
  1231. .. rst-class:: classref-item-separator
  1232. ----
  1233. .. _class_Color_operator_eq_Color:
  1234. .. rst-class:: classref-operator
  1235. :ref:`bool<class_bool>` **operator ==**\ (\ right\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_Color_operator_eq_Color>`
  1236. Returns ``true`` if the colors are exactly equal.
  1237. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Color_method_is_equal_approx>` instead, which is more reliable.
  1238. .. rst-class:: classref-item-separator
  1239. ----
  1240. .. _class_Color_operator_idx_int:
  1241. .. rst-class:: classref-operator
  1242. :ref:`float<class_float>` **operator []**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_Color_operator_idx_int>`
  1243. 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>`.
  1244. .. rst-class:: classref-item-separator
  1245. ----
  1246. .. _class_Color_operator_unplus:
  1247. .. rst-class:: classref-operator
  1248. :ref:`Color<class_Color>` **operator unary+**\ (\ ) :ref:`๐Ÿ”—<class_Color_operator_unplus>`
  1249. Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable.
  1250. .. rst-class:: classref-item-separator
  1251. ----
  1252. .. _class_Color_operator_unminus:
  1253. .. rst-class:: classref-operator
  1254. :ref:`Color<class_Color>` **operator unary-**\ (\ ) :ref:`๐Ÿ”—<class_Color_operator_unminus>`
  1255. 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.
  1256. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  1257. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  1258. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  1259. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  1260. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  1261. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  1262. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  1263. .. |void| replace:: :abbr:`void (No return value.)`