Table of Contents

Class Color

A color represented in RGBA format.

Color

Remarks

A color represented in RGBA format by a red (r), green (g), blue (b), and alpha (a) component. Each component is a 32-bit floating-point value, usually ranging from 0.0 to 1.0. Some properties (such as modulate) may support values greater than 1.0, for overbright or HDR (High Dynamic Range) colors.

Colors can be created in various ways: By the various Color constructors, by static methods such as Color.from_hsv, and by using a name from the set of standardized colors based on X11 color names with the addition of TRANSPARENT. GDScript also provides @GDScript.Color8, which uses integers from 0 to 255 and doesn't support overbright colors.

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

\ Color constants cheatsheet

See Also

2D GD Paint Demo
Tween Interpolation Demo
GUI Drag And Drop Demo

Constructors

Color

Constructs a default Color from opaque black. This is the same as BLACK.

Note: In C#, this constructs a Color with all of its components set to 0.0 (transparent black).

Color Color

Color(Color, float)

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(Color from, float alpha)

Parameters

from Color
alpha float

Color(Color)

Constructs a Color as a copy of the given Color.

Color Color(Color from)

Parameters

from Color

Color(String)

Constructs a Color either from an HTML color code or from a standardized color name. The supported color names are the same as the constants.

Color Color(String code)

Parameters

code String

Color(String, float)

Constructs a Color either from an HTML color code or from a standardized color name, with alpha on the range of 0.0 to 1.0. The supported color names are the same as the constants.

Color Color(String code, float alpha)

Parameters

code String
alpha float

Color(float, float, float)

Constructs a Color from RGB values, typically between 0.0 and 1.0. a is set to 1.0.

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


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

Parameters

r float
g float
b float

Color(float, float, float, float)

Constructs a Color from RGBA values, typically between 0.0 and 1.0.

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


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

Parameters

r float
g float
b float
a float

Fields

ALICE_BLUE

Alice blue color.

const ALICE_BLUE = Color(0.941176, 0.972549, 1, 1)

ANTIQUE_WHITE

Antique white color.

const ANTIQUE_WHITE = Color(0.980392, 0.921569, 0.843137, 1)

AQUA

Aqua color.

const AQUA = Color(0, 1, 1, 1)

AQUAMARINE

Aquamarine color.

const AQUAMARINE = Color(0.498039, 1, 0.831373, 1)

AZURE

Azure color.

const AZURE = Color(0.941176, 1, 1, 1)

BEIGE

Beige color.

const BEIGE = Color(0.960784, 0.960784, 0.862745, 1)

BISQUE

Bisque color.

const BISQUE = Color(1, 0.894118, 0.768627, 1)

BLACK

Black color. In GDScript, this is the default value of any color.

const BLACK = Color(0, 0, 0, 1)

BLANCHED_ALMOND

Blanched almond color.

const BLANCHED_ALMOND = Color(1, 0.921569, 0.803922, 1)

BLUE

Blue color.

const BLUE = Color(0, 0, 1, 1)

BLUE_VIOLET

Blue violet color.

const BLUE_VIOLET = Color(0.541176, 0.168627, 0.886275, 1)

BROWN

Brown color.

const BROWN = Color(0.647059, 0.164706, 0.164706, 1)

BURLYWOOD

Burlywood color.

const BURLYWOOD = Color(0.870588, 0.721569, 0.529412, 1)

CADET_BLUE

Cadet blue color.

const CADET_BLUE = Color(0.372549, 0.619608, 0.627451, 1)

CHARTREUSE

Chartreuse color.

const CHARTREUSE = Color(0.498039, 1, 0, 1)

CHOCOLATE

Chocolate color.

const CHOCOLATE = Color(0.823529, 0.411765, 0.117647, 1)

CORAL

Coral color.

const CORAL = Color(1, 0.498039, 0.313726, 1)

CORNFLOWER_BLUE

Cornflower blue color.

const CORNFLOWER_BLUE = Color(0.392157, 0.584314, 0.929412, 1)

