mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-27 11:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
91b60a74df
godot/doc/classes/Color.xml
Rémi Verschelde 1f76229378 doc: Sync classref with current source
2019-11-08 08:33:48 +01:00

603 lines
22 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Color" category="Built-In Types" version="3.2">
<brief_description>
Color in RGBA format with some support for ARGB format.
</brief_description>
<description>
A color is represented by red, green, and blue [code](r, g, b)[/code] components. Additionally, [code]a[/code] represents the alpha component, often used for transparency. Values are in floating-point and usually range from 0 to 1. Some properties (such as [member CanvasItem.modulate]) may accept values greater than 1.
You can also create a color from standardized color names by using [method @GDScript.ColorN].
</description>
<tutorials>
</tutorials>
<methods>
<method name="Color">
<return type="Color">
</return>
<argument index="0" name="from" type="String">
</argument>
<description>
Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also [method @GDScript.ColorN].
[codeblock]
# 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
[/codeblock]
</description>
</method>
<method name="Color">
<return type="Color">
</return>
<argument index="0" name="from" type="int">
</argument>
<description>
Constructs a color from a 32-bit integer (each byte represents a component of the RGBA profile).
[codeblock]
var c = Color(274) # Equivalent to RGBA(0, 0, 1, 18)
[/codeblock]
</description>
</method>
<method name="Color">
<return type="Color">
</return>
<argument index="0" name="r" type="float">
</argument>
<argument index="1" name="g" type="float">
</argument>
<argument index="2" name="b" type="float">
</argument>
<description>
Constructs a color from an RGB profile using values between 0 and 1. Alpha will always be 1.
[codeblock]
var c = Color(0.2, 1.0, 0.7) # Equivalent to RGBA(51, 255, 178, 255)
[/codeblock]
</description>
</method>
<method name="Color">
<return type="Color">
</return>
<argument index="0" name="r" type="float">
</argument>
<argument index="1" name="g" type="float">
</argument>
<argument index="2" name="b" type="float">
</argument>
<argument index="3" name="a" type="float">
</argument>
<description>
Constructs a color from an RGBA profile using values between 0 and 1.
[codeblock]
var c = Color(0.2, 1.0, 0.7, 0.8) # Equivalent to RGBA(51, 255, 178, 204)
[/codeblock]
</description>
</method>
<method name="blend">
<return type="Color">
</return>
<argument index="0" name="over" type="Color">
</argument>
<description>
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.
[codeblock]
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%
[/codeblock]
</description>
</method>
<method name="contrasted">
<return type="Color">
</return>
<description>
Returns the most contrasting color.
[codeblock]
var c = Color(0.3, 0.4, 0.9)
var contrasted_color = c.contrasted() # Equivalent to RGBA(204, 229, 102, 255)
[/codeblock]
</description>
</method>
<method name="darkened">
<return type="Color">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1).
[codeblock]
var green = Color(0.0, 1.0, 0.0)
var darkgreen = green.darkened(0.2) # 20% darker than regular green
[/codeblock]
</description>
</method>
<method name="from_hsv">
<return type="Color">
</return>
<argument index="0" name="h" type="float">
</argument>
<argument index="1" name="s" type="float">
</argument>
<argument index="2" name="v" type="float">
</argument>
<argument index="3" name="a" type="float" default="1">
</argument>
<description>
Constructs a color from an HSV profile. [code]h[/code], [code]s[/code], and [code]v[/code] are values between 0 and 1.
[codeblock]
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)
[/codeblock]
</description>
</method>
<method name="gray">
<return type="float">
</return>
<description>
Returns the color's grayscale representation.
The gray value is calculated as [code](r + g + b) / 3[/code].
[codeblock]
var c = Color(0.2, 0.45, 0.82)
var gray = c.gray() # A value of 0.466667
[/codeblock]
</description>
</method>
<method name="inverted">
<return type="Color">
</return>
<description>
Returns the inverted color [code](1 - r, 1 - g, 1 - b, a)[/code].
[codeblock]
var c = Color(0.3, 0.4, 0.9)
var inverted_color = c.inverted() # A color of an RGBA(178, 153, 26, 255)
[/codeblock]
</description>
</method>
<method name="is_equal_approx">
<return type="bool">
</return>
<argument index="0" name="color" type="Color">
</argument>
<description>
</description>
</method>
<method name="lightened">
<return type="Color">
</return>
<argument index="0" name="amount" type="float">
</argument>
<description>
Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1).
[codeblock]
var green = Color(0.0, 1.0, 0.0)
var lightgreen = green.lightened(0.2) # 20% lighter than regular green
[/codeblock]
</description>
</method>
<method name="linear_interpolate">
<return type="Color">
</return>
<argument index="0" name="b" type="Color">
</argument>
<argument index="1" name="t" type="float">
</argument>
<description>
Returns the linear interpolation with another color. The interpolation factor [code]t[/code] is between 0 and 1.
[codeblock]
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)
[/codeblock]
</description>
</method>
<method name="to_abgr32">
<return type="int">
</return>
<description>
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.
[codeblock]
var c = Color(1, 0.5, 0.2)
print(c.to_abgr32()) # Prints 4281565439
[/codeblock]
</description>
</method>
<method name="to_abgr64">
<return type="int">
</return>
<description>
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.
[codeblock]
var c = Color(1, 0.5, 0.2)
print(c.to_abgr64()) # Prints -225178692812801
[/codeblock]
</description>
</method>
<method name="to_argb32">
<return type="int">
</return>
<description>
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.
[codeblock]
var c = Color(1, 0.5, 0.2)
print(c.to_argb32()) # Prints 4294934323
[/codeblock]
</description>
</method>
<method name="to_argb64">
<return type="int">
</return>
<description>
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.
[codeblock]
var c = Color(1, 0.5, 0.2)
print(c.to_argb64()) # Prints -2147470541
[/codeblock]
</description>
</method>
<method name="to_html">
<return type="String">
</return>
<argument index="0" name="with_alpha" type="bool" default="True">
</argument>
<description>
Returns the color's HTML hexadecimal color string in ARGB format (ex: [code]ff34f822[/code]).
Setting [code]with_alpha[/code] to [code]false[/code] excludes alpha from the hexadecimal string.
[codeblock]
var c = Color(1, 1, 1, 0.5)
var s1 = c.to_html() # Returns "7fffffff"
var s2 = c.to_html(false) # Returns "ffffff"
[/codeblock]
</description>
</method>
<method name="to_rgba32">
<return type="int">
</return>
<description>
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.
[codeblock]
var c = Color(1, 0.5, 0.2)
print(c.to_rgba32()) # Prints 4286526463
[/codeblock]
</description>
</method>
<method name="to_rgba64">
<return type="int">
</return>
<description>
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.
[codeblock]
var c = Color(1, 0.5, 0.2)
print(c.to_rgba64()) # Prints -140736629309441
[/codeblock]
</description>
</method>
</methods>
<members>
<member name="a" type="float" setter="" getter="" default="1.0">
Alpha value (range 0 to 1).
</member>
<member name="a8" type="int" setter="" getter="" default="255">
Alpha value (range 0 to 255).
</member>
<member name="b" type="float" setter="" getter="" default="0.0">
Blue value (range 0 to 1).
</member>
<member name="b8" type="int" setter="" getter="" default="0">
Blue value (range 0 to 255).
</member>
<member name="g" type="float" setter="" getter="" default="0.0">
Green value (range 0 to 1).
</member>
<member name="g8" type="int" setter="" getter="" default="0">
Green value (range 0 to 255).
</member>
<member name="h" type="float" setter="" getter="" default="0.0">
HSV hue value (range 0 to 1).
</member>
<member name="r" type="float" setter="" getter="" default="0.0">
Red value (range 0 to 1).
</member>
<member name="r8" type="int" setter="" getter="" default="0">
Red value (range 0 to 255).
</member>
<member name="s" type="float" setter="" getter="" default="0.0">
HSV saturation value (range 0 to 1).
</member>
<member name="v" type="float" setter="" getter="" default="0.0">
HSV value (range 0 to 1).
</member>
</members>
<constants>
<constant name="gray" value="Color( 0.75, 0.75, 0.75, 1 )">
</constant>
<constant name="aliceblue" value="Color( 0.94, 0.97, 1, 1 )">
</constant>
<constant name="antiquewhite" value="Color( 0.98, 0.92, 0.84, 1 )">
</constant>
<constant name="aqua" value="Color( 0, 1, 1, 1 )">
</constant>
<constant name="aquamarine" value="Color( 0.5, 1, 0.83, 1 )">
</constant>
<constant name="azure" value="Color( 0.94, 1, 1, 1 )">
</constant>
<constant name="beige" value="Color( 0.96, 0.96, 0.86, 1 )">
</constant>
<constant name="bisque" value="Color( 1, 0.89, 0.77, 1 )">
</constant>
<constant name="black" value="Color( 0, 0, 0, 1 )">
</constant>
<constant name="blanchedalmond" value="Color( 1, 0.92, 0.8, 1 )">
</constant>
<constant name="blue" value="Color( 0, 0, 1, 1 )">
</constant>
<constant name="blueviolet" value="Color( 0.54, 0.17, 0.89, 1 )">
</constant>
<constant name="brown" value="Color( 0.65, 0.16, 0.16, 1 )">
</constant>
<constant name="burlywood" value="Color( 0.87, 0.72, 0.53, 1 )">
</constant>
<constant name="cadetblue" value="Color( 0.37, 0.62, 0.63, 1 )">
</constant>
<constant name="chartreuse" value="Color( 0.5, 1, 0, 1 )">
</constant>
<constant name="chocolate" value="Color( 0.82, 0.41, 0.12, 1 )">
</constant>
<constant name="coral" value="Color( 1, 0.5, 0.31, 1 )">
</constant>
<constant name="cornflower" value="Color( 0.39, 0.58, 0.93, 1 )">
</constant>
<constant name="cornsilk" value="Color( 1, 0.97, 0.86, 1 )">
</constant>
<constant name="crimson" value="Color( 0.86, 0.08, 0.24, 1 )">
</constant>
<constant name="cyan" value="Color( 0, 1, 1, 1 )">
</constant>
<constant name="darkblue" value="Color( 0, 0, 0.55, 1 )">
</constant>
<constant name="darkcyan" value="Color( 0, 0.55, 0.55, 1 )">
</constant>
<constant name="darkgoldenrod" value="Color( 0.72, 0.53, 0.04, 1 )">
</constant>
<constant name="darkgray" value="Color( 0.66, 0.66, 0.66, 1 )">
</constant>
<constant name="darkgreen" value="Color( 0, 0.39, 0, 1 )">
</constant>
<constant name="darkkhaki" value="Color( 0.74, 0.72, 0.42, 1 )">
</constant>
<constant name="darkmagenta" value="Color( 0.55, 0, 0.55, 1 )">
</constant>
<constant name="darkolivegreen" value="Color( 0.33, 0.42, 0.18, 1 )">
</constant>
<constant name="darkorange" value="Color( 1, 0.55, 0, 1 )">
</constant>
<constant name="darkorchid" value="Color( 0.6, 0.2, 0.8, 1 )">
</constant>
<constant name="darkred" value="Color( 0.55, 0, 0, 1 )">
</constant>
<constant name="darksalmon" value="Color( 0.91, 0.59, 0.48, 1 )">
</constant>
<constant name="darkseagreen" value="Color( 0.56, 0.74, 0.56, 1 )">
</constant>
<constant name="darkslateblue" value="Color( 0.28, 0.24, 0.55, 1 )">
</constant>
<constant name="darkslategray" value="Color( 0.18, 0.31, 0.31, 1 )">
</constant>
<constant name="darkturquoise" value="Color( 0, 0.81, 0.82, 1 )">
</constant>
<constant name="darkviolet" value="Color( 0.58, 0, 0.83, 1 )">
</constant>
<constant name="deeppink" value="Color( 1, 0.08, 0.58, 1 )">
</constant>
<constant name="deepskyblue" value="Color( 0, 0.75, 1, 1 )">
</constant>
<constant name="dimgray" value="Color( 0.41, 0.41, 0.41, 1 )">
</constant>
<constant name="dodgerblue" value="Color( 0.12, 0.56, 1, 1 )">
</constant>
<constant name="firebrick" value="Color( 0.7, 0.13, 0.13, 1 )">
</constant>
<constant name="floralwhite" value="Color( 1, 0.98, 0.94, 1 )">
</constant>
<constant name="forestgreen" value="Color( 0.13, 0.55, 0.13, 1 )">
</constant>
<constant name="fuchsia" value="Color( 1, 0, 1, 1 )">
</constant>
<constant name="gainsboro" value="Color( 0.86, 0.86, 0.86, 1 )">
</constant>
<constant name="ghostwhite" value="Color( 0.97, 0.97, 1, 1 )">
</constant>
<constant name="gold" value="Color( 1, 0.84, 0, 1 )">
</constant>
<constant name="goldenrod" value="Color( 0.85, 0.65, 0.13, 1 )">
</constant>
<constant name="green" value="Color( 0, 1, 0, 1 )">
</constant>
<constant name="greenyellow" value="Color( 0.68, 1, 0.18, 1 )">
</constant>
<constant name="honeydew" value="Color( 0.94, 1, 0.94, 1 )">
</constant>
<constant name="hotpink" value="Color( 1, 0.41, 0.71, 1 )">
</constant>
<constant name="indianred" value="Color( 0.8, 0.36, 0.36, 1 )">
</constant>
<constant name="indigo" value="Color( 0.29, 0, 0.51, 1 )">
</constant>
<constant name="ivory" value="Color( 1, 1, 0.94, 1 )">
</constant>
<constant name="khaki" value="Color( 0.94, 0.9, 0.55, 1 )">
</constant>
<constant name="lavender" value="Color( 0.9, 0.9, 0.98, 1 )">
</constant>
<constant name="lavenderblush" value="Color( 1, 0.94, 0.96, 1 )">
</constant>
<constant name="lawngreen" value="Color( 0.49, 0.99, 0, 1 )">
</constant>
<constant name="lemonchiffon" value="Color( 1, 0.98, 0.8, 1 )">
</constant>
<constant name="lightblue" value="Color( 0.68, 0.85, 0.9, 1 )">
</constant>
<constant name="lightcoral" value="Color( 0.94, 0.5, 0.5, 1 )">
</constant>
<constant name="lightcyan" value="Color( 0.88, 1, 1, 1 )">
</constant>
<constant name="lightgoldenrod" value="Color( 0.98, 0.98, 0.82, 1 )">
</constant>
<constant name="lightgray" value="Color( 0.83, 0.83, 0.83, 1 )">
</constant>
<constant name="lightgreen" value="Color( 0.56, 0.93, 0.56, 1 )">
</constant>
<constant name="lightpink" value="Color( 1, 0.71, 0.76, 1 )">
</constant>
<constant name="lightsalmon" value="Color( 1, 0.63, 0.48, 1 )">
</constant>
<constant name="lightseagreen" value="Color( 0.13, 0.7, 0.67, 1 )">
</constant>
<constant name="lightskyblue" value="Color( 0.53, 0.81, 0.98, 1 )">
</constant>
<constant name="lightslategray" value="Color( 0.47, 0.53, 0.6, 1 )">
</constant>
<constant name="lightsteelblue" value="Color( 0.69, 0.77, 0.87, 1 )">
</constant>
<constant name="lightyellow" value="Color( 1, 1, 0.88, 1 )">
</constant>
<constant name="lime" value="Color( 0, 1, 0, 1 )">
</constant>
<constant name="limegreen" value="Color( 0.2, 0.8, 0.2, 1 )">
</constant>
<constant name="linen" value="Color( 0.98, 0.94, 0.9, 1 )">
</constant>
<constant name="magenta" value="Color( 1, 0, 1, 1 )">
</constant>
<constant name="maroon" value="Color( 0.69, 0.19, 0.38, 1 )">
</constant>
<constant name="mediumaquamarine" value="Color( 0.4, 0.8, 0.67, 1 )">
</constant>
<constant name="mediumblue" value="Color( 0, 0, 0.8, 1 )">
</constant>
<constant name="mediumorchid" value="Color( 0.73, 0.33, 0.83, 1 )">
</constant>
<constant name="mediumpurple" value="Color( 0.58, 0.44, 0.86, 1 )">
</constant>
<constant name="mediumseagreen" value="Color( 0.24, 0.7, 0.44, 1 )">
</constant>
<constant name="mediumslateblue" value="Color( 0.48, 0.41, 0.93, 1 )">
</constant>
<constant name="mediumspringgreen" value="Color( 0, 0.98, 0.6, 1 )">
</constant>
<constant name="mediumturquoise" value="Color( 0.28, 0.82, 0.8, 1 )">
</constant>
<constant name="mediumvioletred" value="Color( 0.78, 0.08, 0.52, 1 )">
</constant>
<constant name="midnightblue" value="Color( 0.1, 0.1, 0.44, 1 )">
</constant>
<constant name="mintcream" value="Color( 0.96, 1, 0.98, 1 )">
</constant>
<constant name="mistyrose" value="Color( 1, 0.89, 0.88, 1 )">
</constant>
<constant name="moccasin" value="Color( 1, 0.89, 0.71, 1 )">
</constant>
<constant name="navajowhite" value="Color( 1, 0.87, 0.68, 1 )">
</constant>
<constant name="navyblue" value="Color( 0, 0, 0.5, 1 )">
</constant>
<constant name="oldlace" value="Color( 0.99, 0.96, 0.9, 1 )">
</constant>
<constant name="olive" value="Color( 0.5, 0.5, 0, 1 )">
</constant>
<constant name="olivedrab" value="Color( 0.42, 0.56, 0.14, 1 )">
</constant>
<constant name="orange" value="Color( 1, 0.65, 0, 1 )">
</constant>
<constant name="orangered" value="Color( 1, 0.27, 0, 1 )">
</constant>
<constant name="orchid" value="Color( 0.85, 0.44, 0.84, 1 )">
</constant>
<constant name="palegoldenrod" value="Color( 0.93, 0.91, 0.67, 1 )">
</constant>
<constant name="palegreen" value="Color( 0.6, 0.98, 0.6, 1 )">
</constant>
<constant name="paleturquoise" value="Color( 0.69, 0.93, 0.93, 1 )">
</constant>
<constant name="palevioletred" value="Color( 0.86, 0.44, 0.58, 1 )">
</constant>
<constant name="papayawhip" value="Color( 1, 0.94, 0.84, 1 )">
</constant>
<constant name="peachpuff" value="Color( 1, 0.85, 0.73, 1 )">
</constant>
<constant name="peru" value="Color( 0.8, 0.52, 0.25, 1 )">
</constant>
<constant name="pink" value="Color( 1, 0.75, 0.8, 1 )">
</constant>
<constant name="plum" value="Color( 0.87, 0.63, 0.87, 1 )">
</constant>
<constant name="powderblue" value="Color( 0.69, 0.88, 0.9, 1 )">
</constant>
<constant name="purple" value="Color( 0.63, 0.13, 0.94, 1 )">
</constant>
<constant name="rebeccapurple" value="Color( 0.4, 0.2, 0.6, 1 )">
</constant>
<constant name="red" value="Color( 1, 0, 0, 1 )">
</constant>
<constant name="rosybrown" value="Color( 0.74, 0.56, 0.56, 1 )">
</constant>
<constant name="royalblue" value="Color( 0.25, 0.41, 0.88, 1 )">
</constant>
<constant name="saddlebrown" value="Color( 0.55, 0.27, 0.07, 1 )">
</constant>
<constant name="salmon" value="Color( 0.98, 0.5, 0.45, 1 )">
</constant>
<constant name="sandybrown" value="Color( 0.96, 0.64, 0.38, 1 )">
</constant>
<constant name="seagreen" value="Color( 0.18, 0.55, 0.34, 1 )">
</constant>
<constant name="seashell" value="Color( 1, 0.96, 0.93, 1 )">
</constant>
<constant name="sienna" value="Color( 0.63, 0.32, 0.18, 1 )">
</constant>
<constant name="silver" value="Color( 0.75, 0.75, 0.75, 1 )">
</constant>
<constant name="skyblue" value="Color( 0.53, 0.81, 0.92, 1 )">
</constant>
<constant name="slateblue" value="Color( 0.42, 0.35, 0.8, 1 )">
</constant>
<constant name="slategray" value="Color( 0.44, 0.5, 0.56, 1 )">
</constant>
<constant name="snow" value="Color( 1, 0.98, 0.98, 1 )">
</constant>
<constant name="springgreen" value="Color( 0, 1, 0.5, 1 )">
</constant>
<constant name="steelblue" value="Color( 0.27, 0.51, 0.71, 1 )">
</constant>
<constant name="tan" value="Color( 0.82, 0.71, 0.55, 1 )">
</constant>
<constant name="teal" value="Color( 0, 0.5, 0.5, 1 )">
</constant>
<constant name="thistle" value="Color( 0.85, 0.75, 0.85, 1 )">
</constant>
<constant name="tomato" value="Color( 1, 0.39, 0.28, 1 )">
</constant>
<constant name="transparent" value="Color( 1, 1, 1, 0 )">
</constant>
<constant name="turquoise" value="Color( 0.25, 0.88, 0.82, 1 )">
</constant>
<constant name="violet" value="Color( 0.93, 0.51, 0.93, 1 )">
</constant>
<constant name="webgray" value="Color( 0.5, 0.5, 0.5, 1 )">
</constant>
<constant name="webgreen" value="Color( 0, 0.5, 0, 1 )">
</constant>
<constant name="webmaroon" value="Color( 0.5, 0, 0, 1 )">
</constant>
<constant name="webpurple" value="Color( 0.5, 0, 0.5, 1 )">
</constant>
<constant name="wheat" value="Color( 0.96, 0.87, 0.7, 1 )">
</constant>
<constant name="white" value="Color( 1, 1, 1, 1 )">
</constant>
<constant name="whitesmoke" value="Color( 0.96, 0.96, 0.96, 1 )">
</constant>
<constant name="yellow" value="Color( 1, 1, 0, 1 )">
</constant>
<constant name="yellowgreen" value="Color( 0.6, 0.8, 0.2, 1 )">
</constant>
</constants>
</class>
Reference in New Issue View Git Blame Copy Permalink