Color

Color in RGBA format using floats on the range of 0 to 1.

Description

A color represented by red, green, blue, and alpha (RGBA) components. The alpha component is often used for opacity. Values are in floating-point and usually range from 0 to 1. Some properties (such as CanvasItem.modulate) may accept values greater than 1 (overbright or HDR colors).

You can also create a color from standardized color names by using @GDScript.ColorN or directly using the color constants defined here. The standardized color set is based on the X11 color names.

If you want to supply values in a range of 0 to 255, you should use @GDScript.Color8.

Note: In a boolean context, a Color will evaluate to false if it's equal to Color(0, 0, 0, 1) (opaque black). Otherwise, a Color will always evaluate to true.

Color constants cheatsheet

Tutorials

Properties

float

a

1.0

int

a8

255

float

b

0.0

int

b8

0

float

g

0.0

int

g8

0

float

h

0.0

float

r

0.0

int

r8

0

float

s

0.0

float

v

0.0

Methods

Color

Color ( String from )

Color

Color ( int from )

Color

Color ( Color from, float alpha )

Color

Color ( float r, float g, float b )

Color

Color ( float r, float g, float b, float a )

Color

blend ( Color over )

Color

contrasted ( )

Color

darkened ( float amount )

Color

from_hsv ( float h, float s, float v, float a=1.0 )

float

get_luminance ( )

float

gray ( )

Color

inverted ( )

bool

is_equal_approx ( Color color )

Color

lightened ( float amount )

Color

linear_interpolate ( Color to, float weight )

int

to_abgr32 ( )

int

to_abgr64 ( )

int

to_argb32 ( )

int

to_argb64 ( )

String

to_html ( bool with_alpha=true )

int

to_rgba32 ( )

int

to_rgba64 ( )


Constants

aliceblue = Color( 0.941176, 0.972549, 1, 1 )

Alice blue color.

antiquewhite = Color( 0.980392, 0.921569, 0.843137, 1 )

Antique white color.

aqua = Color( 0, 1, 1, 1 )

Aqua color.

aquamarine = Color( 0.498039, 1, 0.831373, 1 )

Aquamarine color.

azure = Color( 0.941176, 1, 1, 1 )

Azure color.

beige = Color( 0.960784, 0.960784, 0.862745, 1 )

Beige color.

bisque = Color( 1, 0.894118, 0.768627, 1 )

Bisque color.

black = Color( 0, 0, 0, 1 )

Black color.

blanchedalmond = Color( 1, 0.921569, 0.803922, 1 )

Blanche almond color.

blue = Color( 0, 0, 1, 1 )

Blue color.

blueviolet = Color( 0.541176, 0.168627, 0.886275, 1 )

Blue violet color.

brown = Color( 0.647059, 0.164706, 0.164706, 1 )

Brown color.

burlywood = Color( 0.870588, 0.721569, 0.529412, 1 )

Burly wood color.

cadetblue = Color( 0.372549, 0.619608, 0.627451, 1 )

Cadet blue color.

chartreuse = Color( 0.498039, 1, 0, 1 )

Chartreuse color.

chocolate = Color( 0.823529, 0.411765, 0.117647, 1 )

Chocolate color.

coral = Color( 1, 0.498039, 0.313726, 1 )

Coral color.

cornflower = Color( 0.392157, 0.584314, 0.929412, 1 )

Cornflower color.

cornsilk = Color( 1, 0.972549, 0.862745, 1 )

Corn silk color.

crimson = Color( 0.862745, 0.0784314, 0.235294, 1 )

Crimson color.

cyan = Color( 0, 1, 1, 1 )

Cyan color.

darkblue = Color( 0, 0, 0.545098, 1 )

Dark blue color.

darkcyan = Color( 0, 0.545098, 0.545098, 1 )

Dark cyan color.

darkgoldenrod = Color( 0.721569, 0.52549, 0.0431373, 1 )

Dark goldenrod color.

darkgray = Color( 0.662745, 0.662745, 0.662745, 1 )

Dark gray color.

darkgreen = Color( 0, 0.392157, 0, 1 )