CORNSILK

Cornsilk color.

const CORNSILK = Color(1, 0.972549, 0.862745, 1)

CRIMSON

Crimson color.

const CRIMSON = Color(0.862745, 0.0784314, 0.235294, 1)

CYAN

Cyan color.

const CYAN = Color(0, 1, 1, 1)

DARK_BLUE

Dark blue color.

const DARK_BLUE = Color(0, 0, 0.545098, 1)

DARK_CYAN

Dark cyan color.

const DARK_CYAN = Color(0, 0.545098, 0.545098, 1)

DARK_GOLDENROD

Dark goldenrod color.

const DARK_GOLDENROD = Color(0.721569, 0.52549, 0.0431373, 1)

DARK_GRAY

Dark gray color.

const DARK_GRAY = Color(0.662745, 0.662745, 0.662745, 1)

DARK_GREEN

Dark green color.

const DARK_GREEN = Color(0, 0.392157, 0, 1)

DARK_KHAKI

Dark khaki color.

const DARK_KHAKI = Color(0.741176, 0.717647, 0.419608, 1)

DARK_MAGENTA

Dark magenta color.

const DARK_MAGENTA = Color(0.545098, 0, 0.545098, 1)

DARK_OLIVE_GREEN

Dark olive green color.

const DARK_OLIVE_GREEN = Color(0.333333, 0.419608, 0.184314, 1)

DARK_ORANGE

Dark orange color.

const DARK_ORANGE = Color(1, 0.54902, 0, 1)

DARK_ORCHID

Dark orchid color.

const DARK_ORCHID = Color(0.6, 0.196078, 0.8, 1)

DARK_RED

Dark red color.

const DARK_RED = Color(0.545098, 0, 0, 1)

DARK_SALMON

Dark salmon color.

const DARK_SALMON = Color(0.913725, 0.588235, 0.478431, 1)

DARK_SEA_GREEN

Dark sea green color.

const DARK_SEA_GREEN = Color(0.560784, 0.737255, 0.560784, 1)

DARK_SLATE_BLUE

Dark slate blue color.

const DARK_SLATE_BLUE = Color(0.282353, 0.239216, 0.545098, 1)

DARK_SLATE_GRAY

Dark slate gray color.

const DARK_SLATE_GRAY = Color(0.184314, 0.309804, 0.309804, 1)

DARK_TURQUOISE

Dark turquoise color.

const DARK_TURQUOISE = Color(0, 0.807843, 0.819608, 1)

DARK_VIOLET

Dark violet color.

const DARK_VIOLET = Color(0.580392, 0, 0.827451, 1)

DEEP_PINK

Deep pink color.

const DEEP_PINK = Color(1, 0.0784314, 0.576471, 1)

DEEP_SKY_BLUE

Deep sky blue color.

const DEEP_SKY_BLUE = Color(0, 0.74902, 1, 1)

DIM_GRAY

Dim gray color.

const DIM_GRAY = Color(0.411765, 0.411765, 0.411765, 1)

DODGER_BLUE

Dodger blue color.

const DODGER_BLUE = Color(0.117647, 0.564706, 1, 1)

FIREBRICK

Firebrick color.

const FIREBRICK = Color(0.698039, 0.133333, 0.133333, 1)

FLORAL_WHITE

Floral white color.

const FLORAL_WHITE = Color(1, 0.980392, 0.941176, 1)

FOREST_GREEN

Forest green color.

const FOREST_GREEN = Color(0.133333, 0.545098, 0.133333, 1)

FUCHSIA

Fuchsia color.

const FUCHSIA = Color(1, 0, 1, 1)

GAINSBORO

Gainsboro color.

const GAINSBORO = Color(0.862745, 0.862745, 0.862745, 1)

GHOST_WHITE

Ghost white color.

const GHOST_WHITE = Color(0.972549, 0.972549, 1, 1)

GOLD

Gold color.

const GOLD = Color(1, 0.843137, 0, 1)

GOLDENROD

Goldenrod color.

