class_color.rst 35 KB

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