class_color.rst 31 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007
  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. **Category:** Built-In Types
  9. Brief Description
  10. -----------------
  11. Color in RGBA format with some support for ARGB format.
  12. Properties
  13. ----------
  14. +---------------------------+------------------------------------+-----+
  15. | :ref:`float<class_float>` | :ref:`a<class_Color_property_a>` | 1.0 |
  16. +---------------------------+------------------------------------+-----+
  17. | :ref:`int<class_int>` | :ref:`a8<class_Color_property_a8>` | 255 |
  18. +---------------------------+------------------------------------+-----+
  19. | :ref:`float<class_float>` | :ref:`b<class_Color_property_b>` | 0.0 |
  20. +---------------------------+------------------------------------+-----+
  21. | :ref:`int<class_int>` | :ref:`b8<class_Color_property_b8>` | 0 |
  22. +---------------------------+------------------------------------+-----+
  23. | :ref:`float<class_float>` | :ref:`g<class_Color_property_g>` | 0.0 |
  24. +---------------------------+------------------------------------+-----+
  25. | :ref:`int<class_int>` | :ref:`g8<class_Color_property_g8>` | 0 |
  26. +---------------------------+------------------------------------+-----+
  27. | :ref:`float<class_float>` | :ref:`h<class_Color_property_h>` | 0.0 |
  28. +---------------------------+------------------------------------+-----+
  29. | :ref:`float<class_float>` | :ref:`r<class_Color_property_r>` | 0.0 |
  30. +---------------------------+------------------------------------+-----+
  31. | :ref:`int<class_int>` | :ref:`r8<class_Color_property_r8>` | 0 |
  32. +---------------------------+------------------------------------+-----+
  33. | :ref:`float<class_float>` | :ref:`s<class_Color_property_s>` | 0.0 |
  34. +---------------------------+------------------------------------+-----+
  35. | :ref:`float<class_float>` | :ref:`v<class_Color_property_v>` | 0.0 |
  36. +---------------------------+------------------------------------+-----+
  37. Methods
  38. -------
  39. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`String<class_String>` from **)** |
  41. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`int<class_int>` from **)** |
  43. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :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 **)** |
  45. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :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 **)** |
  47. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`Color<class_Color>` | :ref:`blend<class_Color_method_blend>` **(** :ref:`Color<class_Color>` over **)** |
  49. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`Color<class_Color>` | :ref:`contrasted<class_Color_method_contrasted>` **(** **)** |
  51. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | :ref:`Color<class_Color>` | :ref:`darkened<class_Color_method_darkened>` **(** :ref:`float<class_float>` amount **)** |
  53. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :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 **)** |
  55. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`float<class_float>` | :ref:`gray<class_Color_method_gray>` **(** **)** |
  57. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`Color<class_Color>` | :ref:`inverted<class_Color_method_inverted>` **(** **)** |
  59. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :ref:`Color<class_Color>` | :ref:`lightened<class_Color_method_lightened>` **(** :ref:`float<class_float>` amount **)** |
  61. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`Color<class_Color>` | :ref:`linear_interpolate<class_Color_method_linear_interpolate>` **(** :ref:`Color<class_Color>` b, :ref:`float<class_float>` t **)** |
  63. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`int<class_int>` | :ref:`to_abgr32<class_Color_method_to_abgr32>` **(** **)** |
  65. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`int<class_int>` | :ref:`to_abgr64<class_Color_method_to_abgr64>` **(** **)** |
  67. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`int<class_int>` | :ref:`to_argb32<class_Color_method_to_argb32>` **(** **)** |
  69. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`int<class_int>` | :ref:`to_argb64<class_Color_method_to_argb64>` **(** **)** |
  71. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :ref:`String<class_String>` | :ref:`to_html<class_Color_method_to_html>` **(** :ref:`bool<class_bool>` with_alpha=True **)** |
  73. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`int<class_int>` | :ref:`to_rgba32<class_Color_method_to_rgba32>` **(** **)** |
  75. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :ref:`int<class_int>` | :ref:`to_rgba64<class_Color_method_to_rgba64>` **(** **)** |
  77. +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. Constants
  79. ---------
  80. .. _class_Color_constant_gray:
  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_green:
  132. .. _class_Color_constant_greenyellow:
  133. .. _class_Color_constant_honeydew:
  134. .. _class_Color_constant_hotpink:
  135. .. _class_Color_constant_indianred:
  136. .. _class_Color_constant_indigo:
  137. .. _class_Color_constant_ivory:
  138. .. _class_Color_constant_khaki:
  139. .. _class_Color_constant_lavender:
  140. .. _class_Color_constant_lavenderblush:
  141. .. _class_Color_constant_lawngreen:
  142. .. _class_Color_constant_lemonchiffon:
  143. .. _class_Color_constant_lightblue:
  144. .. _class_Color_constant_lightcoral:
  145. .. _class_Color_constant_lightcyan:
  146. .. _class_Color_constant_lightgoldenrod:
  147. .. _class_Color_constant_lightgray:
  148. .. _class_Color_constant_lightgreen:
  149. .. _class_Color_constant_lightpink:
  150. .. _class_Color_constant_lightsalmon:
  151. .. _class_Color_constant_lightseagreen:
  152. .. _class_Color_constant_lightskyblue:
  153. .. _class_Color_constant_lightslategray:
  154. .. _class_Color_constant_lightsteelblue:
  155. .. _class_Color_constant_lightyellow:
  156. .. _class_Color_constant_lime:
  157. .. _class_Color_constant_limegreen:
  158. .. _class_Color_constant_linen:
  159. .. _class_Color_constant_magenta:
  160. .. _class_Color_constant_maroon:
  161. .. _class_Color_constant_mediumaquamarine:
  162. .. _class_Color_constant_mediumblue:
  163. .. _class_Color_constant_mediumorchid:
  164. .. _class_Color_constant_mediumpurple:
  165. .. _class_Color_constant_mediumseagreen:
  166. .. _class_Color_constant_mediumslateblue:
  167. .. _class_Color_constant_mediumspringgreen:
  168. .. _class_Color_constant_mediumturquoise:
  169. .. _class_Color_constant_mediumvioletred:
  170. .. _class_Color_constant_midnightblue:
  171. .. _class_Color_constant_mintcream:
  172. .. _class_Color_constant_mistyrose:
  173. .. _class_Color_constant_moccasin:
  174. .. _class_Color_constant_navajowhite:
  175. .. _class_Color_constant_navyblue:
  176. .. _class_Color_constant_oldlace:
  177. .. _class_Color_constant_olive:
  178. .. _class_Color_constant_olivedrab:
  179. .. _class_Color_constant_orange:
  180. .. _class_Color_constant_orangered:
  181. .. _class_Color_constant_orchid:
  182. .. _class_Color_constant_palegoldenrod:
  183. .. _class_Color_constant_palegreen:
  184. .. _class_Color_constant_paleturquoise:
  185. .. _class_Color_constant_palevioletred:
  186. .. _class_Color_constant_papayawhip:
  187. .. _class_Color_constant_peachpuff:
  188. .. _class_Color_constant_peru:
  189. .. _class_Color_constant_pink:
  190. .. _class_Color_constant_plum:
  191. .. _class_Color_constant_powderblue:
  192. .. _class_Color_constant_purple:
  193. .. _class_Color_constant_rebeccapurple:
  194. .. _class_Color_constant_red:
  195. .. _class_Color_constant_rosybrown:
  196. .. _class_Color_constant_royalblue:
  197. .. _class_Color_constant_saddlebrown:
  198. .. _class_Color_constant_salmon:
  199. .. _class_Color_constant_sandybrown:
  200. .. _class_Color_constant_seagreen:
  201. .. _class_Color_constant_seashell:
  202. .. _class_Color_constant_sienna:
  203. .. _class_Color_constant_silver:
  204. .. _class_Color_constant_skyblue:
  205. .. _class_Color_constant_slateblue:
  206. .. _class_Color_constant_slategray:
  207. .. _class_Color_constant_snow:
  208. .. _class_Color_constant_springgreen:
  209. .. _class_Color_constant_steelblue:
  210. .. _class_Color_constant_tan:
  211. .. _class_Color_constant_teal:
  212. .. _class_Color_constant_thistle:
  213. .. _class_Color_constant_tomato:
  214. .. _class_Color_constant_transparent:
  215. .. _class_Color_constant_turquoise:
  216. .. _class_Color_constant_violet:
  217. .. _class_Color_constant_webgray:
  218. .. _class_Color_constant_webgreen:
  219. .. _class_Color_constant_webmaroon:
  220. .. _class_Color_constant_webpurple:
  221. .. _class_Color_constant_wheat:
  222. .. _class_Color_constant_white:
  223. .. _class_Color_constant_whitesmoke:
  224. .. _class_Color_constant_yellow:
  225. .. _class_Color_constant_yellowgreen:
  226. - **gray** = **Color( 0.75, 0.75, 0.75, 1 )**
  227. - **aliceblue** = **Color( 0.94, 0.97, 1, 1 )**
  228. - **antiquewhite** = **Color( 0.98, 0.92, 0.84, 1 )**
  229. - **aqua** = **Color( 0, 1, 1, 1 )**
  230. - **aquamarine** = **Color( 0.5, 1, 0.83, 1 )**
  231. - **azure** = **Color( 0.94, 1, 1, 1 )**
  232. - **beige** = **Color( 0.96, 0.96, 0.86, 1 )**
  233. - **bisque** = **Color( 1, 0.89, 0.77, 1 )**
  234. - **black** = **Color( 0, 0, 0, 1 )**
  235. - **blanchedalmond** = **Color( 1, 0.92, 0.8, 1 )**
  236. - **blue** = **Color( 0, 0, 1, 1 )**
  237. - **blueviolet** = **Color( 0.54, 0.17, 0.89, 1 )**
  238. - **brown** = **Color( 0.65, 0.16, 0.16, 1 )**
  239. - **burlywood** = **Color( 0.87, 0.72, 0.53, 1 )**
  240. - **cadetblue** = **Color( 0.37, 0.62, 0.63, 1 )**
  241. - **chartreuse** = **Color( 0.5, 1, 0, 1 )**
  242. - **chocolate** = **Color( 0.82, 0.41, 0.12, 1 )**
  243. - **coral** = **Color( 1, 0.5, 0.31, 1 )**
  244. - **cornflower** = **Color( 0.39, 0.58, 0.93, 1 )**
  245. - **cornsilk** = **Color( 1, 0.97, 0.86, 1 )**
  246. - **crimson** = **Color( 0.86, 0.08, 0.24, 1 )**
  247. - **cyan** = **Color( 0, 1, 1, 1 )**
  248. - **darkblue** = **Color( 0, 0, 0.55, 1 )**
  249. - **darkcyan** = **Color( 0, 0.55, 0.55, 1 )**
  250. - **darkgoldenrod** = **Color( 0.72, 0.53, 0.04, 1 )**
  251. - **darkgray** = **Color( 0.66, 0.66, 0.66, 1 )**
  252. - **darkgreen** = **Color( 0, 0.39, 0, 1 )**
  253. - **darkkhaki** = **Color( 0.74, 0.72, 0.42, 1 )**
  254. - **darkmagenta** = **Color( 0.55, 0, 0.55, 1 )**
  255. - **darkolivegreen** = **Color( 0.33, 0.42, 0.18, 1 )**
  256. - **darkorange** = **Color( 1, 0.55, 0, 1 )**
  257. - **darkorchid** = **Color( 0.6, 0.2, 0.8, 1 )**
  258. - **darkred** = **Color( 0.55, 0, 0, 1 )**
  259. - **darksalmon** = **Color( 0.91, 0.59, 0.48, 1 )**
  260. - **darkseagreen** = **Color( 0.56, 0.74, 0.56, 1 )**
  261. - **darkslateblue** = **Color( 0.28, 0.24, 0.55, 1 )**
  262. - **darkslategray** = **Color( 0.18, 0.31, 0.31, 1 )**
  263. - **darkturquoise** = **Color( 0, 0.81, 0.82, 1 )**
  264. - **darkviolet** = **Color( 0.58, 0, 0.83, 1 )**
  265. - **deeppink** = **Color( 1, 0.08, 0.58, 1 )**
  266. - **deepskyblue** = **Color( 0, 0.75, 1, 1 )**
  267. - **dimgray** = **Color( 0.41, 0.41, 0.41, 1 )**
  268. - **dodgerblue** = **Color( 0.12, 0.56, 1, 1 )**
  269. - **firebrick** = **Color( 0.7, 0.13, 0.13, 1 )**
  270. - **floralwhite** = **Color( 1, 0.98, 0.94, 1 )**
  271. - **forestgreen** = **Color( 0.13, 0.55, 0.13, 1 )**
  272. - **fuchsia** = **Color( 1, 0, 1, 1 )**
  273. - **gainsboro** = **Color( 0.86, 0.86, 0.86, 1 )**
  274. - **ghostwhite** = **Color( 0.97, 0.97, 1, 1 )**
  275. - **gold** = **Color( 1, 0.84, 0, 1 )**
  276. - **goldenrod** = **Color( 0.85, 0.65, 0.13, 1 )**
  277. - **green** = **Color( 0, 1, 0, 1 )**
  278. - **greenyellow** = **Color( 0.68, 1, 0.18, 1 )**
  279. - **honeydew** = **Color( 0.94, 1, 0.94, 1 )**
  280. - **hotpink** = **Color( 1, 0.41, 0.71, 1 )**
  281. - **indianred** = **Color( 0.8, 0.36, 0.36, 1 )**
  282. - **indigo** = **Color( 0.29, 0, 0.51, 1 )**
  283. - **ivory** = **Color( 1, 1, 0.94, 1 )**
  284. - **khaki** = **Color( 0.94, 0.9, 0.55, 1 )**
  285. - **lavender** = **Color( 0.9, 0.9, 0.98, 1 )**
  286. - **lavenderblush** = **Color( 1, 0.94, 0.96, 1 )**
  287. - **lawngreen** = **Color( 0.49, 0.99, 0, 1 )**
  288. - **lemonchiffon** = **Color( 1, 0.98, 0.8, 1 )**
  289. - **lightblue** = **Color( 0.68, 0.85, 0.9, 1 )**
  290. - **lightcoral** = **Color( 0.94, 0.5, 0.5, 1 )**
  291. - **lightcyan** = **Color( 0.88, 1, 1, 1 )**
  292. - **lightgoldenrod** = **Color( 0.98, 0.98, 0.82, 1 )**
  293. - **lightgray** = **Color( 0.83, 0.83, 0.83, 1 )**
  294. - **lightgreen** = **Color( 0.56, 0.93, 0.56, 1 )**
  295. - **lightpink** = **Color( 1, 0.71, 0.76, 1 )**
  296. - **lightsalmon** = **Color( 1, 0.63, 0.48, 1 )**
  297. - **lightseagreen** = **Color( 0.13, 0.7, 0.67, 1 )**
  298. - **lightskyblue** = **Color( 0.53, 0.81, 0.98, 1 )**
  299. - **lightslategray** = **Color( 0.47, 0.53, 0.6, 1 )**
  300. - **lightsteelblue** = **Color( 0.69, 0.77, 0.87, 1 )**
  301. - **lightyellow** = **Color( 1, 1, 0.88, 1 )**
  302. - **lime** = **Color( 0, 1, 0, 1 )**
  303. - **limegreen** = **Color( 0.2, 0.8, 0.2, 1 )**
  304. - **linen** = **Color( 0.98, 0.94, 0.9, 1 )**
  305. - **magenta** = **Color( 1, 0, 1, 1 )**
  306. - **maroon** = **Color( 0.69, 0.19, 0.38, 1 )**
  307. - **mediumaquamarine** = **Color( 0.4, 0.8, 0.67, 1 )**
  308. - **mediumblue** = **Color( 0, 0, 0.8, 1 )**
  309. - **mediumorchid** = **Color( 0.73, 0.33, 0.83, 1 )**
  310. - **mediumpurple** = **Color( 0.58, 0.44, 0.86, 1 )**
  311. - **mediumseagreen** = **Color( 0.24, 0.7, 0.44, 1 )**
  312. - **mediumslateblue** = **Color( 0.48, 0.41, 0.93, 1 )**
  313. - **mediumspringgreen** = **Color( 0, 0.98, 0.6, 1 )**
  314. - **mediumturquoise** = **Color( 0.28, 0.82, 0.8, 1 )**
  315. - **mediumvioletred** = **Color( 0.78, 0.08, 0.52, 1 )**
  316. - **midnightblue** = **Color( 0.1, 0.1, 0.44, 1 )**
  317. - **mintcream** = **Color( 0.96, 1, 0.98, 1 )**
  318. - **mistyrose** = **Color( 1, 0.89, 0.88, 1 )**
  319. - **moccasin** = **Color( 1, 0.89, 0.71, 1 )**
  320. - **navajowhite** = **Color( 1, 0.87, 0.68, 1 )**
  321. - **navyblue** = **Color( 0, 0, 0.5, 1 )**
  322. - **oldlace** = **Color( 0.99, 0.96, 0.9, 1 )**
  323. - **olive** = **Color( 0.5, 0.5, 0, 1 )**
  324. - **olivedrab** = **Color( 0.42, 0.56, 0.14, 1 )**
  325. - **orange** = **Color( 1, 0.65, 0, 1 )**
  326. - **orangered** = **Color( 1, 0.27, 0, 1 )**
  327. - **orchid** = **Color( 0.85, 0.44, 0.84, 1 )**
  328. - **palegoldenrod** = **Color( 0.93, 0.91, 0.67, 1 )**
  329. - **palegreen** = **Color( 0.6, 0.98, 0.6, 1 )**
  330. - **paleturquoise** = **Color( 0.69, 0.93, 0.93, 1 )**
  331. - **palevioletred** = **Color( 0.86, 0.44, 0.58, 1 )**
  332. - **papayawhip** = **Color( 1, 0.94, 0.84, 1 )**
  333. - **peachpuff** = **Color( 1, 0.85, 0.73, 1 )**
  334. - **peru** = **Color( 0.8, 0.52, 0.25, 1 )**
  335. - **pink** = **Color( 1, 0.75, 0.8, 1 )**
  336. - **plum** = **Color( 0.87, 0.63, 0.87, 1 )**
  337. - **powderblue** = **Color( 0.69, 0.88, 0.9, 1 )**
  338. - **purple** = **Color( 0.63, 0.13, 0.94, 1 )**
  339. - **rebeccapurple** = **Color( 0.4, 0.2, 0.6, 1 )**
  340. - **red** = **Color( 1, 0, 0, 1 )**
  341. - **rosybrown** = **Color( 0.74, 0.56, 0.56, 1 )**
  342. - **royalblue** = **Color( 0.25, 0.41, 0.88, 1 )**
  343. - **saddlebrown** = **Color( 0.55, 0.27, 0.07, 1 )**
  344. - **salmon** = **Color( 0.98, 0.5, 0.45, 1 )**
  345. - **sandybrown** = **Color( 0.96, 0.64, 0.38, 1 )**
  346. - **seagreen** = **Color( 0.18, 0.55, 0.34, 1 )**
  347. - **seashell** = **Color( 1, 0.96, 0.93, 1 )**
  348. - **sienna** = **Color( 0.63, 0.32, 0.18, 1 )**
  349. - **silver** = **Color( 0.75, 0.75, 0.75, 1 )**
  350. - **skyblue** = **Color( 0.53, 0.81, 0.92, 1 )**
  351. - **slateblue** = **Color( 0.42, 0.35, 0.8, 1 )**
  352. - **slategray** = **Color( 0.44, 0.5, 0.56, 1 )**
  353. - **snow** = **Color( 1, 0.98, 0.98, 1 )**
  354. - **springgreen** = **Color( 0, 1, 0.5, 1 )**
  355. - **steelblue** = **Color( 0.27, 0.51, 0.71, 1 )**
  356. - **tan** = **Color( 0.82, 0.71, 0.55, 1 )**
  357. - **teal** = **Color( 0, 0.5, 0.5, 1 )**
  358. - **thistle** = **Color( 0.85, 0.75, 0.85, 1 )**
  359. - **tomato** = **Color( 1, 0.39, 0.28, 1 )**
  360. - **transparent** = **Color( 1, 1, 1, 0 )**
  361. - **turquoise** = **Color( 0.25, 0.88, 0.82, 1 )**
  362. - **violet** = **Color( 0.93, 0.51, 0.93, 1 )**
  363. - **webgray** = **Color( 0.5, 0.5, 0.5, 1 )**
  364. - **webgreen** = **Color( 0, 0.5, 0, 1 )**
  365. - **webmaroon** = **Color( 0.5, 0, 0, 1 )**
  366. - **webpurple** = **Color( 0.5, 0, 0.5, 1 )**
  367. - **wheat** = **Color( 0.96, 0.87, 0.7, 1 )**
  368. - **white** = **Color( 1, 1, 1, 1 )**
  369. - **whitesmoke** = **Color( 0.96, 0.96, 0.96, 1 )**
  370. - **yellow** = **Color( 1, 1, 0, 1 )**
  371. - **yellowgreen** = **Color( 0.6, 0.8, 0.2, 1 )**
  372. Description
  373. -----------
  374. 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.
  375. You can also create a color from standardized color names by using :ref:`@GDScript.ColorN<class_@GDScript_method_ColorN>`.
  376. Property Descriptions
  377. ---------------------
  378. .. _class_Color_property_a:
  379. - :ref:`float<class_float>` **a**
  380. +-----------+-----+
  381. | *Default* | 1.0 |
  382. +-----------+-----+
  383. Alpha value (range 0 to 1).
  384. .. _class_Color_property_a8:
  385. - :ref:`int<class_int>` **a8**
  386. +-----------+-----+
  387. | *Default* | 255 |
  388. +-----------+-----+
  389. Alpha value (range 0 to 255).
  390. .. _class_Color_property_b:
  391. - :ref:`float<class_float>` **b**
  392. +-----------+-----+
  393. | *Default* | 0.0 |
  394. +-----------+-----+
  395. Blue value (range 0 to 1).
  396. .. _class_Color_property_b8:
  397. - :ref:`int<class_int>` **b8**
  398. +-----------+---+
  399. | *Default* | 0 |
  400. +-----------+---+
  401. Blue value (range 0 to 255).
  402. .. _class_Color_property_g:
  403. - :ref:`float<class_float>` **g**
  404. +-----------+-----+
  405. | *Default* | 0.0 |
  406. +-----------+-----+
  407. Green value (range 0 to 1).
  408. .. _class_Color_property_g8:
  409. - :ref:`int<class_int>` **g8**
  410. +-----------+---+
  411. | *Default* | 0 |
  412. +-----------+---+
  413. Green value (range 0 to 255).
  414. .. _class_Color_property_h:
  415. - :ref:`float<class_float>` **h**
  416. +-----------+-----+
  417. | *Default* | 0.0 |
  418. +-----------+-----+
  419. HSV hue value (range 0 to 1).
  420. .. _class_Color_property_r:
  421. - :ref:`float<class_float>` **r**
  422. +-----------+-----+
  423. | *Default* | 0.0 |
  424. +-----------+-----+
  425. Red value (range 0 to 1).
  426. .. _class_Color_property_r8:
  427. - :ref:`int<class_int>` **r8**
  428. +-----------+---+
  429. | *Default* | 0 |
  430. +-----------+---+
  431. Red value (range 0 to 255).
  432. .. _class_Color_property_s:
  433. - :ref:`float<class_float>` **s**
  434. +-----------+-----+
  435. | *Default* | 0.0 |
  436. +-----------+-----+
  437. HSV saturation value (range 0 to 1).
  438. .. _class_Color_property_v:
  439. - :ref:`float<class_float>` **v**
  440. +-----------+-----+
  441. | *Default* | 0.0 |
  442. +-----------+-----+
  443. HSV value (range 0 to 1).
  444. Method Descriptions
  445. -------------------
  446. .. _class_Color_method_Color:
  447. - :ref:`Color<class_Color>` **Color** **(** :ref:`String<class_String>` from **)**
  448. Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also :ref:`@GDScript.ColorN<class_@GDScript_method_ColorN>`.
  449. ::
  450. # Each of the following creates the same color RGBA(178, 217, 10, 255)
  451. var c1 = Color("#ffb2d90a") # ARGB format with "#"
  452. var c2 = Color("ffb2d90a") # ARGB format
  453. var c3 = Color("#b2d90a") # RGB format with "#"
  454. var c4 = Color("b2d90a") # RGB format
  455. - :ref:`Color<class_Color>` **Color** **(** :ref:`int<class_int>` from **)**
  456. Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile).
  457. ::
  458. var c = Color(274) # Equivalent to RGBA(0, 0, 1, 18)
  459. - :ref:`Color<class_Color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)**
  460. Constructs a color from an RGB profile using values between 0 and 1. Alpha will always be 1.
  461. ::
  462. var c = Color(0.2, 1.0, 0.7) # Equivalent to RGBA(51, 255, 178, 255)
  463. - :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 **)**
  464. Constructs a color from an RGBA profile using values between 0 and 1.
  465. ::
  466. var c = Color(0.2, 1.0, 0.7, 0.8) # Equivalent to RGBA(51, 255, 178, 204)
  467. .. _class_Color_method_blend:
  468. - :ref:`Color<class_Color>` **blend** **(** :ref:`Color<class_Color>` over **)**
  469. 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.
  470. ::
  471. var bg = Color(0.0, 1.0, 0.0, 0.5) # Green with alpha of 50%
  472. var fg = Color(1.0, 0.0, 0.0, 0.5) # Red with alpha of 50%
  473. var blended_color = bg.blend(fg) # Brown with alpha of 75%
  474. .. _class_Color_method_contrasted:
  475. - :ref:`Color<class_Color>` **contrasted** **(** **)**
  476. Returns the most contrasting color.
  477. ::
  478. var c = Color(0.3, 0.4, 0.9)
  479. var contrasted_color = c.contrasted() # Equivalent to RGBA(204, 229, 102, 255)
  480. .. _class_Color_method_darkened:
  481. - :ref:`Color<class_Color>` **darkened** **(** :ref:`float<class_float>` amount **)**
  482. Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1).
  483. ::
  484. var green = Color(0.0, 1.0, 0.0)
  485. var darkgreen = green.darkened(0.2) # 20% darker than regular green
  486. .. _class_Color_method_from_hsv:
  487. - :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 **)**
  488. Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values between 0 and 1.
  489. ::
  490. 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)
  491. .. _class_Color_method_gray:
  492. - :ref:`float<class_float>` **gray** **(** **)**
  493. Returns the color's grayscale representation.
  494. The gray value is calculated as ``(r + g + b) / 3``.
  495. ::
  496. var c = Color(0.2, 0.45, 0.82)
  497. var gray = c.gray() # A value of 0.466667
  498. .. _class_Color_method_inverted:
  499. - :ref:`Color<class_Color>` **inverted** **(** **)**
  500. Returns the inverted color ``(1 - r, 1 - g, 1 - b, a)``.
  501. ::
  502. var c = Color(0.3, 0.4, 0.9)
  503. var inverted_color = c.inverted() # A color of an RGBA(178, 153, 26, 255)
  504. .. _class_Color_method_lightened:
  505. - :ref:`Color<class_Color>` **lightened** **(** :ref:`float<class_float>` amount **)**
  506. Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1).
  507. ::
  508. var green = Color(0.0, 1.0, 0.0)
  509. var lightgreen = green.lightened(0.2) # 20% lighter than regular green
  510. .. _class_Color_method_linear_interpolate:
  511. - :ref:`Color<class_Color>` **linear_interpolate** **(** :ref:`Color<class_Color>` b, :ref:`float<class_float>` t **)**
  512. Returns the linear interpolation with another color. The interpolation factor ``t`` is between 0 and 1.
  513. ::
  514. var c1 = Color(1.0, 0.0, 0.0)
  515. var c2 = Color(0.0, 1.0, 0.0)
  516. var li_c = c1.linear_interpolate(c2, 0.5) # A color of an RGBA(128, 128, 0, 255)
  517. .. _class_Color_method_to_abgr32:
  518. - :ref:`int<class_int>` **to_abgr32** **(** **)**
  519. 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.
  520. ::
  521. var c = Color(1, 0.5, 0.2)
  522. print(c.to_abgr32()) # Prints 4281565439
  523. .. _class_Color_method_to_abgr64:
  524. - :ref:`int<class_int>` **to_abgr64** **(** **)**
  525. 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.
  526. ::
  527. var c = Color(1, 0.5, 0.2)
  528. print(c.to_abgr64()) # Prints -225178692812801
  529. .. _class_Color_method_to_argb32:
  530. - :ref:`int<class_int>` **to_argb32** **(** **)**
  531. 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.
  532. ::
  533. var c = Color(1, 0.5, 0.2)
  534. print(c.to_argb32()) # Prints 4294934323
  535. .. _class_Color_method_to_argb64:
  536. - :ref:`int<class_int>` **to_argb64** **(** **)**
  537. 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.
  538. ::
  539. var c = Color(1, 0.5, 0.2)
  540. print(c.to_argb64()) # Prints -2147470541
  541. .. _class_Color_method_to_html:
  542. - :ref:`String<class_String>` **to_html** **(** :ref:`bool<class_bool>` with_alpha=True **)**
  543. Returns the color's HTML hexadecimal color string in ARGB format (ex: ``ff34f822``).
  544. Setting ``with_alpha`` to ``false`` excludes alpha from the hexadecimal string.
  545. ::
  546. var c = Color(1, 1, 1, 0.5)
  547. var s1 = c.to_html() # Returns "7fffffff"
  548. var s2 = c.to_html(false) # Returns "ffffff"
  549. .. _class_Color_method_to_rgba32:
  550. - :ref:`int<class_int>` **to_rgba32** **(** **)**
  551. 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.
  552. ::
  553. var c = Color(1, 0.5, 0.2)
  554. print(c.to_rgba32()) # Prints 4286526463
  555. .. _class_Color_method_to_rgba64:
  556. - :ref:`int<class_int>` **to_rgba64** **(** **)**
  557. 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.
  558. ::
  559. var c = Color(1, 0.5, 0.2)
  560. print(c.to_rgba64()) # Prints -140736629309441