const GOLDENROD = Color(0.854902, 0.647059, 0.12549, 1)

GRAY

Gray color.

const GRAY = Color(0.745098, 0.745098, 0.745098, 1)

GREEN

Green color.

const GREEN = Color(0, 1, 0, 1)

GREEN_YELLOW

Green yellow color.

const GREEN_YELLOW = Color(0.678431, 1, 0.184314, 1)

HONEYDEW

Honeydew color.

const HONEYDEW = Color(0.941176, 1, 0.941176, 1)

HOT_PINK

Hot pink color.

const HOT_PINK = Color(1, 0.411765, 0.705882, 1)

INDIAN_RED

Indian red color.

const INDIAN_RED = Color(0.803922, 0.360784, 0.360784, 1)

INDIGO

Indigo color.

const INDIGO = Color(0.294118, 0, 0.509804, 1)

IVORY

Ivory color.

const IVORY = Color(1, 1, 0.941176, 1)

KHAKI

Khaki color.

const KHAKI = Color(0.941176, 0.901961, 0.54902, 1)

LAVENDER

Lavender color.

const LAVENDER = Color(0.901961, 0.901961, 0.980392, 1)

LAVENDER_BLUSH

Lavender blush color.

const LAVENDER_BLUSH = Color(1, 0.941176, 0.960784, 1)

LAWN_GREEN

Lawn green color.

const LAWN_GREEN = Color(0.486275, 0.988235, 0, 1)

LEMON_CHIFFON

Lemon chiffon color.

const LEMON_CHIFFON = Color(1, 0.980392, 0.803922, 1)

LIGHT_BLUE

Light blue color.

const LIGHT_BLUE = Color(0.678431, 0.847059, 0.901961, 1)

LIGHT_CORAL

Light coral color.

const LIGHT_CORAL = Color(0.941176, 0.501961, 0.501961, 1)

LIGHT_CYAN

Light cyan color.

const LIGHT_CYAN = Color(0.878431, 1, 1, 1)

LIGHT_GOLDENROD

Light goldenrod color.

const LIGHT_GOLDENROD = Color(0.980392, 0.980392, 0.823529, 1)

LIGHT_GRAY

Light gray color.

const LIGHT_GRAY = Color(0.827451, 0.827451, 0.827451, 1)

LIGHT_GREEN

Light green color.

const LIGHT_GREEN = Color(0.564706, 0.933333, 0.564706, 1)

LIGHT_PINK

Light pink color.

const LIGHT_PINK = Color(1, 0.713726, 0.756863, 1)

LIGHT_SALMON

Light salmon color.

const LIGHT_SALMON = Color(1, 0.627451, 0.478431, 1)

LIGHT_SEA_GREEN

Light sea green color.

const LIGHT_SEA_GREEN = Color(0.12549, 0.698039, 0.666667, 1)

LIGHT_SKY_BLUE

Light sky blue color.

const LIGHT_SKY_BLUE = Color(0.529412, 0.807843, 0.980392, 1)

LIGHT_SLATE_GRAY

Light slate gray color.

const LIGHT_SLATE_GRAY = Color(0.466667, 0.533333, 0.6, 1)

LIGHT_STEEL_BLUE

Light steel blue color.

const LIGHT_STEEL_BLUE = Color(0.690196, 0.768627, 0.870588, 1)

LIGHT_YELLOW

Light yellow color.

const LIGHT_YELLOW = Color(1, 1, 0.878431, 1)

LIME

Lime color.

const LIME = Color(0, 1, 0, 1)

LIME_GREEN

Lime green color.

const LIME_GREEN = Color(0.196078, 0.803922, 0.196078, 1)

LINEN

Linen color.

const LINEN = Color(0.980392, 0.941176, 0.901961, 1)

MAGENTA

Magenta color.

const MAGENTA = Color(1, 0, 1, 1)

MAROON

Maroon color.

const MAROON = Color(0.690196, 0.188235, 0.376471, 1)

MEDIUM_AQUAMARINE

Medium aquamarine color.

