class_color.rst 70 KB

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