Dark green color.

darkkhaki = Color( 0.741176, 0.717647, 0.419608, 1 )

Dark khaki color.

darkmagenta = Color( 0.545098, 0, 0.545098, 1 )

Dark magenta color.

darkolivegreen = Color( 0.333333, 0.419608, 0.184314, 1 )

Dark olive green color.

darkorange = Color( 1, 0.54902, 0, 1 )

Dark orange color.

darkorchid = Color( 0.6, 0.196078, 0.8, 1 )

Dark orchid color.

darkred = Color( 0.545098, 0, 0, 1 )

Dark red color.

darksalmon = Color( 0.913725, 0.588235, 0.478431, 1 )

Dark salmon color.

darkseagreen = Color( 0.560784, 0.737255, 0.560784, 1 )

Dark sea green color.

darkslateblue = Color( 0.282353, 0.239216, 0.545098, 1 )

Dark slate blue color.

darkslategray = Color( 0.184314, 0.309804, 0.309804, 1 )

Dark slate gray color.

darkturquoise = Color( 0, 0.807843, 0.819608, 1 )

Dark turquoise color.

darkviolet = Color( 0.580392, 0, 0.827451, 1 )

Dark violet color.

deeppink = Color( 1, 0.0784314, 0.576471, 1 )

Deep pink color.

deepskyblue = Color( 0, 0.74902, 1, 1 )

Deep sky blue color.

dimgray = Color( 0.411765, 0.411765, 0.411765, 1 )

Dim gray color.

dodgerblue = Color( 0.117647, 0.564706, 1, 1 )

Dodger blue color.

firebrick = Color( 0.698039, 0.133333, 0.133333, 1 )

Firebrick color.

floralwhite = Color( 1, 0.980392, 0.941176, 1 )

Floral white color.

forestgreen = Color( 0.133333, 0.545098, 0.133333, 1 )

Forest green color.

fuchsia = Color( 1, 0, 1, 1 )

Fuchsia color.

gainsboro = Color( 0.862745, 0.862745, 0.862745, 1 )

Gainsboro color.

ghostwhite = Color( 0.972549, 0.972549, 1, 1 )

Ghost white color.

gold = Color( 1, 0.843137, 0, 1 )

Gold color.

goldenrod = Color( 0.854902, 0.647059, 0.12549, 1 )

Goldenrod color.

gray = Color( 0.745098, 0.745098, 0.745098, 1 )

Gray color.

green = Color( 0, 1, 0, 1 )

Green color.

greenyellow = Color( 0.678431, 1, 0.184314, 1 )

Green yellow color.

honeydew = Color( 0.941176, 1, 0.941176, 1 )

Honeydew color.

hotpink = Color( 1, 0.411765, 0.705882, 1 )

Hot pink color.

indianred = Color( 0.803922, 0.360784, 0.360784, 1 )

Indian red color.

indigo = Color( 0.294118, 0, 0.509804, 1 )

Indigo color.

ivory = Color( 1, 1, 0.941176, 1 )

Ivory color.

khaki = Color( 0.941176, 0.901961, 0.54902, 1 )

Khaki color.

lavender = Color( 0.901961, 0.901961, 0.980392, 1 )

Lavender color.

lavenderblush = Color( 1, 0.941176, 0.960784, 1 )

Lavender blush color.

lawngreen = Color( 0.486275, 0.988235, 0, 1 )

Lawn green color.

lemonchiffon = Color( 1, 0.980392, 0.803922, 1 )

Lemon chiffon color.

lightblue = Color( 0.678431, 0.847059, 0.901961, 1 )

Light blue color.

lightcoral = Color( 0.941176, 0.501961, 0.501961, 1 )

Light coral color.

lightcyan = Color( 0.878431, 1, 1, 1 )

Light cyan color.

lightgoldenrod = Color( 0.980392, 0.980392, 0.823529, 1 )

Light goldenrod color.

lightgray = Color( 0.827451, 0.827451, 0.827451, 1 )

Light gray color.

lightgreen = Color( 0.564706, 0.933333, 0.564706, 1 )