const MEDIUM_AQUAMARINE = Color(0.4, 0.803922, 0.666667, 1)

MEDIUM_BLUE

Medium blue color.

const MEDIUM_BLUE = Color(0, 0, 0.803922, 1)

MEDIUM_ORCHID

Medium orchid color.

const MEDIUM_ORCHID = Color(0.729412, 0.333333, 0.827451, 1)

MEDIUM_PURPLE

Medium purple color.

const MEDIUM_PURPLE = Color(0.576471, 0.439216, 0.858824, 1)

MEDIUM_SEA_GREEN

Medium sea green color.

const MEDIUM_SEA_GREEN = Color(0.235294, 0.701961, 0.443137, 1)

MEDIUM_SLATE_BLUE

Medium slate blue color.

const MEDIUM_SLATE_BLUE = Color(0.482353, 0.407843, 0.933333, 1)

MEDIUM_SPRING_GREEN

Medium spring green color.

const MEDIUM_SPRING_GREEN = Color(0, 0.980392, 0.603922, 1)

MEDIUM_TURQUOISE

Medium turquoise color.

const MEDIUM_TURQUOISE = Color(0.282353, 0.819608, 0.8, 1)

MEDIUM_VIOLET_RED

Medium violet red color.

const MEDIUM_VIOLET_RED = Color(0.780392, 0.0823529, 0.521569, 1)

MIDNIGHT_BLUE

Midnight blue color.

const MIDNIGHT_BLUE = Color(0.0980392, 0.0980392, 0.439216, 1)

MINT_CREAM

Mint cream color.

const MINT_CREAM = Color(0.960784, 1, 0.980392, 1)

MISTY_ROSE

Misty rose color.

const MISTY_ROSE = Color(1, 0.894118, 0.882353, 1)

MOCCASIN

Moccasin color.

const MOCCASIN = Color(1, 0.894118, 0.709804, 1)

NAVAJO_WHITE

Navajo white color.

const NAVAJO_WHITE = Color(1, 0.870588, 0.678431, 1)

NAVY_BLUE

Navy blue color.

const NAVY_BLUE = Color(0, 0, 0.501961, 1)

OLD_LACE

Old lace color.

const OLD_LACE = Color(0.992157, 0.960784, 0.901961, 1)

OLIVE

Olive color.

const OLIVE = Color(0.501961, 0.501961, 0, 1)

OLIVE_DRAB

Olive drab color.

const OLIVE_DRAB = Color(0.419608, 0.556863, 0.137255, 1)

ORANGE

Orange color.

const ORANGE = Color(1, 0.647059, 0, 1)

ORANGE_RED

Orange red color.

const ORANGE_RED = Color(1, 0.270588, 0, 1)

ORCHID

Orchid color.

const ORCHID = Color(0.854902, 0.439216, 0.839216, 1)

PALE_GOLDENROD

Pale goldenrod color.

const PALE_GOLDENROD = Color(0.933333, 0.909804, 0.666667, 1)

PALE_GREEN

Pale green color.

const PALE_GREEN = Color(0.596078, 0.984314, 0.596078, 1)

PALE_TURQUOISE

Pale turquoise color.

const PALE_TURQUOISE = Color(0.686275, 0.933333, 0.933333, 1)

PALE_VIOLET_RED

Pale violet red color.

const PALE_VIOLET_RED = Color(0.858824, 0.439216, 0.576471, 1)

PAPAYA_WHIP

Papaya whip color.

const PAPAYA_WHIP = Color(1, 0.937255, 0.835294, 1)

PEACH_PUFF

Peach puff color.

const PEACH_PUFF = Color(1, 0.854902, 0.72549, 1)

PERU

Peru color.

const PERU = Color(0.803922, 0.521569, 0.247059, 1)

PINK

Pink color.

const PINK = Color(1, 0.752941, 0.796078, 1)

PLUM

Plum color.

const PLUM = Color(0.866667, 0.627451, 0.866667, 1)

POWDER_BLUE

