Color
Color in RGBA format with some support for ARGB format.
Properties
Color ( from ) | |
Color | ( int from ) |
Color ( r, float g, b ) | |
Color | ( float r, g, float b, a ) |
Color | ( Color over ) |
contrasted ( ) | |
darkened ( amount ) | |
Color | ( float h, s, float v, a=1 ) |
float | ( ) |
Color | ( ) |
Color | ( float amount ) |
linear_interpolate ( b, float t ) | |
to_abgr32 ( ) | |
to_abgr64 ( ) | |
to_argb32 ( ) | |
to_argb64 ( ) | |
to_html ( with_alpha=True ) | |
int | ( ) |
int | ( ) |
Constants
- 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 )
- 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 )
- tomato = Color( 1, 0.39, 0.28, 1 )
- 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 )
A color is represented by red, green, and blue 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 CanvasItem.modulate) may accept values > 1.
You can also create a color from standardized color names by using .
Property Descriptions
- float a
Alpha value (range 0 to 1).
- a8
Alpha value (range 0 to 255).
- float b
Blue value (range 0 to 1).
- b8
Blue value (range 0 to 255).
- float g
Green value (range 0 to 1).
- g8
Green value (range 0 to 255).
- float h
HSV hue value (range 0 to 1).
- r
Red value (range 0 to 1).
- int r8
- s
HSV saturation value (range 0 to 1).
- float v
HSV value (range 0 to 1).
- Color ( String from )
Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also .
- Color Color ( 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)
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)
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)
- blend ( 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%
- 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)
- Color darkened ( amount )
Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1).
Constructs a color from an HSV profile. h
, s
, and v
are values between 0 and 1.
- gray ( )
Returns the color’s grayscale representation.
var c = Color(0.2, 0.45, 0.82)
var gray = c.gray() # a value of 0.466667
- 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)
- lightened ( 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
- linear_interpolate ( Color b, 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)
- 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.
- 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.
print(c.to_abgr64()) # Prints -225178692812801
- 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
- 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
- String to_html ( 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() # Results "7fffffff"
var s2 = c.to_html(false) # Results 'ffffff'
- 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)
- 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.