class_color.rst 80 KB

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