Light green color.

lightpink = Color( 1, 0.713726, 0.756863, 1 )

Light pink color.

lightsalmon = Color( 1, 0.627451, 0.478431, 1 )

Light salmon color.

lightseagreen = Color( 0.12549, 0.698039, 0.666667, 1 )

Light sea green color.

lightskyblue = Color( 0.529412, 0.807843, 0.980392, 1 )

Light sky blue color.

lightslategray = Color( 0.466667, 0.533333, 0.6, 1 )

Light slate gray color.

lightsteelblue = Color( 0.690196, 0.768627, 0.870588, 1 )

Light steel blue color.

lightyellow = Color( 1, 1, 0.878431, 1 )

Light yellow color.

lime = Color( 0, 1, 0, 1 )

Lime color.

limegreen = Color( 0.196078, 0.803922, 0.196078, 1 )

Lime green color.

linen = Color( 0.980392, 0.941176, 0.901961, 1 )

Linen color.

magenta = Color( 1, 0, 1, 1 )

Magenta color.

maroon = Color( 0.690196, 0.188235, 0.376471, 1 )

Maroon color.

mediumaquamarine = Color( 0.4, 0.803922, 0.666667, 1 )

Medium aquamarine color.

mediumblue = Color( 0, 0, 0.803922, 1 )

Medium blue color.

mediumorchid = Color( 0.729412, 0.333333, 0.827451, 1 )

Medium orchid color.

mediumpurple = Color( 0.576471, 0.439216, 0.858824, 1 )

Medium purple color.

mediumseagreen = Color( 0.235294, 0.701961, 0.443137, 1 )

Medium sea green color.

mediumslateblue = Color( 0.482353, 0.407843, 0.933333, 1 )

Medium slate blue color.

mediumspringgreen = Color( 0, 0.980392, 0.603922, 1 )

Medium spring green color.

mediumturquoise = Color( 0.282353, 0.819608, 0.8, 1 )

Medium turquoise color.

mediumvioletred = Color( 0.780392, 0.0823529, 0.521569, 1 )

Medium violet red color.

midnightblue = Color( 0.0980392, 0.0980392, 0.439216, 1 )

Midnight blue color.

mintcream = Color( 0.960784, 1, 0.980392, 1 )

Mint cream color.

mistyrose = Color( 1, 0.894118, 0.882353, 1 )

Misty rose color.

moccasin = Color( 1, 0.894118, 0.709804, 1 )

Moccasin color.

navajowhite = Color( 1, 0.870588, 0.678431, 1 )

Navajo white color.

navyblue = Color( 0, 0, 0.501961, 1 )

Navy blue color.

oldlace = Color( 0.992157, 0.960784, 0.901961, 1 )

Old lace color.

olive = Color( 0.501961, 0.501961, 0, 1 )

Olive color.

olivedrab = Color( 0.419608, 0.556863, 0.137255, 1 )

Olive drab color.

orange = Color( 1, 0.647059, 0, 1 )

Orange color.

orangered = Color( 1, 0.270588, 0, 1 )

Orange red color.

orchid = Color( 0.854902, 0.439216, 0.839216, 1 )

Orchid color.

palegoldenrod = Color( 0.933333, 0.909804, 0.666667, 1 )

Pale goldenrod color.

palegreen = Color( 0.596078, 0.984314, 0.596078, 1 )

Pale green color.

paleturquoise = Color( 0.686275, 0.933333, 0.933333, 1 )

Pale turquoise color.

palevioletred = Color( 0.858824, 0.439216, 0.576471, 1 )

Pale violet red color.

papayawhip = Color( 1, 0.937255, 0.835294, 1 )

Papaya whip color.

peachpuff = Color( 1, 0.854902, 0.72549, 1 )

Peach puff color.

peru = Color( 0.803922, 0.521569, 0.247059, 1 )

Peru color.

pink = Color( 1, 0.752941, 0.796078, 1 )

Pink color.

plum = Color( 0.866667, 0.627451, 0.866667, 1 )

Plum color.