Powder blue color.

const POWDER_BLUE = Color(0.690196, 0.878431, 0.901961, 1)

PURPLE

Purple color.

const PURPLE = Color(0.627451, 0.12549, 0.941176, 1)

REBECCA_PURPLE

Rebecca purple color.

const REBECCA_PURPLE = Color(0.4, 0.2, 0.6, 1)

RED

Red color.

const RED = Color(1, 0, 0, 1)

ROSY_BROWN

Rosy brown color.

const ROSY_BROWN = Color(0.737255, 0.560784, 0.560784, 1)

ROYAL_BLUE

Royal blue color.

const ROYAL_BLUE = Color(0.254902, 0.411765, 0.882353, 1)

SADDLE_BROWN

Saddle brown color.

const SADDLE_BROWN = Color(0.545098, 0.270588, 0.0745098, 1)

SALMON

Salmon color.

const SALMON = Color(0.980392, 0.501961, 0.447059, 1)

SANDY_BROWN

Sandy brown color.

const SANDY_BROWN = Color(0.956863, 0.643137, 0.376471, 1)

SEA_GREEN

Sea green color.

const SEA_GREEN = Color(0.180392, 0.545098, 0.341176, 1)

SEASHELL

Seashell color.

const SEASHELL = Color(1, 0.960784, 0.933333, 1)

SIENNA

Sienna color.

const SIENNA = Color(0.627451, 0.321569, 0.176471, 1)

SILVER

Silver color.

const SILVER = Color(0.752941, 0.752941, 0.752941, 1)

SKY_BLUE

Sky blue color.

const SKY_BLUE = Color(0.529412, 0.807843, 0.921569, 1)

SLATE_BLUE

Slate blue color.

const SLATE_BLUE = Color(0.415686, 0.352941, 0.803922, 1)

SLATE_GRAY

Slate gray color.

const SLATE_GRAY = Color(0.439216, 0.501961, 0.564706, 1)

SNOW

Snow color.

const SNOW = Color(1, 0.980392, 0.980392, 1)

SPRING_GREEN

Spring green color.

const SPRING_GREEN = Color(0, 1, 0.498039, 1)

STEEL_BLUE

Steel blue color.

const STEEL_BLUE = Color(0.27451, 0.509804, 0.705882, 1)

TAN

Tan color.

const TAN = Color(0.823529, 0.705882, 0.54902, 1)

TEAL

Teal color.

const TEAL = Color(0, 0.501961, 0.501961, 1)

THISTLE

Thistle color.

const THISTLE = Color(0.847059, 0.74902, 0.847059, 1)

TOMATO

Tomato color.

const TOMATO = Color(1, 0.388235, 0.278431, 1)

TRANSPARENT

Transparent color (white with zero alpha).

const TRANSPARENT = Color(1, 1, 1, 0)

TURQUOISE

Turquoise color.

const TURQUOISE = Color(0.25098, 0.878431, 0.815686, 1)

VIOLET

Violet color.

const VIOLET = Color(0.933333, 0.509804, 0.933333, 1)

WEB_GRAY

Web gray color.

const WEB_GRAY = Color(0.501961, 0.501961, 0.501961, 1)

WEB_GREEN

Web green color.

const WEB_GREEN = Color(0, 0.501961, 0, 1)

WEB_MAROON

Web maroon color.

const WEB_MAROON = Color(0.501961, 0, 0, 1)

WEB_PURPLE

Web purple color.

const WEB_PURPLE = Color(0.501961, 0, 0.501961, 1)

WHEAT

Wheat color.

const WHEAT = Color(0.960784, 0.870588, 0.701961, 1)

WHITE

White color.

const WHITE = Color(1, 1, 1, 1)

WHITE_SMOKE

White smoke color.

const WHITE_SMOKE = Color(0.960784, 0.960784, 0.960784, 1)

YELLOW

Yellow color.

const YELLOW = Color(1, 1, 0, 1)

YELLOW_GREEN

Yellow green color.

