class_color.rst 37 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087
  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 opacity. 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 :ref:`@GDScript.ColorN<class_@GDScript_method_ColorN>` 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. Methods
  47. -------
  48. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`String<class_String>` from **)** |
  50. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`int<class_int>` from **)** |
  52. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)** |
  54. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)** |
  56. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`Color<class_Color>` | :ref:`blend<class_Color_method_blend>` **(** :ref:`Color<class_Color>` over **)** |
  58. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`Color<class_Color>` | :ref:`contrasted<class_Color_method_contrasted>` **(** **)** |
  60. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | :ref:`Color<class_Color>` | :ref:`darkened<class_Color_method_darkened>` **(** :ref:`float<class_float>` amount **)** |
  62. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | :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>` a=1.0 **)** |
  64. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | :ref:`float<class_float>` | :ref:`gray<class_Color_method_gray>` **(** **)** |
  66. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`Color<class_Color>` | :ref:`inverted<class_Color_method_inverted>` **(** **)** |
  68. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | :ref:`bool<class_bool>` | :ref:`is_equal_approx<class_Color_method_is_equal_approx>` **(** :ref:`Color<class_Color>` color **)** |
  70. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | :ref:`Color<class_Color>` | :ref:`lightened<class_Color_method_lightened>` **(** :ref:`float<class_float>` amount **)** |
  72. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | :ref:`Color<class_Color>` | :ref:`linear_interpolate<class_Color_method_linear_interpolate>` **(** :ref:`Color<class_Color>` to, :ref:`float<class_float>` weight **)** |
  74. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`int<class_int>` | :ref:`to_abgr32<class_Color_method_to_abgr32>` **(** **)** |
  76. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`int<class_int>` | :ref:`to_abgr64<class_Color_method_to_abgr64>` **(** **)** |
  78. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | :ref:`int<class_int>` | :ref:`to_argb32<class_Color_method_to_argb32>` **(** **)** |
  80. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | :ref:`int<class_int>` | :ref:`to_argb64<class_Color_method_to_argb64>` **(** **)** |
  82. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | :ref:`String<class_String>` | :ref:`to_html<class_Color_method_to_html>` **(** :ref:`bool<class_bool>` with_alpha=true **)** |
  84. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | :ref:`int<class_int>` | :ref:`to_rgba32<class_Color_method_to_rgba32>` **(** **)** |
  86. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | :ref:`int<class_int>` | :ref:`to_rgba64<class_Color_method_to_rgba64>` **(** **)** |
  88. +-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. Constants
  90. ---------
  91. .. _class_Color_constant_aliceblue:
  92. .. _class_Color_constant_antiquewhite:
  93. .. _class_Color_constant_aqua:
  94. .. _class_Color_constant_aquamarine:
  95. .. _class_Color_constant_azure:
  96. .. _class_Color_constant_beige:
  97. .. _class_Color_constant_bisque:
  98. .. _class_Color_constant_black:
  99. .. _class_Color_constant_blanchedalmond:
  100. .. _class_Color_constant_blue:
  101. .. _class_Color_constant_blueviolet:
  102. .. _class_Color_constant_brown:
  103. .. _class_Color_constant_burlywood:
  104. .. _class_Color_constant_cadetblue:
  105. .. _class_Color_constant_chartreuse:
  106. .. _class_Color_constant_chocolate:
  107. .. _class_Color_constant_coral:
  108. .. _class_Color_constant_cornflower:
  109. .. _class_Color_constant_cornsilk:
  110. .. _class_Color_constant_crimson:
  111. .. _class_Color_constant_cyan:
  112. .. _class_Color_constant_darkblue:
  113. .. _class_Color_constant_darkcyan:
  114. .. _class_Color_constant_darkgoldenrod:
  115. .. _class_Color_constant_darkgray:
  116. .. _class_Color_constant_darkgreen:
  117. .. _class_Color_constant_darkkhaki:
  118. .. _class_Color_constant_darkmagenta:
  119. .. _class_Color_constant_darkolivegreen:
  120. .. _class_Color_constant_darkorange:
  121. .. _class_Color_constant_darkorchid:
  122. .. _class_Color_constant_darkred:
  123. .. _class_Color_constant_darksalmon:
  124. .. _class_Color_constant_darkseagreen:
  125. .. _class_Color_constant_darkslateblue:
  126. .. _class_Color_constant_darkslategray:
  127. .. _class_Color_constant_darkturquoise:
  128. .. _class_Color_constant_darkviolet:
  129. .. _class_Color_constant_deeppink:
  130. .. _class_Color_constant_deepskyblue:
  131. .. _class_Color_constant_dimgray:
  132. .. _class_Color_constant_dodgerblue:
  133. .. _class_Color_constant_firebrick:
  134. .. _class_Color_constant_floralwhite:
  135. .. _class_Color_constant_forestgreen:
  136. .. _class_Color_constant_fuchsia:
  137. .. _class_Color_constant_gainsboro:
  138. .. _class_Color_constant_ghostwhite:
  139. .. _class_Color_constant_gold:
  140. .. _class_Color_constant_goldenrod:
  141. .. _class_Color_constant_gray:
  142. .. _class_Color_constant_green:
  143. .. _class_Color_constant_greenyellow:
  144. .. _class_Color_constant_honeydew:
  145. .. _class_Color_constant_hotpink:
  146. .. _class_Color_constant_indianred:
  147. .. _class_Color_constant_indigo:
  148. .. _class_Color_constant_ivory:
  149. .. _class_Color_constant_khaki:
  150. .. _class_Color_constant_lavender:
  151. .. _class_Color_constant_lavenderblush:
  152. .. _class_Color_constant_lawngreen:
  153. .. _class_Color_constant_lemonchiffon:
  154. .. _class_Color_constant_lightblue:
  155. .. _class_Color_constant_lightcoral:
  156. .. _class_Color_constant_lightcyan:
  157. .. _class_Color_constant_lightgoldenrod:
  158. .. _class_Color_constant_lightgray:
  159. .. _class_Color_constant_lightgreen:
  160. .. _class_Color_constant_lightpink:
  161. .. _class_Color_constant_lightsalmon:
  162. .. _class_Color_constant_lightseagreen:
  163. .. _class_Color_constant_lightskyblue:
  164. .. _class_Color_constant_lightslategray:
  165. .. _class_Color_constant_lightsteelblue:
  166. .. _class_Color_constant_lightyellow:
  167. .. _class_Color_constant_lime:
  168. .. _class_Color_constant_limegreen:
  169. .. _class_Color_constant_linen:
  170. .. _class_Color_constant_magenta:
  171. .. _class_Color_constant_maroon:
  172. .. _class_Color_constant_mediumaquamarine:
  173. .. _class_Color_constant_mediumblue:
  174. .. _class_Color_constant_mediumorchid:
  175. .. _class_Color_constant_mediumpurple:
  176. .. _class_Color_constant_mediumseagreen:
  177. .. _class_Color_constant_mediumslateblue:
  178. .. _class_Color_constant_mediumspringgreen:
  179. .. _class_Color_constant_mediumturquoise:
  180. .. _class_Color_constant_mediumvioletred:
  181. .. _class_Color_constant_midnightblue:
  182. .. _class_Color_constant_mintcream:
  183. .. _class_Color_constant_mistyrose:
  184. .. _class_Color_constant_moccasin:
  185. .. _class_Color_constant_navajowhite:
  186. .. _class_Color_constant_navyblue:
  187. .. _class_Color_constant_oldlace:
  188. .. _class_Color_constant_olive:
  189. .. _class_Color_constant_olivedrab:
  190. .. _class_Color_constant_orange:
  191. .. _class_Color_constant_orangered:
  192. .. _class_Color_constant_orchid:
  193. .. _class_Color_constant_palegoldenrod:
  194. .. _class_Color_constant_palegreen:
  195. .. _class_Color_constant_paleturquoise:
  196. .. _class_Color_constant_palevioletred:
  197. .. _class_Color_constant_papayawhip:
  198. .. _class_Color_constant_peachpuff:
  199. .. _class_Color_constant_peru:
  200. .. _class_Color_constant_pink:
  201. .. _class_Color_constant_plum:
  202. .. _class_Color_constant_powderblue:
  203. .. _class_Color_constant_purple:
  204. .. _class_Color_constant_rebeccapurple:
  205. .. _class_Color_constant_red:
  206. .. _class_Color_constant_rosybrown:
  207. .. _class_Color_constant_royalblue:
  208. .. _class_Color_constant_saddlebrown:
  209. .. _class_Color_constant_salmon:
  210. .. _class_Color_constant_sandybrown:
  211. .. _class_Color_constant_seagreen:
  212. .. _class_Color_constant_seashell:
  213. .. _class_Color_constant_sienna:
  214. .. _class_Color_constant_silver:
  215. .. _class_Color_constant_skyblue:
  216. .. _class_Color_constant_slateblue:
  217. .. _class_Color_constant_slategray:
  218. .. _class_Color_constant_snow:
  219. .. _class_Color_constant_springgreen:
  220. .. _class_Color_constant_steelblue:
  221. .. _class_Color_constant_tan:
  222. .. _class_Color_constant_teal:
  223. .. _class_Color_constant_thistle:
  224. .. _class_Color_constant_tomato:
  225. .. _class_Color_constant_transparent:
  226. .. _class_Color_constant_turquoise:
  227. .. _class_Color_constant_violet:
  228. .. _class_Color_constant_webgray:
  229. .. _class_Color_constant_webgreen:
  230. .. _class_Color_constant_webmaroon:
  231. .. _class_Color_constant_webpurple:
  232. .. _class_Color_constant_wheat:
  233. .. _class_Color_constant_white:
  234. .. _class_Color_constant_whitesmoke:
  235. .. _class_Color_constant_yellow:
  236. .. _class_Color_constant_yellowgreen:
  237. - **aliceblue** = **Color( 0.94, 0.97, 1, 1 )** --- Alice blue color.
  238. - **antiquewhite** = **Color( 0.98, 0.92, 0.84, 1 )** --- Antique white color.
  239. - **aqua** = **Color( 0, 1, 1, 1 )** --- Aqua color.
  240. - **aquamarine** = **Color( 0.5, 1, 0.83, 1 )** --- Aquamarine color.
  241. - **azure** = **Color( 0.94, 1, 1, 1 )** --- Azure color.
  242. - **beige** = **Color( 0.96, 0.96, 0.86, 1 )** --- Beige color.
  243. - **bisque** = **Color( 1, 0.89, 0.77, 1 )** --- Bisque color.
  244. - **black** = **Color( 0, 0, 0, 1 )** --- Black color.
  245. - **blanchedalmond** = **Color( 1, 0.92, 0.8, 1 )** --- Blanche almond color.
  246. - **blue** = **Color( 0, 0, 1, 1 )** --- Blue color.
  247. - **blueviolet** = **Color( 0.54, 0.17, 0.89, 1 )** --- Blue violet color.
  248. - **brown** = **Color( 0.65, 0.16, 0.16, 1 )** --- Brown color.
  249. - **burlywood** = **Color( 0.87, 0.72, 0.53, 1 )** --- Burly wood color.
  250. - **cadetblue** = **Color( 0.37, 0.62, 0.63, 1 )** --- Cadet blue color.
  251. - **chartreuse** = **Color( 0.5, 1, 0, 1 )** --- Chartreuse color.
  252. - **chocolate** = **Color( 0.82, 0.41, 0.12, 1 )** --- Chocolate color.
  253. - **coral** = **Color( 1, 0.5, 0.31, 1 )** --- Coral color.
  254. - **cornflower** = **Color( 0.39, 0.58, 0.93, 1 )** --- Cornflower color.
  255. - **cornsilk** = **Color( 1, 0.97, 0.86, 1 )** --- Corn silk color.
  256. - **crimson** = **Color( 0.86, 0.08, 0.24, 1 )** --- Crimson color.
  257. - **cyan** = **Color( 0, 1, 1, 1 )** --- Cyan color.
  258. - **darkblue** = **Color( 0, 0, 0.55, 1 )** --- Dark blue color.
  259. - **darkcyan** = **Color( 0, 0.55, 0.55, 1 )** --- Dark cyan color.
  260. - **darkgoldenrod** = **Color( 0.72, 0.53, 0.04, 1 )** --- Dark goldenrod color.
  261. - **darkgray** = **Color( 0.66, 0.66, 0.66, 1 )** --- Dark gray color.
  262. - **darkgreen** = **Color( 0, 0.39, 0, 1 )** --- Dark green color.
  263. - **darkkhaki** = **Color( 0.74, 0.72, 0.42, 1 )** --- Dark khaki color.
  264. - **darkmagenta** = **Color( 0.55, 0, 0.55, 1 )** --- Dark magenta color.
  265. - **darkolivegreen** = **Color( 0.33, 0.42, 0.18, 1 )** --- Dark olive green color.
  266. - **darkorange** = **Color( 1, 0.55, 0, 1 )** --- Dark orange color.
  267. - **darkorchid** = **Color( 0.6, 0.2, 0.8, 1 )** --- Dark orchid color.
  268. - **darkred** = **Color( 0.55, 0, 0, 1 )** --- Dark red color.
  269. - **darksalmon** = **Color( 0.91, 0.59, 0.48, 1 )** --- Dark salmon color.
  270. - **darkseagreen** = **Color( 0.56, 0.74, 0.56, 1 )** --- Dark sea green color.
  271. - **darkslateblue** = **Color( 0.28, 0.24, 0.55, 1 )** --- Dark slate blue color.
  272. - **darkslategray** = **Color( 0.18, 0.31, 0.31, 1 )** --- Dark slate gray color.
  273. - **darkturquoise** = **Color( 0, 0.81, 0.82, 1 )** --- Dark turquoise color.
  274. - **darkviolet** = **Color( 0.58, 0, 0.83, 1 )** --- Dark violet color.
  275. - **deeppink** = **Color( 1, 0.08, 0.58, 1 )** --- Deep pink color.
  276. - **deepskyblue** = **Color( 0, 0.75, 1, 1 )** --- Deep sky blue color.
  277. - **dimgray** = **Color( 0.41, 0.41, 0.41, 1 )** --- Dim gray color.
  278. - **dodgerblue** = **Color( 0.12, 0.56, 1, 1 )** --- Dodger blue color.
  279. - **firebrick** = **Color( 0.7, 0.13, 0.13, 1 )** --- Firebrick color.
  280. - **floralwhite** = **Color( 1, 0.98, 0.94, 1 )** --- Floral white color.
  281. - **forestgreen** = **Color( 0.13, 0.55, 0.13, 1 )** --- Forest green color.
  282. - **fuchsia** = **Color( 1, 0, 1, 1 )** --- Fuchsia color.
  283. - **gainsboro** = **Color( 0.86, 0.86, 0.86, 1 )** --- Gainsboro color.
  284. - **ghostwhite** = **Color( 0.97, 0.97, 1, 1 )** --- Ghost white color.
  285. - **gold** = **Color( 1, 0.84, 0, 1 )** --- Gold color.
  286. - **goldenrod** = **Color( 0.85, 0.65, 0.13, 1 )** --- Goldenrod color.
  287. - **gray** = **Color( 0.75, 0.75, 0.75, 1 )** --- Gray color.
  288. - **green** = **Color( 0, 1, 0, 1 )** --- Green color.
  289. - **greenyellow** = **Color( 0.68, 1, 0.18, 1 )** --- Green yellow color.
  290. - **honeydew** = **Color( 0.94, 1, 0.94, 1 )** --- Honeydew color.
  291. - **hotpink** = **Color( 1, 0.41, 0.71, 1 )** --- Hot pink color.
  292. - **indianred** = **Color( 0.8, 0.36, 0.36, 1 )** --- Indian red color.
  293. - **indigo** = **Color( 0.29, 0, 0.51, 1 )** --- Indigo color.
  294. - **ivory** = **Color( 1, 1, 0.94, 1 )** --- Ivory color.
  295. - **khaki** = **Color( 0.94, 0.9, 0.55, 1 )** --- Khaki color.
  296. - **lavender** = **Color( 0.9, 0.9, 0.98, 1 )** --- Lavender color.
  297. - **lavenderblush** = **Color( 1, 0.94, 0.96, 1 )** --- Lavender blush color.
  298. - **lawngreen** = **Color( 0.49, 0.99, 0, 1 )** --- Lawn green color.
  299. - **lemonchiffon** = **Color( 1, 0.98, 0.8, 1 )** --- Lemon chiffon color.
  300. - **lightblue** = **Color( 0.68, 0.85, 0.9, 1 )** --- Light blue color.
  301. - **lightcoral** = **Color( 0.94, 0.5, 0.5, 1 )** --- Light coral color.
  302. - **lightcyan** = **Color( 0.88, 1, 1, 1 )** --- Light cyan color.
  303. - **lightgoldenrod** = **Color( 0.98, 0.98, 0.82, 1 )** --- Light goldenrod color.
  304. - **lightgray** = **Color( 0.83, 0.83, 0.83, 1 )** --- Light gray color.
  305. - **lightgreen** = **Color( 0.56, 0.93, 0.56, 1 )** --- Light green color.
  306. - **lightpink** = **Color( 1, 0.71, 0.76, 1 )** --- Light pink color.
  307. - **lightsalmon** = **Color( 1, 0.63, 0.48, 1 )** --- Light salmon color.
  308. - **lightseagreen** = **Color( 0.13, 0.7, 0.67, 1 )** --- Light sea green color.
  309. - **lightskyblue** = **Color( 0.53, 0.81, 0.98, 1 )** --- Light sky blue color.
  310. - **lightslategray** = **Color( 0.47, 0.53, 0.6, 1 )** --- Light slate gray color.
  311. - **lightsteelblue** = **Color( 0.69, 0.77, 0.87, 1 )** --- Light steel blue color.
  312. - **lightyellow** = **Color( 1, 1, 0.88, 1 )** --- Light yellow color.
  313. - **lime** = **Color( 0, 1, 0, 1 )** --- Lime color.
  314. - **limegreen** = **Color( 0.2, 0.8, 0.2, 1 )** --- Lime green color.
  315. - **linen** = **Color( 0.98, 0.94, 0.9, 1 )** --- Linen color.
  316. - **magenta** = **Color( 1, 0, 1, 1 )** --- Magenta color.
  317. - **maroon** = **Color( 0.69, 0.19, 0.38, 1 )** --- Maroon color.
  318. - **mediumaquamarine** = **Color( 0.4, 0.8, 0.67, 1 )** --- Medium aquamarine color.
  319. - **mediumblue** = **Color( 0, 0, 0.8, 1 )** --- Medium blue color.
  320. - **mediumorchid** = **Color( 0.73, 0.33, 0.83, 1 )** --- Medium orchid color.
  321. - **mediumpurple** = **Color( 0.58, 0.44, 0.86, 1 )** --- Medium purple color.
  322. - **mediumseagreen** = **Color( 0.24, 0.7, 0.44, 1 )** --- Medium sea green color.
  323. - **mediumslateblue** = **Color( 0.48, 0.41, 0.93, 1 )** --- Medium slate blue color.
  324. - **mediumspringgreen** = **Color( 0, 0.98, 0.6, 1 )** --- Medium spring green color.
  325. - **mediumturquoise** = **Color( 0.28, 0.82, 0.8, 1 )** --- Medium turquoise color.
  326. - **mediumvioletred** = **Color( 0.78, 0.08, 0.52, 1 )** --- Medium violet red color.
  327. - **midnightblue** = **Color( 0.1, 0.1, 0.44, 1 )** --- Midnight blue color.
  328. - **mintcream** = **Color( 0.96, 1, 0.98, 1 )** --- Mint cream color.
  329. - **mistyrose** = **Color( 1, 0.89, 0.88, 1 )** --- Misty rose color.
  330. - **moccasin** = **Color( 1, 0.89, 0.71, 1 )** --- Moccasin color.
  331. - **navajowhite** = **Color( 1, 0.87, 0.68, 1 )** --- Navajo white color.
  332. - **navyblue** = **Color( 0, 0, 0.5, 1 )** --- Navy blue color.
  333. - **oldlace** = **Color( 0.99, 0.96, 0.9, 1 )** --- Old lace color.
  334. - **olive** = **Color( 0.5, 0.5, 0, 1 )** --- Olive color.
  335. - **olivedrab** = **Color( 0.42, 0.56, 0.14, 1 )** --- Olive drab color.
  336. - **orange** = **Color( 1, 0.65, 0, 1 )** --- Orange color.
  337. - **orangered** = **Color( 1, 0.27, 0, 1 )** --- Orange red color.
  338. - **orchid** = **Color( 0.85, 0.44, 0.84, 1 )** --- Orchid color.
  339. - **palegoldenrod** = **Color( 0.93, 0.91, 0.67, 1 )** --- Pale goldenrod color.
  340. - **palegreen** = **Color( 0.6, 0.98, 0.6, 1 )** --- Pale green color.
  341. - **paleturquoise** = **Color( 0.69, 0.93, 0.93, 1 )** --- Pale turquoise color.
  342. - **palevioletred** = **Color( 0.86, 0.44, 0.58, 1 )** --- Pale violet red color.
  343. - **papayawhip** = **Color( 1, 0.94, 0.84, 1 )** --- Papaya whip color.
  344. - **peachpuff** = **Color( 1, 0.85, 0.73, 1 )** --- Peach puff color.
  345. - **peru** = **Color( 0.8, 0.52, 0.25, 1 )** --- Peru color.
  346. - **pink** = **Color( 1, 0.75, 0.8, 1 )** --- Pink color.
  347. - **plum** = **Color( 0.87, 0.63, 0.87, 1 )** --- Plum color.
  348. - **powderblue** = **Color( 0.69, 0.88, 0.9, 1 )** --- Powder blue color.
  349. - **purple** = **Color( 0.63, 0.13, 0.94, 1 )** --- Purple color.
  350. - **rebeccapurple** = **Color( 0.4, 0.2, 0.6, 1 )** --- Rebecca purple color.
  351. - **red** = **Color( 1, 0, 0, 1 )** --- Red color.
  352. - **rosybrown** = **Color( 0.74, 0.56, 0.56, 1 )** --- Rosy brown color.
  353. - **royalblue** = **Color( 0.25, 0.41, 0.88, 1 )** --- Royal blue color.
  354. - **saddlebrown** = **Color( 0.55, 0.27, 0.07, 1 )** --- Saddle brown color.
  355. - **salmon** = **Color( 0.98, 0.5, 0.45, 1 )** --- Salmon color.
  356. - **sandybrown** = **Color( 0.96, 0.64, 0.38, 1 )** --- Sandy brown color.
  357. - **seagreen** = **Color( 0.18, 0.55, 0.34, 1 )** --- Sea green color.
  358. - **seashell** = **Color( 1, 0.96, 0.93, 1 )** --- Seashell color.
  359. - **sienna** = **Color( 0.63, 0.32, 0.18, 1 )** --- Sienna color.
  360. - **silver** = **Color( 0.75, 0.75, 0.75, 1 )** --- Silver color.
  361. - **skyblue** = **Color( 0.53, 0.81, 0.92, 1 )** --- Sky blue color.
  362. - **slateblue** = **Color( 0.42, 0.35, 0.8, 1 )** --- Slate blue color.
  363. - **slategray** = **Color( 0.44, 0.5, 0.56, 1 )** --- Slate gray color.
  364. - **snow** = **Color( 1, 0.98, 0.98, 1 )** --- Snow color.
  365. - **springgreen** = **Color( 0, 1, 0.5, 1 )** --- Spring green color.
  366. - **steelblue** = **Color( 0.27, 0.51, 0.71, 1 )** --- Steel blue color.
  367. - **tan** = **Color( 0.82, 0.71, 0.55, 1 )** --- Tan color.
  368. - **teal** = **Color( 0, 0.5, 0.5, 1 )** --- Teal color.
  369. - **thistle** = **Color( 0.85, 0.75, 0.85, 1 )** --- Thistle color.
  370. - **tomato** = **Color( 1, 0.39, 0.28, 1 )** --- Tomato color.
  371. - **transparent** = **Color( 1, 1, 1, 0 )** --- Transparent color (white with no alpha).
  372. - **turquoise** = **Color( 0.25, 0.88, 0.82, 1 )** --- Turquoise color.
  373. - **violet** = **Color( 0.93, 0.51, 0.93, 1 )** --- Violet color.
  374. - **webgray** = **Color( 0.5, 0.5, 0.5, 1 )** --- Web gray color.
  375. - **webgreen** = **Color( 0, 0.5, 0, 1 )** --- Web green color.
  376. - **webmaroon** = **Color( 0.5, 0, 0, 1 )** --- Web maroon color.
  377. - **webpurple** = **Color( 0.5, 0, 0.5, 1 )** --- Web purple color.
  378. - **wheat** = **Color( 0.96, 0.87, 0.7, 1 )** --- Wheat color.
  379. - **white** = **Color( 1, 1, 1, 1 )** --- White color.
  380. - **whitesmoke** = **Color( 0.96, 0.96, 0.96, 1 )** --- White smoke color.
  381. - **yellow** = **Color( 1, 1, 0, 1 )** --- Yellow color.
  382. - **yellowgreen** = **Color( 0.6, 0.8, 0.2, 1 )** --- Yellow green color.
  383. Property Descriptions
  384. ---------------------
  385. .. _class_Color_property_a:
  386. - :ref:`float<class_float>` **a**
  387. +-----------+---------+
  388. | *Default* | ``1.0`` |
  389. +-----------+---------+
  390. 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.
  391. ----
  392. .. _class_Color_property_a8:
  393. - :ref:`int<class_int>` **a8**
  394. +-----------+---------+
  395. | *Default* | ``255`` |
  396. +-----------+---------+
  397. Wrapper for :ref:`a<class_Color_property_a>` that uses the range 0 to 255 instead of 0 to 1.
  398. ----
  399. .. _class_Color_property_b:
  400. - :ref:`float<class_float>` **b**
  401. +-----------+---------+
  402. | *Default* | ``0.0`` |
  403. +-----------+---------+
  404. The color's blue component, typically on the range of 0 to 1.
  405. ----
  406. .. _class_Color_property_b8:
  407. - :ref:`int<class_int>` **b8**
  408. +-----------+-------+
  409. | *Default* | ``0`` |
  410. +-----------+-------+
  411. Wrapper for :ref:`b<class_Color_property_b>` that uses the range 0 to 255 instead of 0 to 1.
  412. ----
  413. .. _class_Color_property_g:
  414. - :ref:`float<class_float>` **g**
  415. +-----------+---------+
  416. | *Default* | ``0.0`` |
  417. +-----------+---------+
  418. The color's green component, typically on the range of 0 to 1.
  419. ----
  420. .. _class_Color_property_g8:
  421. - :ref:`int<class_int>` **g8**
  422. +-----------+-------+
  423. | *Default* | ``0`` |
  424. +-----------+-------+
  425. Wrapper for :ref:`g<class_Color_property_g>` that uses the range 0 to 255 instead of 0 to 1.
  426. ----
  427. .. _class_Color_property_h:
  428. - :ref:`float<class_float>` **h**
  429. +-----------+---------+
  430. | *Default* | ``0.0`` |
  431. +-----------+---------+
  432. The HSV hue of this color, on the range 0 to 1.
  433. ----
  434. .. _class_Color_property_r:
  435. - :ref:`float<class_float>` **r**
  436. +-----------+---------+
  437. | *Default* | ``0.0`` |
  438. +-----------+---------+
  439. The color's red component, typically on the range of 0 to 1.
  440. ----
  441. .. _class_Color_property_r8:
  442. - :ref:`int<class_int>` **r8**
  443. +-----------+-------+
  444. | *Default* | ``0`` |
  445. +-----------+-------+
  446. Wrapper for :ref:`r<class_Color_property_r>` that uses the range 0 to 255 instead of 0 to 1.
  447. ----
  448. .. _class_Color_property_s:
  449. - :ref:`float<class_float>` **s**
  450. +-----------+---------+
  451. | *Default* | ``0.0`` |
  452. +-----------+---------+
  453. The HSV saturation of this color, on the range 0 to 1.
  454. ----
  455. .. _class_Color_property_v:
  456. - :ref:`float<class_float>` **v**
  457. +-----------+---------+
  458. | *Default* | ``0.0`` |
  459. +-----------+---------+
  460. The HSV value (brightness) of this color, on the range 0 to 1.
  461. Method Descriptions
  462. -------------------
  463. .. _class_Color_method_Color:
  464. - :ref:`Color<class_Color>` **Color** **(** :ref:`String<class_String>` from **)**
  465. Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also :ref:`@GDScript.ColorN<class_@GDScript_method_ColorN>`.
  466. ::
  467. # Each of the following creates the same color RGBA(178, 217, 10, 255).
  468. var c1 = Color("#ffb2d90a") # ARGB format with "#".
  469. var c2 = Color("ffb2d90a") # ARGB format.
  470. var c3 = Color("#b2d90a") # RGB format with "#".
  471. var c4 = Color("b2d90a") # RGB format.
  472. ----
  473. - :ref:`Color<class_Color>` **Color** **(** :ref:`int<class_int>` from **)**
  474. Constructs a color from a 32-bit integer in RGBA format (each byte represents a color channel).
  475. ::
  476. var c = Color(274) # Similar to Color(0.0, 0.0, 0.004, 0.07)
  477. ----
  478. - :ref:`Color<class_Color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)**
  479. Constructs a color from RGB values, typically between 0 and 1. Alpha will be 1.
  480. ::
  481. var color = Color(0.2, 1.0, 0.7) # Similar to Color8(51, 255, 178, 255)
  482. ----
  483. - :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 **)**
  484. Constructs a color from RGBA values, typically between 0 and 1.
  485. ::
  486. var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to Color8(51, 255, 178, 204)
  487. ----
  488. .. _class_Color_method_blend:
  489. - :ref:`Color<class_Color>` **blend** **(** :ref:`Color<class_Color>` over **)**
  490. 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.
  491. ::
  492. var bg = Color(0.0, 1.0, 0.0, 0.5) # Green with alpha of 50%
  493. var fg = Color(1.0, 0.0, 0.0, 0.5) # Red with alpha of 50%
  494. var blended_color = bg.blend(fg) # Brown with alpha of 75%
  495. ----
  496. .. _class_Color_method_contrasted:
  497. - :ref:`Color<class_Color>` **contrasted** **(** **)**
  498. Returns the most contrasting color.
  499. ::
  500. var c = Color(0.3, 0.4, 0.9)
  501. var contrasted_color = c.contrasted() # Equivalent to RGBA(204, 229, 102, 255)
  502. ----
  503. .. _class_Color_method_darkened:
  504. - :ref:`Color<class_Color>` **darkened** **(** :ref:`float<class_float>` amount **)**
  505. Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1).
  506. ::
  507. var green = Color(0.0, 1.0, 0.0)
  508. var darkgreen = green.darkened(0.2) # 20% darker than regular green
  509. ----
  510. .. _class_Color_method_from_hsv:
  511. - :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>` a=1.0 **)**
  512. Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values between 0 and 1.
  513. ::
  514. var c = Color.from_hsv(0.58, 0.5, 0.79, 0.8) # Equivalent to HSV(210, 50, 79, 0.8) or Color8(100, 151, 201, 0.8)
  515. ----
  516. .. _class_Color_method_gray:
  517. - :ref:`float<class_float>` **gray** **(** **)**
  518. Returns the color's grayscale representation.
  519. The gray value is calculated as ``(r + g + b) / 3``.
  520. ::
  521. var c = Color(0.2, 0.45, 0.82)
  522. var gray = c.gray() # A value of 0.466667
  523. ----
  524. .. _class_Color_method_inverted:
  525. - :ref:`Color<class_Color>` **inverted** **(** **)**
  526. Returns the inverted color ``(1 - r, 1 - g, 1 - b, a)``.
  527. ::
  528. var color = Color(0.3, 0.4, 0.9)
  529. var inverted_color = color.inverted() # Equivalent to Color(0.7, 0.6, 0.1)
  530. ----
  531. .. _class_Color_method_is_equal_approx:
  532. - :ref:`bool<class_bool>` **is_equal_approx** **(** :ref:`Color<class_Color>` color **)**
  533. Returns ``true`` if this color and ``color`` are approximately equal, by running :ref:`@GDScript.is_equal_approx<class_@GDScript_method_is_equal_approx>` on each component.
  534. ----
  535. .. _class_Color_method_lightened:
  536. - :ref:`Color<class_Color>` **lightened** **(** :ref:`float<class_float>` amount **)**
  537. Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1).
  538. ::
  539. var green = Color(0.0, 1.0, 0.0)
  540. var lightgreen = green.lightened(0.2) # 20% lighter than regular green
  541. ----
  542. .. _class_Color_method_linear_interpolate:
  543. - :ref:`Color<class_Color>` **linear_interpolate** **(** :ref:`Color<class_Color>` to, :ref:`float<class_float>` weight **)**
  544. Returns the linear interpolation with another color. The interpolation factor ``weight`` is between 0 and 1.
  545. ::
  546. var c1 = Color(1.0, 0.0, 0.0)
  547. var c2 = Color(0.0, 1.0, 0.0)
  548. var li_c = c1.linear_interpolate(c2, 0.5) # Equivalent to Color(0.5, 0.5, 0.0)
  549. ----
  550. .. _class_Color_method_to_abgr32:
  551. - :ref:`int<class_int>` **to_abgr32** **(** **)**
  552. 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.
  553. ::
  554. var color = Color(1, 0.5, 0.2)
  555. print(color.to_abgr32()) # Prints 4281565439
  556. ----
  557. .. _class_Color_method_to_abgr64:
  558. - :ref:`int<class_int>` **to_abgr64** **(** **)**
  559. 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.
  560. ::
  561. var color = Color(1, 0.5, 0.2)
  562. print(color.to_abgr64()) # Prints -225178692812801
  563. ----
  564. .. _class_Color_method_to_argb32:
  565. - :ref:`int<class_int>` **to_argb32** **(** **)**
  566. Returns the color converted to a 32-bit integer in ARGB format (each byte represents a color channel). ARGB is more compatible with DirectX.
  567. ::
  568. var color = Color(1, 0.5, 0.2)
  569. print(color.to_argb32()) # Prints 4294934323
  570. ----
  571. .. _class_Color_method_to_argb64:
  572. - :ref:`int<class_int>` **to_argb64** **(** **)**
  573. Returns the color converted to a 64-bit integer in ARGB format (each word represents a color channel). ARGB is more compatible with DirectX.
  574. ::
  575. var color = Color(1, 0.5, 0.2)
  576. print(color.to_argb64()) # Prints -2147470541
  577. ----
  578. .. _class_Color_method_to_html:
  579. - :ref:`String<class_String>` **to_html** **(** :ref:`bool<class_bool>` with_alpha=true **)**
  580. Returns the color's HTML hexadecimal color string in ARGB format (ex: ``ff34f822``).
  581. Setting ``with_alpha`` to ``false`` excludes alpha from the hexadecimal string.
  582. ::
  583. var c = Color(1, 1, 1, 0.5)
  584. var s1 = c.to_html() # Returns "7fffffff"
  585. var s2 = c.to_html(false) # Returns "ffffff"
  586. ----
  587. .. _class_Color_method_to_rgba32:
  588. - :ref:`int<class_int>` **to_rgba32** **(** **)**
  589. Returns the color converted to a 32-bit integer in RGBA format (each byte represents a color channel). RGBA is Godot's default format.
  590. ::
  591. var color = Color(1, 0.5, 0.2)
  592. print(color.to_rgba32()) # Prints 4286526463
  593. ----
  594. .. _class_Color_method_to_rgba64:
  595. - :ref:`int<class_int>` **to_rgba64** **(** **)**
  596. Returns the color converted to a 64-bit integer in RGBA format (each word represents a color channel). RGBA is Godot's default format.
  597. ::
  598. var color = Color(1, 0.5, 0.2)
  599. print(color.to_rgba64()) # Prints -140736629309441
  600. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  601. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  602. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`