powderblue = Color( 0.690196, 0.878431, 0.901961, 1 )

Powder blue color.

purple = Color( 0.627451, 0.12549, 0.941176, 1 )

Purple color.

rebeccapurple = Color( 0.4, 0.2, 0.6, 1 )

Rebecca purple color.

red = Color( 1, 0, 0, 1 )

Red color.

rosybrown = Color( 0.737255, 0.560784, 0.560784, 1 )

Rosy brown color.

royalblue = Color( 0.254902, 0.411765, 0.882353, 1 )

Royal blue color.

saddlebrown = Color( 0.545098, 0.270588, 0.0745098, 1 )

Saddle brown color.

salmon = Color( 0.980392, 0.501961, 0.447059, 1 )

Salmon color.

sandybrown = Color( 0.956863, 0.643137, 0.376471, 1 )

Sandy brown color.

seagreen = Color( 0.180392, 0.545098, 0.341176, 1 )

Sea green color.

seashell = Color( 1, 0.960784, 0.933333, 1 )

Seashell color.

sienna = Color( 0.627451, 0.321569, 0.176471, 1 )

Sienna color.

silver = Color( 0.752941, 0.752941, 0.752941, 1 )

Silver color.

skyblue = Color( 0.529412, 0.807843, 0.921569, 1 )

Sky blue color.

slateblue = Color( 0.415686, 0.352941, 0.803922, 1 )

Slate blue color.

slategray = Color( 0.439216, 0.501961, 0.564706, 1 )

Slate gray color.

snow = Color( 1, 0.980392, 0.980392, 1 )

Snow color.

springgreen = Color( 0, 1, 0.498039, 1 )

Spring green color.

steelblue = Color( 0.27451, 0.509804, 0.705882, 1 )

Steel blue color.

tan = Color( 0.823529, 0.705882, 0.54902, 1 )

Tan color.

teal = Color( 0, 0.501961, 0.501961, 1 )

Teal color.

thistle = Color( 0.847059, 0.74902, 0.847059, 1 )

Thistle color.

tomato = Color( 1, 0.388235, 0.278431, 1 )

Tomato color.

transparent = Color( 1, 1, 1, 0 )

Transparent color (white with no alpha).

turquoise = Color( 0.25098, 0.878431, 0.815686, 1 )

Turquoise color.

violet = Color( 0.933333, 0.509804, 0.933333, 1 )

Violet color.

webgray = Color( 0.501961, 0.501961, 0.501961, 1 )

Web gray color.

webgreen = Color( 0, 0.501961, 0, 1 )

Web green color.

webmaroon = Color( 0.501961, 0, 0, 1 )

Web maroon color.

webpurple = Color( 0.501961, 0, 0.501961, 1 )

Web purple color.

wheat = Color( 0.960784, 0.870588, 0.701961, 1 )

Wheat color.

white = Color( 1, 1, 1, 1 )

White color.

whitesmoke = Color( 0.960784, 0.960784, 0.960784, 1 )

White smoke color.

yellow = Color( 1, 1, 0, 1 )

Yellow color.

yellowgreen = Color( 0.603922, 0.803922, 0.196078, 1 )

Yellow green color.


Property Descriptions

float a = 1.0

The color's alpha component, typically on the range of 0 to 1. A value of 0 means that the color is fully transparent. A value of 1 means that the color is fully opaque.


int a8 = 255

Wrapper for a that uses the range 0 to 255 instead of 0 to 1.


float b = 0.0

The color's blue component, typically on the range of 0 to 1.


int b8 = 0

Wrapper for b that uses the range 0 to 255 instead of 0 to 1.


float g = 0.0

The color's green component, typically on the range of 0 to 1.


int g8 = 0

Wrapper for g that uses the range 0 to 255 instead of 0 to 1.


float h = 0.0

The HSV hue of this color, on the range 0 to 1.


float r = 0.0

The color's red component, typically on the range of 0 to 1.


int r8 = 0

Wrapper for r that uses the range 0 to 255 instead of 0 to 1.


float s = 0.0

The HSV saturation of this color, on the range 0 to 1.


