12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007 |
- :github_url: hide
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the Color.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_Color:
- Color
- =====
- **Category:** Built-In Types
- Brief Description
- -----------------
- Color in RGBA format with some support for ARGB format.
- Properties
- ----------
- +---------------------------+------------------------------------+-----+
- | :ref:`float<class_float>` | :ref:`a<class_Color_property_a>` | 1.0 |
- +---------------------------+------------------------------------+-----+
- | :ref:`int<class_int>` | :ref:`a8<class_Color_property_a8>` | 255 |
- +---------------------------+------------------------------------+-----+
- | :ref:`float<class_float>` | :ref:`b<class_Color_property_b>` | 0.0 |
- +---------------------------+------------------------------------+-----+
- | :ref:`int<class_int>` | :ref:`b8<class_Color_property_b8>` | 0 |
- +---------------------------+------------------------------------+-----+
- | :ref:`float<class_float>` | :ref:`g<class_Color_property_g>` | 0.0 |
- +---------------------------+------------------------------------+-----+
- | :ref:`int<class_int>` | :ref:`g8<class_Color_property_g8>` | 0 |
- +---------------------------+------------------------------------+-----+
- | :ref:`float<class_float>` | :ref:`h<class_Color_property_h>` | 0.0 |
- +---------------------------+------------------------------------+-----+
- | :ref:`float<class_float>` | :ref:`r<class_Color_property_r>` | 0.0 |
- +---------------------------+------------------------------------+-----+
- | :ref:`int<class_int>` | :ref:`r8<class_Color_property_r8>` | 0 |
- +---------------------------+------------------------------------+-----+
- | :ref:`float<class_float>` | :ref:`s<class_Color_property_s>` | 0.0 |
- +---------------------------+------------------------------------+-----+
- | :ref:`float<class_float>` | :ref:`v<class_Color_property_v>` | 0.0 |
- +---------------------------+------------------------------------+-----+
- Methods
- -------
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`String<class_String>` from **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`Color<class_Color_method_Color>` **(** :ref:`int<class_int>` from **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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:`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 **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`blend<class_Color_method_blend>` **(** :ref:`Color<class_Color>` over **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`contrasted<class_Color_method_contrasted>` **(** **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`darkened<class_Color_method_darkened>` **(** :ref:`float<class_float>` amount **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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 **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`gray<class_Color_method_gray>` **(** **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`inverted<class_Color_method_inverted>` **(** **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`lightened<class_Color_method_lightened>` **(** :ref:`float<class_float>` amount **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`linear_interpolate<class_Color_method_linear_interpolate>` **(** :ref:`Color<class_Color>` b, :ref:`float<class_float>` t **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`to_abgr32<class_Color_method_to_abgr32>` **(** **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`to_abgr64<class_Color_method_to_abgr64>` **(** **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`to_argb32<class_Color_method_to_argb32>` **(** **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`to_argb64<class_Color_method_to_argb64>` **(** **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`to_html<class_Color_method_to_html>` **(** :ref:`bool<class_bool>` with_alpha=True **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`to_rgba32<class_Color_method_to_rgba32>` **(** **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`to_rgba64<class_Color_method_to_rgba64>` **(** **)** |
- +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Constants
- ---------
- .. _class_Color_constant_gray:
- .. _class_Color_constant_aliceblue:
- .. _class_Color_constant_antiquewhite:
- .. _class_Color_constant_aqua:
- .. _class_Color_constant_aquamarine:
- .. _class_Color_constant_azure:
- .. _class_Color_constant_beige:
- .. _class_Color_constant_bisque:
- .. _class_Color_constant_black:
- .. _class_Color_constant_blanchedalmond:
- .. _class_Color_constant_blue:
- .. _class_Color_constant_blueviolet:
- .. _class_Color_constant_brown:
- .. _class_Color_constant_burlywood:
- .. _class_Color_constant_cadetblue:
- .. _class_Color_constant_chartreuse:
- .. _class_Color_constant_chocolate:
- .. _class_Color_constant_coral:
- .. _class_Color_constant_cornflower:
- .. _class_Color_constant_cornsilk:
- .. _class_Color_constant_crimson:
- .. _class_Color_constant_cyan:
- .. _class_Color_constant_darkblue:
- .. _class_Color_constant_darkcyan:
- .. _class_Color_constant_darkgoldenrod:
- .. _class_Color_constant_darkgray:
- .. _class_Color_constant_darkgreen:
- .. _class_Color_constant_darkkhaki:
- .. _class_Color_constant_darkmagenta:
- .. _class_Color_constant_darkolivegreen:
- .. _class_Color_constant_darkorange:
- .. _class_Color_constant_darkorchid:
- .. _class_Color_constant_darkred:
- .. _class_Color_constant_darksalmon:
- .. _class_Color_constant_darkseagreen:
- .. _class_Color_constant_darkslateblue:
- .. _class_Color_constant_darkslategray:
- .. _class_Color_constant_darkturquoise:
- .. _class_Color_constant_darkviolet:
- .. _class_Color_constant_deeppink:
- .. _class_Color_constant_deepskyblue:
- .. _class_Color_constant_dimgray:
- .. _class_Color_constant_dodgerblue:
- .. _class_Color_constant_firebrick:
- .. _class_Color_constant_floralwhite:
- .. _class_Color_constant_forestgreen:
- .. _class_Color_constant_fuchsia:
- .. _class_Color_constant_gainsboro:
- .. _class_Color_constant_ghostwhite:
- .. _class_Color_constant_gold:
- .. _class_Color_constant_goldenrod:
- .. _class_Color_constant_green:
- .. _class_Color_constant_greenyellow:
- .. _class_Color_constant_honeydew:
- .. _class_Color_constant_hotpink:
- .. _class_Color_constant_indianred:
- .. _class_Color_constant_indigo:
- .. _class_Color_constant_ivory:
- .. _class_Color_constant_khaki:
- .. _class_Color_constant_lavender:
- .. _class_Color_constant_lavenderblush:
- .. _class_Color_constant_lawngreen:
- .. _class_Color_constant_lemonchiffon:
- .. _class_Color_constant_lightblue:
- .. _class_Color_constant_lightcoral:
- .. _class_Color_constant_lightcyan:
- .. _class_Color_constant_lightgoldenrod:
- .. _class_Color_constant_lightgray:
- .. _class_Color_constant_lightgreen:
- .. _class_Color_constant_lightpink:
- .. _class_Color_constant_lightsalmon:
- .. _class_Color_constant_lightseagreen:
- .. _class_Color_constant_lightskyblue:
- .. _class_Color_constant_lightslategray:
- .. _class_Color_constant_lightsteelblue:
- .. _class_Color_constant_lightyellow:
- .. _class_Color_constant_lime:
- .. _class_Color_constant_limegreen:
- .. _class_Color_constant_linen:
- .. _class_Color_constant_magenta:
- .. _class_Color_constant_maroon:
- .. _class_Color_constant_mediumaquamarine:
- .. _class_Color_constant_mediumblue:
- .. _class_Color_constant_mediumorchid:
- .. _class_Color_constant_mediumpurple:
- .. _class_Color_constant_mediumseagreen:
- .. _class_Color_constant_mediumslateblue:
- .. _class_Color_constant_mediumspringgreen:
- .. _class_Color_constant_mediumturquoise:
- .. _class_Color_constant_mediumvioletred:
- .. _class_Color_constant_midnightblue:
- .. _class_Color_constant_mintcream:
- .. _class_Color_constant_mistyrose:
- .. _class_Color_constant_moccasin:
- .. _class_Color_constant_navajowhite:
- .. _class_Color_constant_navyblue:
- .. _class_Color_constant_oldlace:
- .. _class_Color_constant_olive:
- .. _class_Color_constant_olivedrab:
- .. _class_Color_constant_orange:
- .. _class_Color_constant_orangered:
- .. _class_Color_constant_orchid:
- .. _class_Color_constant_palegoldenrod:
- .. _class_Color_constant_palegreen:
- .. _class_Color_constant_paleturquoise:
- .. _class_Color_constant_palevioletred:
- .. _class_Color_constant_papayawhip:
- .. _class_Color_constant_peachpuff:
- .. _class_Color_constant_peru:
- .. _class_Color_constant_pink:
- .. _class_Color_constant_plum:
- .. _class_Color_constant_powderblue:
- .. _class_Color_constant_purple:
- .. _class_Color_constant_rebeccapurple:
- .. _class_Color_constant_red:
- .. _class_Color_constant_rosybrown:
- .. _class_Color_constant_royalblue:
- .. _class_Color_constant_saddlebrown:
- .. _class_Color_constant_salmon:
- .. _class_Color_constant_sandybrown:
- .. _class_Color_constant_seagreen:
- .. _class_Color_constant_seashell:
- .. _class_Color_constant_sienna:
- .. _class_Color_constant_silver:
- .. _class_Color_constant_skyblue:
- .. _class_Color_constant_slateblue:
- .. _class_Color_constant_slategray:
- .. _class_Color_constant_snow:
- .. _class_Color_constant_springgreen:
- .. _class_Color_constant_steelblue:
- .. _class_Color_constant_tan:
- .. _class_Color_constant_teal:
- .. _class_Color_constant_thistle:
- .. _class_Color_constant_tomato:
- .. _class_Color_constant_transparent:
- .. _class_Color_constant_turquoise:
- .. _class_Color_constant_violet:
- .. _class_Color_constant_webgray:
- .. _class_Color_constant_webgreen:
- .. _class_Color_constant_webmaroon:
- .. _class_Color_constant_webpurple:
- .. _class_Color_constant_wheat:
- .. _class_Color_constant_white:
- .. _class_Color_constant_whitesmoke:
- .. _class_Color_constant_yellow:
- .. _class_Color_constant_yellowgreen:
- - **gray** = **Color( 0.75, 0.75, 0.75, 1 )**
- - **aliceblue** = **Color( 0.94, 0.97, 1, 1 )**
- - **antiquewhite** = **Color( 0.98, 0.92, 0.84, 1 )**
- - **aqua** = **Color( 0, 1, 1, 1 )**
- - **aquamarine** = **Color( 0.5, 1, 0.83, 1 )**
- - **azure** = **Color( 0.94, 1, 1, 1 )**
- - **beige** = **Color( 0.96, 0.96, 0.86, 1 )**
- - **bisque** = **Color( 1, 0.89, 0.77, 1 )**
- - **black** = **Color( 0, 0, 0, 1 )**
- - **blanchedalmond** = **Color( 1, 0.92, 0.8, 1 )**
- - **blue** = **Color( 0, 0, 1, 1 )**
- - **blueviolet** = **Color( 0.54, 0.17, 0.89, 1 )**
- - **brown** = **Color( 0.65, 0.16, 0.16, 1 )**
- - **burlywood** = **Color( 0.87, 0.72, 0.53, 1 )**
- - **cadetblue** = **Color( 0.37, 0.62, 0.63, 1 )**
- - **chartreuse** = **Color( 0.5, 1, 0, 1 )**
- - **chocolate** = **Color( 0.82, 0.41, 0.12, 1 )**
- - **coral** = **Color( 1, 0.5, 0.31, 1 )**
- - **cornflower** = **Color( 0.39, 0.58, 0.93, 1 )**
- - **cornsilk** = **Color( 1, 0.97, 0.86, 1 )**
- - **crimson** = **Color( 0.86, 0.08, 0.24, 1 )**
- - **cyan** = **Color( 0, 1, 1, 1 )**
- - **darkblue** = **Color( 0, 0, 0.55, 1 )**
- - **darkcyan** = **Color( 0, 0.55, 0.55, 1 )**
- - **darkgoldenrod** = **Color( 0.72, 0.53, 0.04, 1 )**
- - **darkgray** = **Color( 0.66, 0.66, 0.66, 1 )**
- - **darkgreen** = **Color( 0, 0.39, 0, 1 )**
- - **darkkhaki** = **Color( 0.74, 0.72, 0.42, 1 )**
- - **darkmagenta** = **Color( 0.55, 0, 0.55, 1 )**
- - **darkolivegreen** = **Color( 0.33, 0.42, 0.18, 1 )**
- - **darkorange** = **Color( 1, 0.55, 0, 1 )**
- - **darkorchid** = **Color( 0.6, 0.2, 0.8, 1 )**
- - **darkred** = **Color( 0.55, 0, 0, 1 )**
- - **darksalmon** = **Color( 0.91, 0.59, 0.48, 1 )**
- - **darkseagreen** = **Color( 0.56, 0.74, 0.56, 1 )**
- - **darkslateblue** = **Color( 0.28, 0.24, 0.55, 1 )**
- - **darkslategray** = **Color( 0.18, 0.31, 0.31, 1 )**
- - **darkturquoise** = **Color( 0, 0.81, 0.82, 1 )**
- - **darkviolet** = **Color( 0.58, 0, 0.83, 1 )**
- - **deeppink** = **Color( 1, 0.08, 0.58, 1 )**
- - **deepskyblue** = **Color( 0, 0.75, 1, 1 )**
- - **dimgray** = **Color( 0.41, 0.41, 0.41, 1 )**
- - **dodgerblue** = **Color( 0.12, 0.56, 1, 1 )**
- - **firebrick** = **Color( 0.7, 0.13, 0.13, 1 )**
- - **floralwhite** = **Color( 1, 0.98, 0.94, 1 )**
- - **forestgreen** = **Color( 0.13, 0.55, 0.13, 1 )**
- - **fuchsia** = **Color( 1, 0, 1, 1 )**
- - **gainsboro** = **Color( 0.86, 0.86, 0.86, 1 )**
- - **ghostwhite** = **Color( 0.97, 0.97, 1, 1 )**
- - **gold** = **Color( 1, 0.84, 0, 1 )**
- - **goldenrod** = **Color( 0.85, 0.65, 0.13, 1 )**
- - **green** = **Color( 0, 1, 0, 1 )**
- - **greenyellow** = **Color( 0.68, 1, 0.18, 1 )**
- - **honeydew** = **Color( 0.94, 1, 0.94, 1 )**
- - **hotpink** = **Color( 1, 0.41, 0.71, 1 )**
- - **indianred** = **Color( 0.8, 0.36, 0.36, 1 )**
- - **indigo** = **Color( 0.29, 0, 0.51, 1 )**
- - **ivory** = **Color( 1, 1, 0.94, 1 )**
- - **khaki** = **Color( 0.94, 0.9, 0.55, 1 )**
- - **lavender** = **Color( 0.9, 0.9, 0.98, 1 )**
- - **lavenderblush** = **Color( 1, 0.94, 0.96, 1 )**
- - **lawngreen** = **Color( 0.49, 0.99, 0, 1 )**
- - **lemonchiffon** = **Color( 1, 0.98, 0.8, 1 )**
- - **lightblue** = **Color( 0.68, 0.85, 0.9, 1 )**
- - **lightcoral** = **Color( 0.94, 0.5, 0.5, 1 )**
- - **lightcyan** = **Color( 0.88, 1, 1, 1 )**
- - **lightgoldenrod** = **Color( 0.98, 0.98, 0.82, 1 )**
- - **lightgray** = **Color( 0.83, 0.83, 0.83, 1 )**
- - **lightgreen** = **Color( 0.56, 0.93, 0.56, 1 )**
- - **lightpink** = **Color( 1, 0.71, 0.76, 1 )**
- - **lightsalmon** = **Color( 1, 0.63, 0.48, 1 )**
- - **lightseagreen** = **Color( 0.13, 0.7, 0.67, 1 )**
- - **lightskyblue** = **Color( 0.53, 0.81, 0.98, 1 )**
- - **lightslategray** = **Color( 0.47, 0.53, 0.6, 1 )**
- - **lightsteelblue** = **Color( 0.69, 0.77, 0.87, 1 )**
- - **lightyellow** = **Color( 1, 1, 0.88, 1 )**
- - **lime** = **Color( 0, 1, 0, 1 )**
- - **limegreen** = **Color( 0.2, 0.8, 0.2, 1 )**
- - **linen** = **Color( 0.98, 0.94, 0.9, 1 )**
- - **magenta** = **Color( 1, 0, 1, 1 )**
- - **maroon** = **Color( 0.69, 0.19, 0.38, 1 )**
- - **mediumaquamarine** = **Color( 0.4, 0.8, 0.67, 1 )**
- - **mediumblue** = **Color( 0, 0, 0.8, 1 )**
- - **mediumorchid** = **Color( 0.73, 0.33, 0.83, 1 )**
- - **mediumpurple** = **Color( 0.58, 0.44, 0.86, 1 )**
- - **mediumseagreen** = **Color( 0.24, 0.7, 0.44, 1 )**
- - **mediumslateblue** = **Color( 0.48, 0.41, 0.93, 1 )**
- - **mediumspringgreen** = **Color( 0, 0.98, 0.6, 1 )**
- - **mediumturquoise** = **Color( 0.28, 0.82, 0.8, 1 )**
- - **mediumvioletred** = **Color( 0.78, 0.08, 0.52, 1 )**
- - **midnightblue** = **Color( 0.1, 0.1, 0.44, 1 )**
- - **mintcream** = **Color( 0.96, 1, 0.98, 1 )**
- - **mistyrose** = **Color( 1, 0.89, 0.88, 1 )**
- - **moccasin** = **Color( 1, 0.89, 0.71, 1 )**
- - **navajowhite** = **Color( 1, 0.87, 0.68, 1 )**
- - **navyblue** = **Color( 0, 0, 0.5, 1 )**
- - **oldlace** = **Color( 0.99, 0.96, 0.9, 1 )**
- - **olive** = **Color( 0.5, 0.5, 0, 1 )**
- - **olivedrab** = **Color( 0.42, 0.56, 0.14, 1 )**
- - **orange** = **Color( 1, 0.65, 0, 1 )**
- - **orangered** = **Color( 1, 0.27, 0, 1 )**
- - **orchid** = **Color( 0.85, 0.44, 0.84, 1 )**
- - **palegoldenrod** = **Color( 0.93, 0.91, 0.67, 1 )**
- - **palegreen** = **Color( 0.6, 0.98, 0.6, 1 )**
- - **paleturquoise** = **Color( 0.69, 0.93, 0.93, 1 )**
- - **palevioletred** = **Color( 0.86, 0.44, 0.58, 1 )**
- - **papayawhip** = **Color( 1, 0.94, 0.84, 1 )**
- - **peachpuff** = **Color( 1, 0.85, 0.73, 1 )**
- - **peru** = **Color( 0.8, 0.52, 0.25, 1 )**
- - **pink** = **Color( 1, 0.75, 0.8, 1 )**
- - **plum** = **Color( 0.87, 0.63, 0.87, 1 )**
- - **powderblue** = **Color( 0.69, 0.88, 0.9, 1 )**
- - **purple** = **Color( 0.63, 0.13, 0.94, 1 )**
- - **rebeccapurple** = **Color( 0.4, 0.2, 0.6, 1 )**
- - **red** = **Color( 1, 0, 0, 1 )**
- - **rosybrown** = **Color( 0.74, 0.56, 0.56, 1 )**
- - **royalblue** = **Color( 0.25, 0.41, 0.88, 1 )**
- - **saddlebrown** = **Color( 0.55, 0.27, 0.07, 1 )**
- - **salmon** = **Color( 0.98, 0.5, 0.45, 1 )**
- - **sandybrown** = **Color( 0.96, 0.64, 0.38, 1 )**
- - **seagreen** = **Color( 0.18, 0.55, 0.34, 1 )**
- - **seashell** = **Color( 1, 0.96, 0.93, 1 )**
- - **sienna** = **Color( 0.63, 0.32, 0.18, 1 )**
- - **silver** = **Color( 0.75, 0.75, 0.75, 1 )**
- - **skyblue** = **Color( 0.53, 0.81, 0.92, 1 )**
- - **slateblue** = **Color( 0.42, 0.35, 0.8, 1 )**
- - **slategray** = **Color( 0.44, 0.5, 0.56, 1 )**
- - **snow** = **Color( 1, 0.98, 0.98, 1 )**
- - **springgreen** = **Color( 0, 1, 0.5, 1 )**
- - **steelblue** = **Color( 0.27, 0.51, 0.71, 1 )**
- - **tan** = **Color( 0.82, 0.71, 0.55, 1 )**
- - **teal** = **Color( 0, 0.5, 0.5, 1 )**
- - **thistle** = **Color( 0.85, 0.75, 0.85, 1 )**
- - **tomato** = **Color( 1, 0.39, 0.28, 1 )**
- - **transparent** = **Color( 1, 1, 1, 0 )**
- - **turquoise** = **Color( 0.25, 0.88, 0.82, 1 )**
- - **violet** = **Color( 0.93, 0.51, 0.93, 1 )**
- - **webgray** = **Color( 0.5, 0.5, 0.5, 1 )**
- - **webgreen** = **Color( 0, 0.5, 0, 1 )**
- - **webmaroon** = **Color( 0.5, 0, 0, 1 )**
- - **webpurple** = **Color( 0.5, 0, 0.5, 1 )**
- - **wheat** = **Color( 0.96, 0.87, 0.7, 1 )**
- - **white** = **Color( 1, 1, 1, 1 )**
- - **whitesmoke** = **Color( 0.96, 0.96, 0.96, 1 )**
- - **yellow** = **Color( 1, 1, 0, 1 )**
- - **yellowgreen** = **Color( 0.6, 0.8, 0.2, 1 )**
- Description
- -----------
- 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.
- You can also create a color from standardized color names by using :ref:`@GDScript.ColorN<class_@GDScript_method_ColorN>`.
- Property Descriptions
- ---------------------
- .. _class_Color_property_a:
- - :ref:`float<class_float>` **a**
- +-----------+-----+
- | *Default* | 1.0 |
- +-----------+-----+
- Alpha value (range 0 to 1).
- .. _class_Color_property_a8:
- - :ref:`int<class_int>` **a8**
- +-----------+-----+
- | *Default* | 255 |
- +-----------+-----+
- Alpha value (range 0 to 255).
- .. _class_Color_property_b:
- - :ref:`float<class_float>` **b**
- +-----------+-----+
- | *Default* | 0.0 |
- +-----------+-----+
- Blue value (range 0 to 1).
- .. _class_Color_property_b8:
- - :ref:`int<class_int>` **b8**
- +-----------+---+
- | *Default* | 0 |
- +-----------+---+
- Blue value (range 0 to 255).
- .. _class_Color_property_g:
- - :ref:`float<class_float>` **g**
- +-----------+-----+
- | *Default* | 0.0 |
- +-----------+-----+
- Green value (range 0 to 1).
- .. _class_Color_property_g8:
- - :ref:`int<class_int>` **g8**
- +-----------+---+
- | *Default* | 0 |
- +-----------+---+
- Green value (range 0 to 255).
- .. _class_Color_property_h:
- - :ref:`float<class_float>` **h**
- +-----------+-----+
- | *Default* | 0.0 |
- +-----------+-----+
- HSV hue value (range 0 to 1).
- .. _class_Color_property_r:
- - :ref:`float<class_float>` **r**
- +-----------+-----+
- | *Default* | 0.0 |
- +-----------+-----+
- Red value (range 0 to 1).
- .. _class_Color_property_r8:
- - :ref:`int<class_int>` **r8**
- +-----------+---+
- | *Default* | 0 |
- +-----------+---+
- Red value (range 0 to 255).
- .. _class_Color_property_s:
- - :ref:`float<class_float>` **s**
- +-----------+-----+
- | *Default* | 0.0 |
- +-----------+-----+
- HSV saturation value (range 0 to 1).
- .. _class_Color_property_v:
- - :ref:`float<class_float>` **v**
- +-----------+-----+
- | *Default* | 0.0 |
- +-----------+-----+
- HSV value (range 0 to 1).
- Method Descriptions
- -------------------
- .. _class_Color_method_Color:
- - :ref:`Color<class_Color>` **Color** **(** :ref:`String<class_String>` from **)**
- Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also :ref:`@GDScript.ColorN<class_@GDScript_method_ColorN>`.
- ::
- # Each of the following creates the same color RGBA(178, 217, 10, 255)
- var c1 = Color("#ffb2d90a") # ARGB format with "#"
- var c2 = Color("ffb2d90a") # ARGB format
- var c3 = Color("#b2d90a") # RGB format with "#"
- var c4 = Color("b2d90a") # RGB format
- - :ref:`Color<class_Color>` **Color** **(** :ref:`int<class_int>` from **)**
- Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile).
- ::
- var c = Color(274) # Equivalent to RGBA(0, 0, 1, 18)
- - :ref:`Color<class_Color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)**
- Constructs a color from an RGB profile using values between 0 and 1. Alpha will always be 1.
- ::
- var c = Color(0.2, 1.0, 0.7) # Equivalent to RGBA(51, 255, 178, 255)
- - :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 **)**
- Constructs a color from an RGBA profile using values between 0 and 1.
- ::
- var c = Color(0.2, 1.0, 0.7, 0.8) # Equivalent to RGBA(51, 255, 178, 204)
- .. _class_Color_method_blend:
- - :ref:`Color<class_Color>` **blend** **(** :ref:`Color<class_Color>` over **)**
- 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.
- ::
- var bg = Color(0.0, 1.0, 0.0, 0.5) # Green with alpha of 50%
- var fg = Color(1.0, 0.0, 0.0, 0.5) # Red with alpha of 50%
- var blended_color = bg.blend(fg) # Brown with alpha of 75%
- .. _class_Color_method_contrasted:
- - :ref:`Color<class_Color>` **contrasted** **(** **)**
- Returns the most contrasting color.
- ::
- var c = Color(0.3, 0.4, 0.9)
- var contrasted_color = c.contrasted() # Equivalent to RGBA(204, 229, 102, 255)
- .. _class_Color_method_darkened:
- - :ref:`Color<class_Color>` **darkened** **(** :ref:`float<class_float>` amount **)**
- Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1).
- ::
- var green = Color(0.0, 1.0, 0.0)
- var darkgreen = green.darkened(0.2) # 20% darker than regular green
- .. _class_Color_method_from_hsv:
- - :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 **)**
- Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values between 0 and 1.
- ::
- 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)
- .. _class_Color_method_gray:
- - :ref:`float<class_float>` **gray** **(** **)**
- Returns the color's grayscale representation.
- The gray value is calculated as ``(r + g + b) / 3``.
- ::
- var c = Color(0.2, 0.45, 0.82)
- var gray = c.gray() # A value of 0.466667
- .. _class_Color_method_inverted:
- - :ref:`Color<class_Color>` **inverted** **(** **)**
- Returns the inverted color ``(1 - r, 1 - g, 1 - b, a)``.
- ::
- var c = Color(0.3, 0.4, 0.9)
- var inverted_color = c.inverted() # A color of an RGBA(178, 153, 26, 255)
- .. _class_Color_method_lightened:
- - :ref:`Color<class_Color>` **lightened** **(** :ref:`float<class_float>` amount **)**
- Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1).
- ::
- var green = Color(0.0, 1.0, 0.0)
- var lightgreen = green.lightened(0.2) # 20% lighter than regular green
- .. _class_Color_method_linear_interpolate:
- - :ref:`Color<class_Color>` **linear_interpolate** **(** :ref:`Color<class_Color>` b, :ref:`float<class_float>` t **)**
- Returns the linear interpolation with another color. The interpolation factor ``t`` is between 0 and 1.
- ::
- var c1 = Color(1.0, 0.0, 0.0)
- var c2 = Color(0.0, 1.0, 0.0)
- var li_c = c1.linear_interpolate(c2, 0.5) # A color of an RGBA(128, 128, 0, 255)
- .. _class_Color_method_to_abgr32:
- - :ref:`int<class_int>` **to_abgr32** **(** **)**
- 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.
- ::
- var c = Color(1, 0.5, 0.2)
- print(c.to_abgr32()) # Prints 4281565439
- .. _class_Color_method_to_abgr64:
- - :ref:`int<class_int>` **to_abgr64** **(** **)**
- 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.
- ::
- var c = Color(1, 0.5, 0.2)
- print(c.to_abgr64()) # Prints -225178692812801
- .. _class_Color_method_to_argb32:
- - :ref:`int<class_int>` **to_argb32** **(** **)**
- 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.
- ::
- var c = Color(1, 0.5, 0.2)
- print(c.to_argb32()) # Prints 4294934323
- .. _class_Color_method_to_argb64:
- - :ref:`int<class_int>` **to_argb64** **(** **)**
- 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.
- ::
- var c = Color(1, 0.5, 0.2)
- print(c.to_argb64()) # Prints -2147470541
- .. _class_Color_method_to_html:
- - :ref:`String<class_String>` **to_html** **(** :ref:`bool<class_bool>` with_alpha=True **)**
- Returns the color's HTML hexadecimal color string in ARGB format (ex: ``ff34f822``).
- Setting ``with_alpha`` to ``false`` excludes alpha from the hexadecimal string.
- ::
- var c = Color(1, 1, 1, 0.5)
- var s1 = c.to_html() # Returns "7fffffff"
- var s2 = c.to_html(false) # Returns "ffffff"
- .. _class_Color_method_to_rgba32:
- - :ref:`int<class_int>` **to_rgba32** **(** **)**
- 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.
- ::
- var c = Color(1, 0.5, 0.2)
- print(c.to_rgba32()) # Prints 4286526463
- .. _class_Color_method_to_rgba64:
- - :ref:`int<class_int>` **to_rgba64** **(** **)**
- 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.
- ::
- var c = Color(1, 0.5, 0.2)
- print(c.to_rgba64()) # Prints -140736629309441
|