class_color.rst 35 KB

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