const YELLOW_GREEN = Color(0.603922, 0.803922, 0.196078, 1)

Properties

a

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.

var a : float = 1.0

Property Value

float

a8

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

var a8 : int = 255

Property Value

int

b

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

var b : float = 0.0

Property Value

float

b8

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

var b8 : int = 0

Property Value

int

g

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

var g : float = 0.0

Property Value

float

g8

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

var g8 : int = 0

Property Value

int

h

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

var h : float = 0.0

Property Value

float

ok_hsl_h

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

var ok_hsl_h : float = 0.0

Property Value

float

ok_hsl_l

The OKHSL lightness of this color, on the range 0 to 1.

var ok_hsl_l : float = 0.0

Property Value

float

ok_hsl_s

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

var ok_hsl_s : float = 0.0

Property Value

float

r

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

var r : float = 0.0

Property Value

float

r8

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

var r8 : int = 0

Property Value

int

s

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

var s : float = 0.0

Property Value

float

v

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

var v : float = 0.0

Property Value

float

Methods

blend(Color)

Qualifiers: const

Returns a new color resulting from overlaying this color over the given color. In a painting program, you can imagine it as the over color painted over this color (including alpha).

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 blend(Color over)

Parameters

over Color

clamp(Color, Color)

Qualifiers: const

Returns a new color with all components clamped between the components of min and max, by running @GlobalScope.clamp on each component.

Color clamp(Color min, Color max)

Parameters

min Color
max Color

darkened(float)

Qualifiers: const

Returns a new color resulting from making this color darker by the specified amount (ratio from 0.0 to 1.0). See also Color.lightened.

var green = Color(0.0, 1.0, 0.0)
var darkgreen = green.darkened(0.2) # 20% darker than regular green


Color darkened(float amount)

Parameters

amount float

from_hsv(float, float, float, float)

Qualifiers: static

Constructs a color from an HSV profile. The hue (h), saturation (s), and value (v) are typically between 0.0 and 1.0.

var color = Color.from_hsv(0.58, 0.5, 0.79, 0.8)


Color from_hsv(float h, float s, float v, float alpha)

Parameters

h float
s float
v float
alpha float

from_ok_hsl(float, float, float, float)

Qualifiers: static

Constructs a color from an OK HSL profile. The hue (h), saturation (s), and lightness (l) are typically between 0.0 and 1.0.

var color = Color.from_ok_hsl(0.58, 0.5, 0.79, 0.8)


Color from_ok_hsl(float h, float s, float l, float alpha)

Parameters

h float
s float
l float
alpha float

from_rgba8(int, int, int, int)

Qualifiers: static

Returns a Color constructed from red (r8), green (g8), blue (b8), and optionally alpha (a8) integer channels, each divided by 255.0 for their final value.

var red = Color.from_rgba8(255, 0, 0)             # Same as Color(1, 0, 0).
var dark_blue = Color.from_rgba8(0, 0, 51)        # Same as Color(0, 0, 0.2).
var my_color = Color.from_rgba8(306, 255, 0, 102) # Same as Color(1.2, 1, 0, 0.4).

Note: Due to the lower precision of Color.from_rgba8 compared to the standard Color constructor, a color created with Color.from_rgba8 will generally not be equal to the same color created with the standard Color constructor. Use Color.is_equal_approx for comparisons to avoid issues with floating-point precision error.

Color from_rgba8(int r8, int g8, int b8, int a8)

Parameters

r8 int
g8 int
b8 int
a8 int

from_rgbe9995(int)

Qualifiers: static

Decodes a Color from an RGBE9995 format integer. See Image.FORMAT_RGBE9995.

Color from_rgbe9995(int rgbe)

Parameters

rgbe int

from_string(String, Color)

Qualifiers: static

Creates a Color from the given string, which can be either an HTML color code or a named color (case-insensitive). Returns default if the color cannot be inferred from the string.

If you want to create a color from String in a constant expression, use the equivalent constructor instead (i.e. Color("color string")).

Color from_string(String str, Color default)

Parameters

str String
default Color

