Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Color

A color represented in RGBA format.

Description

A color represented in RGBA format by a red (r), green (g), blue (b), and alpha (a) component. Each component is a 16-bit floating-point value, usually ranging from 0.0 to 1.0. Some properties (such as CanvasItem.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 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

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

Constructors

Color

Color ( )

Color

Color ( Color from, float alpha )

Color

Color ( Color from )

Color

Color ( String code )

Color

Color ( String code, float alpha )

Color

Color ( float r, float g, float b )

Color

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

Methods

Color

blend ( Color over ) const

Color

clamp ( Color min=Color(0, 0, 0, 0), Color max=Color(1, 1, 1, 1) ) const

Color

darkened ( float amount ) const

Color

from_hsv ( float h, float s, float v, float alpha=1.0 ) static

Color

from_ok_hsl ( float h, float s, float l, float alpha=1.0 ) static

Color

from_rgbe9995 ( int rgbe ) static

Color

from_string ( String str, Color default ) static

float

get_luminance ( ) const

Color

hex ( int hex ) static

Color

hex64 ( int hex ) static

Color

html ( String rgba ) static

bool

html_is_valid ( String color ) static

Color

inverted ( ) const

bool

is_equal_approx ( Color to ) const

Color

lerp ( Color to, float weight ) const

Color

lightened ( float amount ) const

Color

linear_to_srgb ( ) const

Color

srgb_to_linear ( ) const

int

to_abgr32 ( ) const

int

to_abgr64 ( ) const

int

to_argb32 ( ) const

int

to_argb64 ( ) const

String

to_html ( bool with_alpha=true ) const

int

to_rgba32 ( ) const

int

to_rgba64 ( ) const

Operators

bool

operator != ( Color right )

Color

operator * ( Color right )

Color

operator * ( float right )

Color

operator * ( int right )

Color

operator + ( Color right )

Color

operator - ( Color right )

Color

operator / ( Color right )

Color

operator / ( float right )

Color

operator / ( int right )

bool

operator == ( Color right )

float

operator [] ( int index )

Color

operator unary+ ( )

Color

operator unary- ( )


Constants

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

Alice blue color.

ANTIQUE_WHITE = 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. In GDScript, this is the default value of any color.

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

Blanched almond color.

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

Blue color.

BLUE_VIOLET = 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)

Burlywood color.

CADET_BLUE = 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_BLUE = Color(0.392157, 0.584314, 0.929412, 1)

Cornflower blue color.

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

Cornsilk color.

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

Crimson color.

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

Cyan color.

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

Dark blue color.

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

Dark cyan color.

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

Dark goldenrod color.

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

Dark gray color.

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

Dark green color.

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

Dark khaki color.

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

Dark magenta color.

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

Dark olive green color.

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

Dark orange color.

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

Dark orchid color.

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

Dark red color.

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

Dark salmon color.

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

Dark sea green color.

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

Dark slate blue color.

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

Dark slate gray color.

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

Dark turquoise color.

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

Dark violet color.

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

Deep pink color.

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

Deep sky blue color.