class_color.rst 54 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the Color.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_Color:
  6. Color
  7. =====
  8. Color in RGBA format using floats on the range of 0 to 1.
  9. Description
  10. -----------
  11. A color represented by red, green, blue, and alpha (RGBA) components. The alpha component is often used for transparency. Values are in floating-point and usually range from 0 to 1. Some properties (such as CanvasItem.modulate) may accept values greater than 1 (overbright or HDR colors).
  12. You can also create a color from standardized color names by using the string constructor or directly using the color constants defined here. The standardized color set is based on the `X11 color names <https://en.wikipedia.org/wiki/X11_color_names>`__.
  13. If you want to supply values in a range of 0 to 255, you should use :ref:`@GDScript.Color8<class_@GDScript_method_Color8>`.
  14. **Note:** In a boolean context, a Color will evaluate to ``false`` if it's equal to ``Color(0, 0, 0, 1)`` (opaque black). Otherwise, a Color will always evaluate to ``true``.
  15. `Color constants cheatsheet <https://raw.githubusercontent.com/godotengine/godot-docs/master/img/color_constants.png>`__
  16. Tutorials
  17. ---------
  18. - `2D GD Paint Demo <https://godotengine.org/asset-library/asset/517>`__
  19. - `Tween Demo <https://godotengine.org/asset-library/asset/146>`__
  20. - `GUI Drag And Drop Demo <https://godotengine.org/asset-library/asset/133>`__
  21. Properties
  22. ----------
  23. +---------------------------+------------------------------------+---------+
  24. | :ref:`float<class_float>` | :ref:`a<class_Color_property_a>` | ``1.0`` |
  25. +---------------------------+------------------------------------+---------+
  26. | :ref:`int<class_int>` | :ref:`a8<class_Color_property_a8>` | ``255`` |
  27. +---------------------------+------------------------------------+---------+
  28. | :ref:`float<class_float>` | :ref:`b<class_Color_property_b>` | ``0.0`` |
  29. +---------------------------+------------------------------------+---------+
  30. | :ref:`int<class_int>` | :ref:`b8<class_Color_property_b8>` | ``0`` |
  31. +---------------------------+------------------------------------+---------+
  32. | :ref:`float<class_float>` | :ref:`g<class_Color_property_g>` | ``0.0`` |
  33. +---------------------------+------------------------------------+---------+
  34. | :ref:`int<class_int>` | :ref:`g8<class_Color_property_g8>` | ``0`` |
  35. +---------------------------+------------------------------------+---------+
  36. | :ref:`float<class_float>` | :ref:`h<class_Color_property_h>` | ``0.0`` |
  37. +---------------------------+------------------------------------+---------+
  38. | :ref:`float<class_float>` | :ref:`r<class_Color_property_r>` | ``0.0`` |
  39. +---------------------------+------------------------------------+---------+
  40. | :ref:`int<class_int>` | :ref:`r8<class_Color_property_r8>` | ``0`` |
  41. +---------------------------+------------------------------------+---------+
  42. | :ref:`float<class_float>` | :ref:`s<class_Color_property_s>` | ``0.0`` |
  43. +---------------------------+------------------------------------+---------+
  44. | :ref:`float<class_float>` | :ref:`v<class_Color_property_v>` | ``0.0`` |
  45. +---------------------------+------------------------------------+---------+
  46. Constructors
  47. ------------
  48. +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>` **(** **)** |
  50. +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>` **(** :ref:`Color<class_Color>` from, :ref:`float<class_float>` alpha **)** |
  52. +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>` **(** :ref:`Color<class_Color>` from **)** |
  54. +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>` **(** :ref:`String<class_String>` code **)** |
  56. +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_constructor_Color>` **(** :ref:`String<class_String>` code, :ref:`float<class_float>` alpha **)** |
  58. +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :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 **)** |
  60. +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | :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 **)** |
  62. +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. Methods
  64. -------
  65. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`Color<class_Color>` | :ref:`blend<class_Color_method_blend>` **(** :ref:`Color<class_Color>` over **)** |const| |
  67. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :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| |
  69. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`Color<class_Color>` | :ref:`darkened<class_Color_method_darkened>` **(** :ref:`float<class_float>` amount **)** |const| |
  71. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :ref:`int<class_int>` | :ref:`find_named_color<class_Color_method_find_named_color>` **(** :ref:`String<class_String>` name **)** |static| |
  73. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :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| |
  75. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :ref:`Color<class_Color>` | :ref:`from_rgbe9995<class_Color_method_from_rgbe9995>` **(** :ref:`int<class_int>` rgbe **)** |static| |
  77. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :ref:`Color<class_Color>` | :ref:`from_string<class_Color_method_from_string>` **(** :ref:`String<class_String>` str, :ref:`Color<class_Color>` default **)** |static| |
  79. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | :ref:`Color<class_Color>` | :ref:`get_named_color<class_Color_method_get_named_color>` **(** :ref:`int<class_int>` idx **)** |static| |
  81. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | :ref:`int<class_int>` | :ref:`get_named_color_count<class_Color_method_get_named_color_count>` **(** **)** |static| |
  83. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | :ref:`String<class_String>` | :ref:`get_named_color_name<class_Color_method_get_named_color_name>` **(** :ref:`int<class_int>` idx **)** |static| |
  85. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | :ref:`Color<class_Color>` | :ref:`hex<class_Color_method_hex>` **(** :ref:`int<class_int>` hex **)** |static| |
  87. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | :ref:`Color<class_Color>` | :ref:`hex64<class_Color_method_hex64>` **(** :ref:`int<class_int>` hex **)** |static| |
  89. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :ref:`Color<class_Color>` | :ref:`html<class_Color_method_html>` **(** :ref:`String<class_String>` rgba **)** |static| |
  91. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`bool<class_bool>` | :ref:`html_is_valid<class_Color_method_html_is_valid>` **(** :ref:`String<class_String>` color **)** |static| |
  93. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`Color<class_Color>` | :ref:`inverted<class_Color_method_inverted>` **(** **)** |const| |
  95. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | :ref:`bool<class_bool>` | :ref:`is_equal_approx<class_Color_method_is_equal_approx>` **(** :ref:`Color<class_Color>` to **)** |const| |
  97. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | :ref:`Color<class_Color>` | :ref:`lerp<class_Color_method_lerp>` **(** :ref:`Color<class_Color>` to, :ref:`float<class_float>` weight **)** |const| |
  99. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | :ref:`Color<class_Color>` | :ref:`lightened<class_Color_method_lightened>` **(** :ref:`float<class_float>` amount **)** |const| |
  101. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | :ref:`int<class_int>` | :ref:`to_abgr32<class_Color_method_to_abgr32>` **(** **)** |const| |
  103. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | :ref:`int<class_int>` | :ref:`to_abgr64<class_Color_method_to_abgr64>` **(** **)** |const| |
  105. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | :ref:`int<class_int>` | :ref:`to_argb32<class_Color_method_to_argb32>` **(** **)** |const| |
  107. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | :ref:`int<class_int>` | :ref:`to_argb64<class_Color_method_to_argb64>` **(** **)** |const| |
  109. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | :ref:`String<class_String>` | :ref:`to_html<class_Color_method_to_html>` **(** :ref:`bool<class_bool>` with_alpha=true **)** |const| |
  111. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | :ref:`int<class_int>` | :ref:`to_rgba32<class_Color_method_to_rgba32>` **(** **)** |const| |
  113. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | :ref:`int<class_int>` | :ref:`to_rgba64<class_Color_method_to_rgba64>` **(** **)** |const| |
  115. +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. Operators
  117. ---------
  118. +---------------------------+-----------------------------------------------------------------------------------------------+
  119. | :ref:`bool<class_bool>` | :ref:`operator !=<class_Color_operator_neq_bool>` **(** **)** |
  120. +---------------------------+-----------------------------------------------------------------------------------------------+
  121. | :ref:`bool<class_bool>` | :ref:`operator !=<class_Color_operator_neq_bool>` **(** :ref:`Color<class_Color>` right **)** |
  122. +---------------------------+-----------------------------------------------------------------------------------------------+
  123. | :ref:`Color<class_Color>` | :ref:`operator *<class_Color_operator_mul_Color>` **(** :ref:`Color<class_Color>` right **)** |
  124. +---------------------------+-----------------------------------------------------------------------------------------------+
  125. | :ref:`Color<class_Color>` | :ref:`operator *<class_Color_operator_mul_Color>` **(** :ref:`float<class_float>` right **)** |
  126. +---------------------------+-----------------------------------------------------------------------------------------------+
  127. | :ref:`Color<class_Color>` | :ref:`operator *<class_Color_operator_mul_Color>` **(** :ref:`int<class_int>` right **)** |
  128. +---------------------------+-----------------------------------------------------------------------------------------------+
  129. | :ref:`Color<class_Color>` | :ref:`operator +<class_Color_operator_sum_Color>` **(** :ref:`Color<class_Color>` right **)** |
  130. +---------------------------+-----------------------------------------------------------------------------------------------+
  131. | :ref:`Color<class_Color>` | :ref:`operator -<class_Color_operator_dif_Color>` **(** :ref:`Color<class_Color>` right **)** |
  132. +---------------------------+-----------------------------------------------------------------------------------------------+
  133. | :ref:`Color<class_Color>` | :ref:`operator /<class_Color_operator_div_Color>` **(** :ref:`Color<class_Color>` right **)** |
  134. +---------------------------+-----------------------------------------------------------------------------------------------+
  135. | :ref:`Color<class_Color>` | :ref:`operator /<class_Color_operator_div_Color>` **(** :ref:`float<class_float>` right **)** |
  136. +---------------------------+-----------------------------------------------------------------------------------------------+
  137. | :ref:`Color<class_Color>` | :ref:`operator /<class_Color_operator_div_Color>` **(** :ref:`int<class_int>` right **)** |
  138. +---------------------------+-----------------------------------------------------------------------------------------------+
  139. | :ref:`bool<class_bool>` | :ref:`operator ==<class_Color_operator_eq_bool>` **(** **)** |
  140. +---------------------------+-----------------------------------------------------------------------------------------------+
  141. | :ref:`bool<class_bool>` | :ref:`operator ==<class_Color_operator_eq_bool>` **(** :ref:`Color<class_Color>` right **)** |
  142. +---------------------------+-----------------------------------------------------------------------------------------------+
  143. | :ref:`float<class_float>` | :ref:`operator []<class_Color_operator_idx_float>` **(** :ref:`int<class_int>` index **)** |
  144. +---------------------------+-----------------------------------------------------------------------------------------------+
  145. | :ref:`Color<class_Color>` | :ref:`operator unary+<class_Color_operator_unplus_Color>` **(** **)** |
  146. +---------------------------+-----------------------------------------------------------------------------------------------+
  147. | :ref:`Color<class_Color>` | :ref:`operator unary-<class_Color_operator_unminus_Color>` **(** **)** |
  148. +---------------------------+-----------------------------------------------------------------------------------------------+
  149. Constants
  150. ---------
  151. .. _class_Color_constant_ALICE_BLUE:
  152. .. _class_Color_constant_ANTIQUE_WHITE:
  153. .. _class_Color_constant_AQUA:
  154. .. _class_Color_constant_AQUAMARINE:
  155. .. _class_Color_constant_AZURE:
  156. .. _class_Color_constant_BEIGE:
  157. .. _class_Color_constant_BISQUE:
  158. .. _class_Color_constant_BLACK:
  159. .. _class_Color_constant_BLANCHED_ALMOND:
  160. .. _class_Color_constant_BLUE:
  161. .. _class_Color_constant_BLUE_VIOLET:
  162. .. _class_Color_constant_BROWN:
  163. .. _class_Color_constant_BURLYWOOD:
  164. .. _class_Color_constant_CADET_BLUE:
  165. .. _class_Color_constant_CHARTREUSE:
  166. .. _class_Color_constant_CHOCOLATE:
  167. .. _class_Color_constant_CORAL:
  168. .. _class_Color_constant_CORNFLOWER_BLUE:
  169. .. _class_Color_constant_CORNSILK:
  170. .. _class_Color_constant_CRIMSON:
  171. .. _class_Color_constant_CYAN:
  172. .. _class_Color_constant_DARK_BLUE:
  173. .. _class_Color_constant_DARK_CYAN:
  174. .. _class_Color_constant_DARK_GOLDENROD:
  175. .. _class_Color_constant_DARK_GRAY:
  176. .. _class_Color_constant_DARK_GREEN:
  177. .. _class_Color_constant_DARK_KHAKI:
  178. .. _class_Color_constant_DARK_MAGENTA:
  179. .. _class_Color_constant_DARK_OLIVE_GREEN:
  180. .. _class_Color_constant_DARK_ORANGE:
  181. .. _class_Color_constant_DARK_ORCHID:
  182. .. _class_Color_constant_DARK_RED:
  183. .. _class_Color_constant_DARK_SALMON:
  184. .. _class_Color_constant_DARK_SEA_GREEN:
  185. .. _class_Color_constant_DARK_SLATE_BLUE:
  186. .. _class_Color_constant_DARK_SLATE_GRAY:
  187. .. _class_Color_constant_DARK_TURQUOISE:
  188. .. _class_Color_constant_DARK_VIOLET:
  189. .. _class_Color_constant_DEEP_PINK:
  190. .. _class_Color_constant_DEEP_SKY_BLUE:
  191. .. _class_Color_constant_DIM_GRAY:
  192. .. _class_Color_constant_DODGER_BLUE:
  193. .. _class_Color_constant_FIREBRICK:
  194. .. _class_Color_constant_FLORAL_WHITE:
  195. .. _class_Color_constant_FOREST_GREEN:
  196. .. _class_Color_constant_FUCHSIA:
  197. .. _class_Color_constant_GAINSBORO:
  198. .. _class_Color_constant_GHOST_WHITE:
  199. .. _class_Color_constant_GOLD:
  200. .. _class_Color_constant_GOLDENROD:
  201. .. _class_Color_constant_GRAY:
  202. .. _class_Color_constant_GREEN:
  203. .. _class_Color_constant_GREEN_YELLOW:
  204. .. _class_Color_constant_HONEYDEW:
  205. .. _class_Color_constant_HOT_PINK:
  206. .. _class_Color_constant_INDIAN_RED:
  207. .. _class_Color_constant_INDIGO:
  208. .. _class_Color_constant_IVORY:
  209. .. _class_Color_constant_KHAKI:
  210. .. _class_Color_constant_LAVENDER:
  211. .. _class_Color_constant_LAVENDER_BLUSH:
  212. .. _class_Color_constant_LAWN_GREEN:
  213. .. _class_Color_constant_LEMON_CHIFFON:
  214. .. _class_Color_constant_LIGHT_BLUE:
  215. .. _class_Color_constant_LIGHT_CORAL:
  216. .. _class_Color_constant_LIGHT_CYAN:
  217. .. _class_Color_constant_LIGHT_GOLDENROD:
  218. .. _class_Color_constant_LIGHT_GRAY:
  219. .. _class_Color_constant_LIGHT_GREEN:
  220. .. _class_Color_constant_LIGHT_PINK:
  221. .. _class_Color_constant_LIGHT_SALMON:
  222. .. _class_Color_constant_LIGHT_SEA_GREEN:
  223. .. _class_Color_constant_LIGHT_SKY_BLUE:
  224. .. _class_Color_constant_LIGHT_SLATE_GRAY:
  225. .. _class_Color_constant_LIGHT_STEEL_BLUE:
  226. .. _class_Color_constant_LIGHT_YELLOW:
  227. .. _class_Color_constant_LIME:
  228. .. _class_Color_constant_LIME_GREEN:
  229. .. _class_Color_constant_LINEN:
  230. .. _class_Color_constant_MAGENTA:
  231. .. _class_Color_constant_MAROON:
  232. .. _class_Color_constant_MEDIUM_AQUAMARINE:
  233. .. _class_Color_constant_MEDIUM_BLUE:
  234. .. _class_Color_constant_MEDIUM_ORCHID:
  235. .. _class_Color_constant_MEDIUM_PURPLE:
  236. .. _class_Color_constant_MEDIUM_SEA_GREEN:
  237. .. _class_Color_constant_MEDIUM_SLATE_BLUE:
  238. .. _class_Color_constant_MEDIUM_SPRING_GREEN:
  239. .. _class_Color_constant_MEDIUM_TURQUOISE:
  240. .. _class_Color_constant_MEDIUM_VIOLET_RED:
  241. .. _class_Color_constant_MIDNIGHT_BLUE:
  242. .. _class_Color_constant_MINT_CREAM:
  243. .. _class_Color_constant_MISTY_ROSE:
  244. .. _class_Color_constant_MOCCASIN:
  245. .. _class_Color_constant_NAVAJO_WHITE:
  246. .. _class_Color_constant_NAVY_BLUE:
  247. .. _class_Color_constant_OLD_LACE:
  248. .. _class_Color_constant_OLIVE:
  249. .. _class_Color_constant_OLIVE_DRAB:
  250. .. _class_Color_constant_ORANGE:
  251. .. _class_Color_constant_ORANGE_RED:
  252. .. _class_Color_constant_ORCHID:
  253. .. _class_Color_constant_PALE_GOLDENROD:
  254. .. _class_Color_constant_PALE_GREEN:
  255. .. _class_Color_constant_PALE_TURQUOISE:
  256. .. _class_Color_constant_PALE_VIOLET_RED:
  257. .. _class_Color_constant_PAPAYA_WHIP:
  258. .. _class_Color_constant_PEACH_PUFF:
  259. .. _class_Color_constant_PERU:
  260. .. _class_Color_constant_PINK:
  261. .. _class_Color_constant_PLUM:
  262. .. _class_Color_constant_POWDER_BLUE:
  263. .. _class_Color_constant_PURPLE:
  264. .. _class_Color_constant_REBECCA_PURPLE:
  265. .. _class_Color_constant_RED:
  266. .. _class_Color_constant_ROSY_BROWN:
  267. .. _class_Color_constant_ROYAL_BLUE:
  268. .. _class_Color_constant_SADDLE_BROWN:
  269. .. _class_Color_constant_SALMON:
  270. .. _class_Color_constant_SANDY_BROWN:
  271. .. _class_Color_constant_SEA_GREEN:
  272. .. _class_Color_constant_SEASHELL:
  273. .. _class_Color_constant_SIENNA:
  274. .. _class_Color_constant_SILVER:
  275. .. _class_Color_constant_SKY_BLUE:
  276. .. _class_Color_constant_SLATE_BLUE:
  277. .. _class_Color_constant_SLATE_GRAY:
  278. .. _class_Color_constant_SNOW:
  279. .. _class_Color_constant_SPRING_GREEN:
  280. .. _class_Color_constant_STEEL_BLUE:
  281. .. _class_Color_constant_TAN:
  282. .. _class_Color_constant_TEAL:
  283. .. _class_Color_constant_THISTLE:
  284. .. _class_Color_constant_TOMATO:
  285. .. _class_Color_constant_TRANSPARENT:
  286. .. _class_Color_constant_TURQUOISE:
  287. .. _class_Color_constant_VIOLET:
  288. .. _class_Color_constant_WEB_GRAY:
  289. .. _class_Color_constant_WEB_GREEN:
  290. .. _class_Color_constant_WEB_MAROON:
  291. .. _class_Color_constant_WEB_PURPLE:
  292. .. _class_Color_constant_WHEAT:
  293. .. _class_Color_constant_WHITE:
  294. .. _class_Color_constant_WHITE_SMOKE:
  295. .. _class_Color_constant_YELLOW:
  296. .. _class_Color_constant_YELLOW_GREEN:
  297. - **ALICE_BLUE** = **Color(0.94, 0.97, 1, 1)** --- Alice blue color.
  298. - **ANTIQUE_WHITE** = **Color(0.98, 0.92, 0.84, 1)** --- Antique white color.
  299. - **AQUA** = **Color(0, 1, 1, 1)** --- Aqua color.
  300. - **AQUAMARINE** = **Color(0.5, 1, 0.83, 1)** --- Aquamarine color.
  301. - **AZURE** = **Color(0.94, 1, 1, 1)** --- Azure color.
  302. - **BEIGE** = **Color(0.96, 0.96, 0.86, 1)** --- Beige color.
  303. - **BISQUE** = **Color(1, 0.89, 0.77, 1)** --- Bisque color.
  304. - **BLACK** = **Color(0, 0, 0, 1)** --- Black color.
  305. - **BLANCHED_ALMOND** = **Color(1, 0.92, 0.8, 1)** --- Blanched almond color.
  306. - **BLUE** = **Color(0, 0, 1, 1)** --- Blue color.
  307. - **BLUE_VIOLET** = **Color(0.54, 0.17, 0.89, 1)** --- Blue violet color.
  308. - **BROWN** = **Color(0.65, 0.16, 0.16, 1)** --- Brown color.
  309. - **BURLYWOOD** = **Color(0.87, 0.72, 0.53, 1)** --- Burlywood color.
  310. - **CADET_BLUE** = **Color(0.37, 0.62, 0.63, 1)** --- Cadet blue color.
  311. - **CHARTREUSE** = **Color(0.5, 1, 0, 1)** --- Chartreuse color.
  312. - **CHOCOLATE** = **Color(0.82, 0.41, 0.12, 1)** --- Chocolate color.
  313. - **CORAL** = **Color(1, 0.5, 0.31, 1)** --- Coral color.
  314. - **CORNFLOWER_BLUE** = **Color(0.39, 0.58, 0.93, 1)** --- Cornflower blue color.
  315. - **CORNSILK** = **Color(1, 0.97, 0.86, 1)** --- Cornsilk color.
  316. - **CRIMSON** = **Color(0.86, 0.08, 0.24, 1)** --- Crimson color.
  317. - **CYAN** = **Color(0, 1, 1, 1)** --- Cyan color.
  318. - **DARK_BLUE** = **Color(0, 0, 0.55, 1)** --- Dark blue color.
  319. - **DARK_CYAN** = **Color(0, 0.55, 0.55, 1)** --- Dark cyan color.
  320. - **DARK_GOLDENROD** = **Color(0.72, 0.53, 0.04, 1)** --- Dark goldenrod color.
  321. - **DARK_GRAY** = **Color(0.66, 0.66, 0.66, 1)** --- Dark gray color.
  322. - **DARK_GREEN** = **Color(0, 0.39, 0, 1)** --- Dark green color.
  323. - **DARK_KHAKI** = **Color(0.74, 0.72, 0.42, 1)** --- Dark khaki color.
  324. - **DARK_MAGENTA** = **Color(0.55, 0, 0.55, 1)** --- Dark magenta color.
  325. - **DARK_OLIVE_GREEN** = **Color(0.33, 0.42, 0.18, 1)** --- Dark olive green color.
  326. - **DARK_ORANGE** = **Color(1, 0.55, 0, 1)** --- Dark orange color.
  327. - **DARK_ORCHID** = **Color(0.6, 0.2, 0.8, 1)** --- Dark orchid color.
  328. - **DARK_RED** = **Color(0.55, 0, 0, 1)** --- Dark red color.
  329. - **DARK_SALMON** = **Color(0.91, 0.59, 0.48, 1)** --- Dark salmon color.
  330. - **DARK_SEA_GREEN** = **Color(0.56, 0.74, 0.56, 1)** --- Dark sea green color.
  331. - **DARK_SLATE_BLUE** = **Color(0.28, 0.24, 0.55, 1)** --- Dark slate blue color.
  332. - **DARK_SLATE_GRAY** = **Color(0.18, 0.31, 0.31, 1)** --- Dark slate gray color.
  333. - **DARK_TURQUOISE** = **Color(0, 0.81, 0.82, 1)** --- Dark turquoise color.
  334. - **DARK_VIOLET** = **Color(0.58, 0, 0.83, 1)** --- Dark violet color.
  335. - **DEEP_PINK** = **Color(1, 0.08, 0.58, 1)** --- Deep pink color.
  336. - **DEEP_SKY_BLUE** = **Color(0, 0.75, 1, 1)** --- Deep sky blue color.
  337. - **DIM_GRAY** = **Color(0.41, 0.41, 0.41, 1)** --- Dim gray color.
  338. - **DODGER_BLUE** = **Color(0.12, 0.56, 1, 1)** --- Dodger blue color.
  339. - **FIREBRICK** = **Color(0.7, 0.13, 0.13, 1)** --- Firebrick color.
  340. - **FLORAL_WHITE** = **Color(1, 0.98, 0.94, 1)** --- Floral white color.
  341. - **FOREST_GREEN** = **Color(0.13, 0.55, 0.13, 1)** --- Forest green color.
  342. - **FUCHSIA** = **Color(1, 0, 1, 1)** --- Fuchsia color.
  343. - **GAINSBORO** = **Color(0.86, 0.86, 0.86, 1)** --- Gainsboro color.
  344. - **GHOST_WHITE** = **Color(0.97, 0.97, 1, 1)** --- Ghost white color.
  345. - **GOLD** = **Color(1, 0.84, 0, 1)** --- Gold color.
  346. - **GOLDENROD** = **Color(0.85, 0.65, 0.13, 1)** --- Goldenrod color.
  347. - **GRAY** = **Color(0.75, 0.75, 0.75, 1)** --- Gray color.
  348. - **GREEN** = **Color(0, 1, 0, 1)** --- Green color.
  349. - **GREEN_YELLOW** = **Color(0.68, 1, 0.18, 1)** --- Green yellow color.
  350. - **HONEYDEW** = **Color(0.94, 1, 0.94, 1)** --- Honeydew color.
  351. - **HOT_PINK** = **Color(1, 0.41, 0.71, 1)** --- Hot pink color.
  352. - **INDIAN_RED** = **Color(0.8, 0.36, 0.36, 1)** --- Indian red color.
  353. - **INDIGO** = **Color(0.29, 0, 0.51, 1)** --- Indigo color.
  354. - **IVORY** = **Color(1, 1, 0.94, 1)** --- Ivory color.
  355. - **KHAKI** = **Color(0.94, 0.9, 0.55, 1)** --- Khaki color.
  356. - **LAVENDER** = **Color(0.9, 0.9, 0.98, 1)** --- Lavender color.
  357. - **LAVENDER_BLUSH** = **Color(1, 0.94, 0.96, 1)** --- Lavender blush color.
  358. - **LAWN_GREEN** = **Color(0.49, 0.99, 0, 1)** --- Lawn green color.
  359. - **LEMON_CHIFFON** = **Color(1, 0.98, 0.8, 1)** --- Lemon chiffon color.
  360. - **LIGHT_BLUE** = **Color(0.68, 0.85, 0.9, 1)** --- Light blue color.
  361. - **LIGHT_CORAL** = **Color(0.94, 0.5, 0.5, 1)** --- Light coral color.
  362. - **LIGHT_CYAN** = **Color(0.88, 1, 1, 1)** --- Light cyan color.
  363. - **LIGHT_GOLDENROD** = **Color(0.98, 0.98, 0.82, 1)** --- Light goldenrod color.
  364. - **LIGHT_GRAY** = **Color(0.83, 0.83, 0.83, 1)** --- Light gray color.
  365. - **LIGHT_GREEN** = **Color(0.56, 0.93, 0.56, 1)** --- Light green color.
  366. - **LIGHT_PINK** = **Color(1, 0.71, 0.76, 1)** --- Light pink color.
  367. - **LIGHT_SALMON** = **Color(1, 0.63, 0.48, 1)** --- Light salmon color.
  368. - **LIGHT_SEA_GREEN** = **Color(0.13, 0.7, 0.67, 1)** --- Light sea green color.
  369. - **LIGHT_SKY_BLUE** = **Color(0.53, 0.81, 0.98, 1)** --- Light sky blue color.
  370. - **LIGHT_SLATE_GRAY** = **Color(0.47, 0.53, 0.6, 1)** --- Light slate gray color.
  371. - **LIGHT_STEEL_BLUE** = **Color(0.69, 0.77, 0.87, 1)** --- Light steel blue color.
  372. - **LIGHT_YELLOW** = **Color(1, 1, 0.88, 1)** --- Light yellow color.
  373. - **LIME** = **Color(0, 1, 0, 1)** --- Lime color.
  374. - **LIME_GREEN** = **Color(0.2, 0.8, 0.2, 1)** --- Lime green color.
  375. - **LINEN** = **Color(0.98, 0.94, 0.9, 1)** --- Linen color.
  376. - **MAGENTA** = **Color(1, 0, 1, 1)** --- Magenta color.
  377. - **MAROON** = **Color(0.69, 0.19, 0.38, 1)** --- Maroon color.
  378. - **MEDIUM_AQUAMARINE** = **Color(0.4, 0.8, 0.67, 1)** --- Medium aquamarine color.
  379. - **MEDIUM_BLUE** = **Color(0, 0, 0.8, 1)** --- Medium blue color.
  380. - **MEDIUM_ORCHID** = **Color(0.73, 0.33, 0.83, 1)** --- Medium orchid color.
  381. - **MEDIUM_PURPLE** = **Color(0.58, 0.44, 0.86, 1)** --- Medium purple color.
  382. - **MEDIUM_SEA_GREEN** = **Color(0.24, 0.7, 0.44, 1)** --- Medium sea green color.
  383. - **MEDIUM_SLATE_BLUE** = **Color(0.48, 0.41, 0.93, 1)** --- Medium slate blue color.
  384. - **MEDIUM_SPRING_GREEN** = **Color(0, 0.98, 0.6, 1)** --- Medium spring green color.
  385. - **MEDIUM_TURQUOISE** = **Color(0.28, 0.82, 0.8, 1)** --- Medium turquoise color.
  386. - **MEDIUM_VIOLET_RED** = **Color(0.78, 0.08, 0.52, 1)** --- Medium violet red color.
  387. - **MIDNIGHT_BLUE** = **Color(0.1, 0.1, 0.44, 1)** --- Midnight blue color.
  388. - **MINT_CREAM** = **Color(0.96, 1, 0.98, 1)** --- Mint cream color.
  389. - **MISTY_ROSE** = **Color(1, 0.89, 0.88, 1)** --- Misty rose color.
  390. - **MOCCASIN** = **Color(1, 0.89, 0.71, 1)** --- Moccasin color.
  391. - **NAVAJO_WHITE** = **Color(1, 0.87, 0.68, 1)** --- Navajo white color.
  392. - **NAVY_BLUE** = **Color(0, 0, 0.5, 1)** --- Navy blue color.
  393. - **OLD_LACE** = **Color(0.99, 0.96, 0.9, 1)** --- Old lace color.
  394. - **OLIVE** = **Color(0.5, 0.5, 0, 1)** --- Olive color.
  395. - **OLIVE_DRAB** = **Color(0.42, 0.56, 0.14, 1)** --- Olive drab color.
  396. - **ORANGE** = **Color(1, 0.65, 0, 1)** --- Orange color.
  397. - **ORANGE_RED** = **Color(1, 0.27, 0, 1)** --- Orange red color.
  398. - **ORCHID** = **Color(0.85, 0.44, 0.84, 1)** --- Orchid color.
  399. - **PALE_GOLDENROD** = **Color(0.93, 0.91, 0.67, 1)** --- Pale goldenrod color.
  400. - **PALE_GREEN** = **Color(0.6, 0.98, 0.6, 1)** --- Pale green color.
  401. - **PALE_TURQUOISE** = **Color(0.69, 0.93, 0.93, 1)** --- Pale turquoise color.
  402. - **PALE_VIOLET_RED** = **Color(0.86, 0.44, 0.58, 1)** --- Pale violet red color.
  403. - **PAPAYA_WHIP** = **Color(1, 0.94, 0.84, 1)** --- Papaya whip color.
  404. - **PEACH_PUFF** = **Color(1, 0.85, 0.73, 1)** --- Peach puff color.
  405. - **PERU** = **Color(0.8, 0.52, 0.25, 1)** --- Peru color.
  406. - **PINK** = **Color(1, 0.75, 0.8, 1)** --- Pink color.
  407. - **PLUM** = **Color(0.87, 0.63, 0.87, 1)** --- Plum color.
  408. - **POWDER_BLUE** = **Color(0.69, 0.88, 0.9, 1)** --- Powder blue color.
  409. - **PURPLE** = **Color(0.63, 0.13, 0.94, 1)** --- Purple color.
  410. - **REBECCA_PURPLE** = **Color(0.4, 0.2, 0.6, 1)** --- Rebecca purple color.
  411. - **RED** = **Color(1, 0, 0, 1)** --- Red color.
  412. - **ROSY_BROWN** = **Color(0.74, 0.56, 0.56, 1)** --- Rosy brown color.
  413. - **ROYAL_BLUE** = **Color(0.25, 0.41, 0.88, 1)** --- Royal blue color.
  414. - **SADDLE_BROWN** = **Color(0.55, 0.27, 0.07, 1)** --- Saddle brown color.
  415. - **SALMON** = **Color(0.98, 0.5, 0.45, 1)** --- Salmon color.
  416. - **SANDY_BROWN** = **Color(0.96, 0.64, 0.38, 1)** --- Sandy brown color.
  417. - **SEA_GREEN** = **Color(0.18, 0.55, 0.34, 1)** --- Sea green color.
  418. - **SEASHELL** = **Color(1, 0.96, 0.93, 1)** --- Seashell color.
  419. - **SIENNA** = **Color(0.63, 0.32, 0.18, 1)** --- Sienna color.
  420. - **SILVER** = **Color(0.75, 0.75, 0.75, 1)** --- Silver color.
  421. - **SKY_BLUE** = **Color(0.53, 0.81, 0.92, 1)** --- Sky blue color.
  422. - **SLATE_BLUE** = **Color(0.42, 0.35, 0.8, 1)** --- Slate blue color.
  423. - **SLATE_GRAY** = **Color(0.44, 0.5, 0.56, 1)** --- Slate gray color.
  424. - **SNOW** = **Color(1, 0.98, 0.98, 1)** --- Snow color.
  425. - **SPRING_GREEN** = **Color(0, 1, 0.5, 1)** --- Spring green color.
  426. - **STEEL_BLUE** = **Color(0.27, 0.51, 0.71, 1)** --- Steel blue color.
  427. - **TAN** = **Color(0.82, 0.71, 0.55, 1)** --- Tan color.
  428. - **TEAL** = **Color(0, 0.5, 0.5, 1)** --- Teal color.
  429. - **THISTLE** = **Color(0.85, 0.75, 0.85, 1)** --- Thistle color.
  430. - **TOMATO** = **Color(1, 0.39, 0.28, 1)** --- Tomato color.
  431. - **TRANSPARENT** = **Color(1, 1, 1, 0)** --- Transparent color (white with zero alpha).
  432. - **TURQUOISE** = **Color(0.25, 0.88, 0.82, 1)** --- Turquoise color.
  433. - **VIOLET** = **Color(0.93, 0.51, 0.93, 1)** --- Violet color.
  434. - **WEB_GRAY** = **Color(0.5, 0.5, 0.5, 1)** --- Web gray color.
  435. - **WEB_GREEN** = **Color(0, 0.5, 0, 1)** --- Web green color.
  436. - **WEB_MAROON** = **Color(0.5, 0, 0, 1)** --- Web maroon color.
  437. - **WEB_PURPLE** = **Color(0.5, 0, 0.5, 1)** --- Web purple color.
  438. - **WHEAT** = **Color(0.96, 0.87, 0.7, 1)** --- Wheat color.
  439. - **WHITE** = **Color(1, 1, 1, 1)** --- White color.
  440. - **WHITE_SMOKE** = **Color(0.96, 0.96, 0.96, 1)** --- White smoke color.
  441. - **YELLOW** = **Color(1, 1, 0, 1)** --- Yellow color.
  442. - **YELLOW_GREEN** = **Color(0.6, 0.8, 0.2, 1)** --- Yellow green color.
  443. Property Descriptions
  444. ---------------------
  445. .. _class_Color_property_a:
  446. - :ref:`float<class_float>` **a**
  447. +-----------+---------+
  448. | *Default* | ``1.0`` |
  449. +-----------+---------+
  450. The color's alpha (transparency) component, typically on the range of 0 to 1.
  451. ----
  452. .. _class_Color_property_a8:
  453. - :ref:`int<class_int>` **a8**
  454. +-----------+---------+
  455. | *Default* | ``255`` |
  456. +-----------+---------+
  457. Wrapper for :ref:`a<class_Color_property_a>` that uses the range 0 to 255 instead of 0 to 1.
  458. ----
  459. .. _class_Color_property_b:
  460. - :ref:`float<class_float>` **b**
  461. +-----------+---------+
  462. | *Default* | ``0.0`` |
  463. +-----------+---------+
  464. The color's blue component, typically on the range of 0 to 1.
  465. ----
  466. .. _class_Color_property_b8:
  467. - :ref:`int<class_int>` **b8**
  468. +-----------+-------+
  469. | *Default* | ``0`` |
  470. +-----------+-------+
  471. Wrapper for :ref:`b<class_Color_property_b>` that uses the range 0 to 255 instead of 0 to 1.
  472. ----
  473. .. _class_Color_property_g:
  474. - :ref:`float<class_float>` **g**
  475. +-----------+---------+
  476. | *Default* | ``0.0`` |
  477. +-----------+---------+
  478. The color's green component, typically on the range of 0 to 1.
  479. ----
  480. .. _class_Color_property_g8:
  481. - :ref:`int<class_int>` **g8**
  482. +-----------+-------+
  483. | *Default* | ``0`` |
  484. +-----------+-------+
  485. Wrapper for :ref:`g<class_Color_property_g>` that uses the range 0 to 255 instead of 0 to 1.
  486. ----
  487. .. _class_Color_property_h:
  488. - :ref:`float<class_float>` **h**
  489. +-----------+---------+
  490. | *Default* | ``0.0`` |
  491. +-----------+---------+
  492. The HSV hue of this color, on the range 0 to 1.
  493. ----
  494. .. _class_Color_property_r:
  495. - :ref:`float<class_float>` **r**
  496. +-----------+---------+
  497. | *Default* | ``0.0`` |
  498. +-----------+---------+
  499. The color's red component, typically on the range of 0 to 1.
  500. ----
  501. .. _class_Color_property_r8:
  502. - :ref:`int<class_int>` **r8**
  503. +-----------+-------+
  504. | *Default* | ``0`` |
  505. +-----------+-------+
  506. Wrapper for :ref:`r<class_Color_property_r>` that uses the range 0 to 255 instead of 0 to 1.
  507. ----
  508. .. _class_Color_property_s:
  509. - :ref:`float<class_float>` **s**
  510. +-----------+---------+
  511. | *Default* | ``0.0`` |
  512. +-----------+---------+
  513. The HSV saturation of this color, on the range 0 to 1.
  514. ----
  515. .. _class_Color_property_v:
  516. - :ref:`float<class_float>` **v**
  517. +-----------+---------+
  518. | *Default* | ``0.0`` |
  519. +-----------+---------+
  520. The HSV value (brightness) of this color, on the range 0 to 1.
  521. Constructor Descriptions
  522. ------------------------
  523. .. _class_Color_constructor_Color:
  524. - :ref:`Color<class_Color>` **Color** **(** **)**
  525. Constructs a default-initialized ``Color`` with all components set to ``0``.
  526. ----
  527. - :ref:`Color<class_Color>` **Color** **(** :ref:`Color<class_Color>` from, :ref:`float<class_float>` alpha **)**
  528. Constructs a ``Color`` from an existing color, but with a custom alpha value.
  529. .. tabs::
  530. .. code-tab:: gdscript
  531. var red = Color(Color.red, 0.5) # 50% transparent red.
  532. .. code-tab:: csharp
  533. var red = new Color(Colors.Red, 0.5f); // 50% transparent red.
  534. ----
  535. - :ref:`Color<class_Color>` **Color** **(** :ref:`Color<class_Color>` from **)**
  536. Constructs a ``Color`` as a copy of the given ``Color``.
  537. ----
  538. - :ref:`Color<class_Color>` **Color** **(** :ref:`String<class_String>` code **)**
  539. Constructs a ``Color`` either from an HTML color code or from a standardized color name. Supported color names are the same as the constants.
  540. ----
  541. - :ref:`Color<class_Color>` **Color** **(** :ref:`String<class_String>` code, :ref:`float<class_float>` alpha **)**
  542. Constructs a ``Color`` either from an HTML color code or from a standardized color name, with ``alpha`` on the range of 0 to 1. Supported color names are the same as the constants.
  543. ----
  544. - :ref:`Color<class_Color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)**
  545. Constructs a ``Color`` from RGB values, typically between 0 and 1. Alpha will be 1.
  546. .. tabs::
  547. .. code-tab:: gdscript
  548. var color = Color(0.2, 1.0, 0.7) # Similar to `Color8(51, 255, 178, 255)`
  549. .. code-tab:: csharp
  550. var color = new Color(0.2f, 1.0f, 0.7f); // Similar to `Color.Color8(51, 255, 178, 255)`
  551. ----
  552. - :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 **)**
  553. Constructs a ``Color`` from RGBA values, typically between 0 and 1.
  554. .. tabs::
  555. .. code-tab:: gdscript
  556. var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to `Color8(51, 255, 178, 204)`
  557. .. code-tab:: csharp
  558. var color = new Color(0.2f, 1.0f, 0.7f, 0.8f); // Similar to `Color.Color8(51, 255, 178, 255, 204)`
  559. Method Descriptions
  560. -------------------
  561. .. _class_Color_method_blend:
  562. - :ref:`Color<class_Color>` **blend** **(** :ref:`Color<class_Color>` over **)** |const|
  563. Returns a new color resulting from blending this color over another. If the color is opaque, the result is also opaque. The second color may have a range of alpha values.
  564. .. tabs::
  565. .. code-tab:: gdscript
  566. var bg = Color(0.0, 1.0, 0.0, 0.5) # Green with alpha of 50%
  567. var fg = Color(1.0, 0.0, 0.0, 0.5) # Red with alpha of 50%
  568. var blended_color = bg.blend(fg) # Brown with alpha of 75%
  569. .. code-tab:: csharp
  570. var bg = new Color(0.0f, 1.0f, 0.0f, 0.5f); // Green with alpha of 50%
  571. var fg = new Color(1.0f, 0.0f, 0.0f, 0.5f); // Red with alpha of 50%
  572. Color blendedColor = bg.Blend(fg); // Brown with alpha of 75%
  573. ----
  574. .. _class_Color_method_clamp:
  575. - :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|
  576. 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.
  577. ----
  578. .. _class_Color_method_darkened:
  579. - :ref:`Color<class_Color>` **darkened** **(** :ref:`float<class_float>` amount **)** |const|
  580. Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1).
  581. .. tabs::
  582. .. code-tab:: gdscript
  583. var green = Color(0.0, 1.0, 0.0)
  584. var darkgreen = green.darkened(0.2) # 20% darker than regular green
  585. .. code-tab:: csharp
  586. var green = new Color(0.0f, 1.0f, 0.0f);
  587. Color darkgreen = green.Darkened(0.2f); // 20% darker than regular green
  588. ----
  589. .. _class_Color_method_find_named_color:
  590. - :ref:`int<class_int>` **find_named_color** **(** :ref:`String<class_String>` name **)** |static|
  591. ----
  592. .. _class_Color_method_from_hsv:
  593. - :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|
  594. Constructs a color from an `HSV profile <https://en.wikipedia.org/wiki/HSL_and_HSV>`__. ``h`` (hue), ``s`` (saturation), and ``v`` (value) are typically between 0 and 1.
  595. .. tabs::
  596. .. code-tab:: gdscript
  597. var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8)
  598. .. code-tab:: csharp
  599. var c = Color.FromHsv(0.58f, 0.5f, 0.79f, 0.8f);
  600. ----
  601. .. _class_Color_method_from_rgbe9995:
  602. - :ref:`Color<class_Color>` **from_rgbe9995** **(** :ref:`int<class_int>` rgbe **)** |static|
  603. ----
  604. .. _class_Color_method_from_string:
  605. - :ref:`Color<class_Color>` **from_string** **(** :ref:`String<class_String>` str, :ref:`Color<class_Color>` default **)** |static|
  606. ----
  607. .. _class_Color_method_get_named_color:
  608. - :ref:`Color<class_Color>` **get_named_color** **(** :ref:`int<class_int>` idx **)** |static|
  609. ----
  610. .. _class_Color_method_get_named_color_count:
  611. - :ref:`int<class_int>` **get_named_color_count** **(** **)** |static|
  612. ----
  613. .. _class_Color_method_get_named_color_name:
  614. - :ref:`String<class_String>` **get_named_color_name** **(** :ref:`int<class_int>` idx **)** |static|
  615. ----
  616. .. _class_Color_method_hex:
  617. - :ref:`Color<class_Color>` **hex** **(** :ref:`int<class_int>` hex **)** |static|
  618. ----
  619. .. _class_Color_method_hex64:
  620. - :ref:`Color<class_Color>` **hex64** **(** :ref:`int<class_int>` hex **)** |static|
  621. ----
  622. .. _class_Color_method_html:
  623. - :ref:`Color<class_Color>` **html** **(** :ref:`String<class_String>` rgba **)** |static|
  624. ----
  625. .. _class_Color_method_html_is_valid:
  626. - :ref:`bool<class_bool>` **html_is_valid** **(** :ref:`String<class_String>` color **)** |static|
  627. ----
  628. .. _class_Color_method_inverted:
  629. - :ref:`Color<class_Color>` **inverted** **(** **)** |const|
  630. Returns the inverted color ``(1 - r, 1 - g, 1 - b, a)``.
  631. .. tabs::
  632. .. code-tab:: gdscript
  633. var color = Color(0.3, 0.4, 0.9)
  634. var inverted_color = color.inverted() # Equivalent to `Color(0.7, 0.6, 0.1)`
  635. .. code-tab:: csharp
  636. var color = new Color(0.3f, 0.4f, 0.9f);
  637. Color invertedColor = color.Inverted(); // Equivalent to `new Color(0.7f, 0.6f, 0.1f)`
  638. ----
  639. .. _class_Color_method_is_equal_approx:
  640. - :ref:`bool<class_bool>` **is_equal_approx** **(** :ref:`Color<class_Color>` to **)** |const|
  641. Returns ``true`` if this color and ``color`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx<class_@GlobalScope_method_is_equal_approx>` on each component.
  642. ----
  643. .. _class_Color_method_lerp:
  644. - :ref:`Color<class_Color>` **lerp** **(** :ref:`Color<class_Color>` to, :ref:`float<class_float>` weight **)** |const|
  645. Returns the linear interpolation with another color. The interpolation factor ``weight`` is between 0 and 1.
  646. .. tabs::
  647. .. code-tab:: gdscript
  648. var c1 = Color(1.0, 0.0, 0.0)
  649. var c2 = Color(0.0, 1.0, 0.0)
  650. var lerp_color = c1.lerp(c2, 0.5) # Equivalent to `Color(0.5, 0.5, 0.0)`
  651. .. code-tab:: csharp
  652. var c1 = new Color(1.0f, 0.0f, 0.0f);
  653. var c2 = new Color(0.0f, 1.0f, 0.0f);
  654. Color lerpColor = c1.Lerp(c2, 0.5f); // Equivalent to `new Color(0.5f, 0.5f, 0.0f)`
  655. ----
  656. .. _class_Color_method_lightened:
  657. - :ref:`Color<class_Color>` **lightened** **(** :ref:`float<class_float>` amount **)** |const|
  658. Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1).
  659. .. tabs::
  660. .. code-tab:: gdscript
  661. var green = Color(0.0, 1.0, 0.0)
  662. var lightgreen = green.lightened(0.2) # 20% lighter than regular green
  663. .. code-tab:: csharp
  664. var green = new Color(0.0f, 1.0f, 0.0f);
  665. Color lightgreen = green.Lightened(0.2f); // 20% lighter than regular green
  666. ----
  667. .. _class_Color_method_to_abgr32:
  668. - :ref:`int<class_int>` **to_abgr32** **(** **)** |const|
  669. Returns the color converted to a 32-bit integer in ABGR format (each byte represents a color channel). ABGR is the reversed version of the default format.
  670. .. tabs::
  671. .. code-tab:: gdscript
  672. var color = Color(1, 0.5, 0.2)
  673. print(color.to_abgr32()) # Prints 4281565439
  674. .. code-tab:: csharp
  675. var color = new Color(1.0f, 0.5f, 0.2f);
  676. GD.Print(color.ToAbgr32()); // Prints 4281565439
  677. ----
  678. .. _class_Color_method_to_abgr64:
  679. - :ref:`int<class_int>` **to_abgr64** **(** **)** |const|
  680. Returns the color converted to a 64-bit integer in ABGR format (each word represents a color channel). ABGR is the reversed version of the default format.
  681. .. tabs::
  682. .. code-tab:: gdscript
  683. var color = Color(1, 0.5, 0.2)
  684. print(color.to_abgr64()) # Prints -225178692812801
  685. .. code-tab:: csharp
  686. var color = new Color(1.0f, 0.5f, 0.2f);
  687. GD.Print(color.ToAbgr64()); // Prints -225178692812801
  688. ----
  689. .. _class_Color_method_to_argb32:
  690. - :ref:`int<class_int>` **to_argb32** **(** **)** |const|
  691. Returns the color converted to a 32-bit integer in ARGB format (each byte represents a color channel). ARGB is more compatible with DirectX.
  692. .. tabs::
  693. .. code-tab:: gdscript
  694. var color = Color(1, 0.5, 0.2)
  695. print(color.to_argb32()) # Prints 4294934323
  696. .. code-tab:: csharp
  697. var color = new Color(1.0f, 0.5f, 0.2f);
  698. GD.Print(color.ToArgb32()); // Prints 4294934323
  699. ----
  700. .. _class_Color_method_to_argb64:
  701. - :ref:`int<class_int>` **to_argb64** **(** **)** |const|
  702. Returns the color converted to a 64-bit integer in ARGB format (each word represents a color channel). ARGB is more compatible with DirectX.
  703. .. tabs::
  704. .. code-tab:: gdscript
  705. var color = Color(1, 0.5, 0.2)
  706. print(color.to_argb64()) # Prints -2147470541
  707. .. code-tab:: csharp
  708. var color = new Color(1.0f, 0.5f, 0.2f);
  709. GD.Print(color.ToArgb64()); // Prints -2147470541
  710. ----
  711. .. _class_Color_method_to_html:
  712. - :ref:`String<class_String>` **to_html** **(** :ref:`bool<class_bool>` with_alpha=true **)** |const|
  713. Returns the color converted to an HTML hexadecimal color string in RGBA format (ex: ``ff34f822``).
  714. Setting ``with_alpha`` to ``false`` excludes alpha from the hexadecimal string (and uses RGB instead of RGBA format).
  715. .. tabs::
  716. .. code-tab:: gdscript
  717. var color = Color(1, 1, 1, 0.5)
  718. var with_alpha = color.to_html() # Returns "ffffff7f"
  719. var without_alpha = color.to_html(false) # Returns "ffffff"
  720. .. code-tab:: csharp
  721. var color = new Color(1, 1, 1, 0.5f);
  722. String withAlpha = color.ToHtml(); // Returns "ffffff7f"
  723. String withoutAlpha = color.ToHtml(false); // Returns "ffffff"
  724. ----
  725. .. _class_Color_method_to_rgba32:
  726. - :ref:`int<class_int>` **to_rgba32** **(** **)** |const|
  727. Returns the color converted to a 32-bit integer in RGBA format (each byte represents a color channel). RGBA is Godot's default format.
  728. .. tabs::
  729. .. code-tab:: gdscript
  730. var color = Color(1, 0.5, 0.2)
  731. print(color.to_rgba32()) # Prints 4286526463
  732. .. code-tab:: csharp
  733. var color = new Color(1, 0.5f, 0.2f);
  734. GD.Print(color.ToRgba32()); // Prints 4286526463
  735. ----
  736. .. _class_Color_method_to_rgba64:
  737. - :ref:`int<class_int>` **to_rgba64** **(** **)** |const|
  738. Returns the color converted to a 64-bit integer in RGBA format (each word represents a color channel). RGBA is Godot's default format.
  739. .. tabs::
  740. .. code-tab:: gdscript
  741. var color = Color(1, 0.5, 0.2)
  742. print(color.to_rgba64()) # Prints -140736629309441
  743. .. code-tab:: csharp
  744. var color = new Color(1, 0.5f, 0.2f);
  745. GD.Print(color.ToRgba64()); // Prints -140736629309441
  746. Operator Descriptions
  747. ---------------------
  748. .. _class_Color_operator_neq_bool:
  749. - :ref:`bool<class_bool>` **operator !=** **(** **)**
  750. ----
  751. - :ref:`bool<class_bool>` **operator !=** **(** :ref:`Color<class_Color>` right **)**
  752. Returns ``true`` if the colors are not equal.
  753. **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Color_method_is_equal_approx>` instead, which is more reliable.
  754. ----
  755. .. _class_Color_operator_mul_Color:
  756. - :ref:`Color<class_Color>` **operator *** **(** :ref:`Color<class_Color>` right **)**
  757. Multiplies each component of the ``Color`` by the components of the given ``Color``.
  758. ----
  759. - :ref:`Color<class_Color>` **operator *** **(** :ref:`float<class_float>` right **)**
  760. Multiplies each component of the ``Color`` by the given :ref:`float<class_float>`.
  761. ----
  762. - :ref:`Color<class_Color>` **operator *** **(** :ref:`int<class_int>` right **)**
  763. Multiplies each component of the ``Color`` by the given :ref:`int<class_int>`.
  764. ----
  765. .. _class_Color_operator_sum_Color:
  766. - :ref:`Color<class_Color>` **operator +** **(** :ref:`Color<class_Color>` right **)**
  767. Adds each component of the ``Color`` with the components of the given ``Color``.
  768. ----
  769. .. _class_Color_operator_dif_Color:
  770. - :ref:`Color<class_Color>` **operator -** **(** :ref:`Color<class_Color>` right **)**
  771. Subtracts each component of the ``Color`` by the components of the given ``Color``.
  772. ----
  773. .. _class_Color_operator_div_Color:
  774. - :ref:`Color<class_Color>` **operator /** **(** :ref:`Color<class_Color>` right **)**
  775. Divides each component of the ``Color`` by the components of the given ``Color``.
  776. ----
  777. - :ref:`Color<class_Color>` **operator /** **(** :ref:`float<class_float>` right **)**
  778. Divides each component of the ``Color`` by the given :ref:`float<class_float>`.
  779. ----
  780. - :ref:`Color<class_Color>` **operator /** **(** :ref:`int<class_int>` right **)**
  781. Divides each component of the ``Color`` by the given :ref:`int<class_int>`.
  782. ----
  783. .. _class_Color_operator_eq_bool:
  784. - :ref:`bool<class_bool>` **operator ==** **(** **)**
  785. ----
  786. - :ref:`bool<class_bool>` **operator ==** **(** :ref:`Color<class_Color>` right **)**
  787. Returns ``true`` if the colors are exactly equal.
  788. **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx<class_Color_method_is_equal_approx>` instead, which is more reliable.
  789. ----
  790. .. _class_Color_operator_idx_float:
  791. - :ref:`float<class_float>` **operator []** **(** :ref:`int<class_int>` index **)**
  792. Access color components using their index. ``c[0]`` is equivalent to ``c.r``, ``c[1]`` is equivalent to ``c.g``, ``c[2]`` is equivalent to ``c.b``, and ``c[3]`` is equivalent to ``c.a``.
  793. ----
  794. .. _class_Color_operator_unplus_Color:
  795. - :ref:`Color<class_Color>` **operator unary+** **(** **)**
  796. Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable.
  797. ----
  798. .. _class_Color_operator_unminus_Color:
  799. - :ref:`Color<class_Color>` **operator unary-** **(** **)**
  800. 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)``.
  801. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  802. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  803. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  804. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  805. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  806. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`