get_luminance

Qualifiers: const

Returns the light intensity of the color, as a value between 0.0 and 1.0 (inclusive). This is useful when determining light or dark color. Colors with a luminance smaller than 0.5 can be generally considered dark.

Note: get_luminance relies on the color being in the linear color space to return an accurate relative luminance value. If the color is in the sRGB color space, use srgb_to_linear to convert it to the linear color space first.

float get_luminance

hex(int)

Qualifiers: static

Returns the Color associated with the provided hex integer in 32-bit RGBA format (8 bits per channel). This method is the inverse of to_rgba32.

In GDScript and C#, the int is best visualized with hexadecimal notation ("0x" prefix, making it "0xRRGGBBAA").

var red = Color.hex(0xff0000ff)
var dark_cyan = Color.hex(0x008b8bff)
var my_color = Color.hex(0xbbefd2a4)

If you want to use hex notation in a constant expression, use the equivalent constructor instead (i.e. Color(0xRRGGBBAA)).

Color hex(int hex)

Parameters

hex int

hex64(int)

Qualifiers: static

Returns the Color associated with the provided hex integer in 64-bit RGBA format (16 bits per channel). This method is the inverse of to_rgba64.

In GDScript and C#, the int is best visualized with hexadecimal notation ("0x" prefix, making it "0xRRRRGGGGBBBBAAAA").

Color hex64(int hex)

Parameters

hex int

html(String)

Qualifiers: static