float v = 0.0

The HSV value (brightness) of this color, on the range 0 to 1.


Method Descriptions

Color Color ( String from )

Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also @GDScript.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.

Color Color ( int from )

Constructs a color from a 32-bit integer in RGBA format (each byte represents a color channel).

var color = Color(274) # Similar to Color(0.0, 0.0, 0.004, 0.07)

Color Color ( Color from, float alpha )

Constructs a color from the existing color, with a set to the given alpha value.

var red = Color(Color.red, 0.2) # 20% opaque red.

Color Color ( float r, float g, float b )

Constructs a color from RGB values, typically between 0 and 1. Alpha will be 1.

var color = Color(0.2, 1.0, 0.7) # Similar to Color8(51, 255, 178, 255)

Color Color ( float r, float g, float b, float a )

Constructs a color from RGBA values, typically between 0 and 1.

var color = Color(0.2, 1.0, 0.7, 0.8) # Similar to Color8(51, 255, 178, 204)

Color 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%

Color contrasted ( )

Returns the most contrasting color.

var color = Color(0.3, 0.4, 0.9)
var contrasted_color = color.contrasted() # Equivalent to RGBA(204, 229, 102, 255)

Color darkened ( 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

Color from_hsv ( float h, float s, float v, float a=1.0 )

Constructs a color from an HSV profile. h, s, and v are values between 0 and 1.

var color = 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)

float get_luminance ( )

Returns the luminance of the color in the [0.0, 1.0] range.

This is useful when determining light or dark color. Colors with a luminance smaller than 0.5 can be generally considered dark.


float gray ( )

Returns the color's grayscale representation.

The gray value is calculated as (r + g + b) / 3.

var color = Color(0.2, 0.45, 0.82)
var gray = color.gray() # A value of 0.466667

Color inverted ( )

Returns the inverted color (1 - r, 1 - g, 1 - b, a).

var color = Color(0.3, 0.4, 0.9)
var inverted_color = color.inverted() # Equivalent to Color(0.7, 0.6, 0.1)

bool is_equal_approx ( Color color )

Returns true if this color and color are approximately equal, by running @GDScript.is_equal_approx on each component.


Color 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

Color linear_interpolate ( Color to, float weight )

Returns the linear interpolation with another color. The interpolation factor weight 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) # Equivalent to Color(0.5, 0.5, 0.0)

int to_abgr32 ( )

Returns the color converted to a 32-bit integer in ABGR format (each byte represents a color channel). ABGR is the reversed version of the default format.

var color = Color(1, 0.5, 0.2)
print(color.to_abgr32()) # Prints 4281565439

int to_abgr64 ( )

Returns the color converted to a 64-bit integer in ABGR format (each word represents a color channel). ABGR is the reversed version of the default format.

var color = Color(1, 0.5, 0.2)
print(color.to_abgr64()) # Prints -225178692812801

int to_argb32 ( )

Returns the color converted to a 32-bit integer in ARGB format (each byte represents a color channel). ARGB is more compatible with DirectX.

var color = Color(1, 0.5, 0.2)
print(color.to_argb32()) # Prints 4294934323

int to_argb64 ( )

Returns the color converted to a 64-bit integer in ARGB format (each word represents a color channel). ARGB is more compatible with DirectX.

var color = Color(1, 0.5, 0.2)
print(color.to_argb64()) # Prints -2147470541

String to_html ( 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 color = Color(1, 1, 1, 0.5)
var s1 = color.to_html() # Returns "7fffffff"
var s2 = color.to_html(false) # Returns "ffffff"

int to_rgba32 ( )

Returns the color converted to a 32-bit integer in RGBA format (each byte represents a color channel). RGBA is Godot's default format.

var color = Color(1, 0.5, 0.2)
print(color.to_rgba32()) # Prints 4286526463

int to_rgba64 ( )

Returns the color converted to a 64-bit integer in RGBA format (each word represents a color channel). RGBA is Godot's default format.

var color = Color(1, 0.5, 0.2)
print(color.to_rgba64()) # Prints -140736629309441