Returns a new color from rgba, an HTML hexadecimal color string. rgba is not case-sensitive, and may be prefixed by a hash sign (#).

rgba must be a valid three-digit or six-digit hexadecimal color string, and may contain an alpha channel value. If rgba does not contain an alpha channel value, an alpha channel value of 1.0 is applied. If rgba is invalid, returns an empty color.

var blue = Color.html("#0000ff") # blue is Color(0.0, 0.0, 1.0, 1.0)
var green = Color.html("#0F0")   # green is Color(0.0, 1.0, 0.0, 1.0)
var col = Color.html("663399cc") # col is Color(0.4, 0.2, 0.6, 0.8)


Color html(String rgba)

Parameters

rgba String

html_is_valid(String)

Qualifiers: static

Returns true if color is a valid HTML hexadecimal color string. The string must be a hexadecimal value (case-insensitive) of either 3, 4, 6 or 8 digits, and may be prefixed by a hash sign (#). This method is identical to is_valid_html_color.

Color.html_is_valid("#55aaFF")   # Returns true
Color.html_is_valid("#55AAFF20") # Returns true
Color.html_is_valid("55AAFF")    # Returns true
Color.html_is_valid("#F2C")      # Returns true

Color.html_is_valid("#AABBC")    # Returns false
Color.html_is_valid("#55aaFF5")  # Returns false


bool html_is_valid(String color)

Parameters

color String

inverted

Qualifiers: const

Returns the color with its r, g, and b components inverted ((1 - r, 1 - g, 1 - b, a)).

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


Color inverted

is_equal_approx(Color)

Qualifiers: const

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

bool is_equal_approx(Color to)

Parameters

to Color

lerp(Color, float)

Qualifiers: const

Returns the linear interpolation between this color's components and to's components. The interpolation factor weight should be between 0.0 and 1.0 (inclusive). See also @GlobalScope.lerp.

var red = Color(1.0, 0.0, 0.0)
var aqua = Color(0.0, 1.0, 0.8)

red.lerp(aqua, 0.2) # Returns Color(0.8, 0.2, 0.16)
red.lerp(aqua, 0.5) # Returns Color(0.5, 0.5, 0.4)
red.lerp(aqua, 1.0) # Returns Color(0.0, 1.0, 0.8)


Color lerp(Color to, float weight)

Parameters

to Color
weight float

lightened(float)

Qualifiers: const

Returns a new color resulting from making this color lighter by the specified amount, which should be a ratio from 0.0 to 1.0. See also Color.darkened.

var green = Color(0.0, 1.0, 0.0)
var light_green = green.lightened(0.2) # 20% lighter than regular green


Color lightened(float amount)

Parameters

amount float

linear_to_srgb

Qualifiers: const

Returns the color converted to the sRGB color space. This method assumes the original color is in the linear color space. See also srgb_to_linear which performs the opposite operation.

Color linear_to_srgb

srgb_to_linear

Qualifiers: const

Returns the color converted to the linear color space. This method assumes the original color already is in the sRGB color space. See also linear_to_srgb which performs the opposite operation.

Color srgb_to_linear

to_abgr32

Qualifiers: const

Returns the color converted to a 32-bit integer in ABGR format (each component is 8 bits). ABGR is the reversed version of the default RGBA format.

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


int to_abgr32

to_abgr64

Qualifiers: const

Returns the color converted to a 64-bit integer in ABGR format (each component is 16 bits). ABGR is the reversed version of the default RGBA format.

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


int to_abgr64

to_argb32

Qualifiers: const

Returns the color converted to a 32-bit integer in ARGB format (each component is 8 bits). ARGB is more compatible with DirectX.

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


int to_argb32

to_argb64

Qualifiers: const

Returns the color converted to a 64-bit integer in ARGB format (each component is 16 bits). ARGB is more compatible with DirectX.

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


int to_argb64

to_html(bool)

Qualifiers: const

Returns the color converted to an HTML hexadecimal color String in RGBA format, without the hash (#) prefix.

Setting with_alpha to false, excludes alpha from the hexadecimal string, using RGB format instead of RGBA format.

var white = Color(1, 1, 1, 0.5)
var with_alpha = white.to_html() # Returns "ffffff7f"
var without_alpha = white.to_html(false) # Returns "ffffff"


String to_html(bool with_alpha)

Parameters

with_alpha bool

to_rgba32

Qualifiers: const

Returns the color converted to a 32-bit integer in RGBA format (each component is 8 bits). RGBA is Godot's default format. This method is the inverse of Color.hex.

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


int to_rgba32

to_rgba64

Qualifiers: const

Returns the color converted to a 64-bit integer in RGBA format (each component is 16 bits). RGBA is Godot's default format. This method is the inverse of Color.hex64.

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


int to_rgba64

Operators

!= (Color)

Returns true if the colors are not exactly equal.

Note: Due to floating-point precision errors, consider using Color.is_equal_approx instead, which is more reliable.

bool != (Color right)

Parameters

right Color

* (Color)

Multiplies each component of the Color by the components of the given Color.

Color * (Color right)

Parameters

right Color

* (float)

Multiplies each component of the Color by the given float.

Color * (float right)

Parameters

right float

* (int)

Multiplies each component of the Color by the given int.

Color * (int right)

Parameters

right int

+ (Color)

Adds each component of the Color with the components of the given Color.

Color + (Color right)

Parameters

right Color

- (Color)

Subtracts each component of the Color by the components of the given Color.

Color - (Color right)

Parameters

right Color

/ (Color)

Divides each component of the Color by the components of the given Color.

Color / (Color right)

Parameters

right Color

/ (float)

Divides each component of the Color by the given float.

Color / (float right)

Parameters

right float

/ (int)

Divides each component of the Color by the given int.

Color / (int right)

Parameters

right int

== (Color)

Returns true if the colors are exactly equal.

Note: Due to floating-point precision errors, consider using Color.is_equal_approx instead, which is more reliable.

bool == (Color right)

Parameters

right Color

[] (int)

Access color components using their index. [0] is equivalent to r, [1] is equivalent to g, [2] is equivalent to b, and [3] is equivalent to a.

float [] (int index)

Parameters

index int

unary+

Returns the same value as if the + was not there. Unary + does nothing, but sometimes it can make your code more readable.

Color unary+

unary-

Inverts the given color. This is equivalent to Color.WHITE - c or Color(1 - c.r, 1 - c.g, 1 - c.b, 1 - c.a). Unlike with inverted, the a component is inverted, too.

Color unary-