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 transparency. 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 the string constructor 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

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 ( ) constructor

Color

Color ( Color from ) constructor

Color

Color ( Color from, float alpha ) constructor

Color

Color ( String code ) constructor

Color

Color ( String code, float alpha ) constructor

Color

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

Color

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

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

int

find_named_color ( String name ) static

Color

from_rgbe9995 ( int rgbe ) static

Color

from_string ( String str, Color default ) static

Color

get_named_color ( int idx ) static

int

get_named_color_count ( ) static

String

get_named_color_name ( int idx ) static

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

bool

operator != ( ) operator

bool

operator != ( Color right ) operator

Color

operator * ( Color right ) operator

Color

operator * ( float right ) operator

Color

operator * ( int right ) operator

Color

operator + ( Color right ) operator

Color

operator - ( Color right ) operator

Color

operator / ( Color right ) operator

Color

operator / ( float right ) operator

Color

operator / ( int right ) operator

bool

operator == ( ) operator

bool

operator == ( Color right ) operator

float

operator [] ( int index ) operator

Color

operator unary+ ( ) operator

Color

operator unary- ( ) operator

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

Constants

  • ALICE_BLUE = Color(0.94, 0.97, 1, 1) --- Alice blue color.

  • ANTIQUE_WHITE = Color(0.98, 0.92, 0.84, 1) --- Antique white color.

  • AQUA = Color(0, 1, 1, 1) --- Aqua color.

  • AQUAMARINE = Color(0.5, 1, 0.83, 1) --- Aquamarine color.

  • AZURE = Color(0.94, 1, 1, 1) --- Azure color.

  • BEIGE = Color(0.96, 0.96, 0.86, 1) --- Beige color.

  • BISQUE = Color(1, 0.89, 0.77, 1) --- Bisque color.

  • BLACK = Color(0, 0, 0, 1) --- Black color.

  • BLANCHED_ALMOND = Color(1, 0.92, 0.8, 1) --- Blanched almond color.

  • BLUE = Color(0, 0, 1, 1) --- Blue color.

  • BLUE_VIOLET = Color(0.54, 0.17, 0.89, 1) --- Blue violet color.

  • BROWN = Color(0.65, 0.16, 0.16, 1) --- Brown color.

  • BURLYWOOD = Color(0.87, 0.72, 0.53, 1) --- Burlywood color.

  • CADET_BLUE = Color(0.37, 0.62, 0.63, 1) --- Cadet blue color.

  • CHARTREUSE = Color(0.5, 1, 0, 1) --- Chartreuse color.

  • CHOCOLATE = Color(0.82, 0.41, 0.12, 1) --- Chocolate color.

  • CORAL = Color(1, 0.5, 0.31, 1) --- Coral color.

  • CORNFLOWER_BLUE = Color(0.39, 0.58, 0.93, 1) --- Cornflower blue color.

  • CORNSILK = Color(1, 0.97, 0.86, 1) --- Cornsilk color.

  • CRIMSON = Color(0.86, 0.08, 0.24, 1) --- Crimson color.

  • CYAN = Color(0, 1, 1, 1) --- Cyan color.

  • DARK_BLUE = Color(0, 0, 0.55, 1) --- Dark blue color.

  • DARK_CYAN = Color(0, 0.55, 0.55, 1) --- Dark cyan color.

  • DARK_GOLDENROD = Color(0.72, 0.53, 0.04, 1) --- Dark goldenrod color.

  • DARK_GRAY = Color(0.66, 0.66, 0.66, 1) --- Dark gray color.

  • DARK_GREEN = Color(0, 0.39, 0, 1) --- Dark green color.

  • DARK_KHAKI = Color(0.74, 0.72, 0.42, 1) --- Dark khaki color.

  • DARK_MAGENTA = Color(0.55, 0, 0.55, 1) --- Dark magenta color.

  • DARK_OLIVE_GREEN = Color(0.33, 0.42, 0.18, 1) --- Dark olive green color.

  • DARK_ORANGE = Color(1, 0.55, 0, 1) --- Dark orange color.

  • DARK_ORCHID = Color(0.6, 0.2, 0.8, 1) --- Dark orchid color.

  • DARK_RED = Color(0.55, 0, 0, 1) --- Dark red color.

  • DARK_SALMON = Color(0.91, 0.59, 0.48, 1) --- Dark salmon color.

  • DARK_SEA_GREEN = Color(0.56, 0.74, 0.56, 1) --- Dark sea green color.

  • DARK_SLATE_BLUE = Color(0.28, 0.24, 0.55, 1) --- Dark slate blue color.

  • DARK_SLATE_GRAY = Color(0.18, 0.31, 0.31, 1) --- Dark slate gray color.

  • DARK_TURQUOISE = Color(0, 0.81, 0.82, 1) --- Dark turquoise color.

  • DARK_VIOLET = Color(0.58, 0, 0.83, 1) --- Dark violet color.

  • DEEP_PINK = Color(1, 0.08, 0.58, 1) --- Deep pink color.

  • DEEP_SKY_BLUE = Color(0, 0.75, 1, 1) --- Deep sky blue color.

  • DIM_GRAY = Color(0.41, 0.41, 0.41, 1) --- Dim gray color.

  • DODGER_BLUE = Color(0.12, 0.56, 1, 1) --- Dodger blue color.

  • FIREBRICK = Color(0.7, 0.13, 0.13, 1) --- Firebrick color.

  • FLORAL_WHITE = Color(1, 0.98, 0.94, 1) --- Floral white color.

  • FOREST_GREEN = Color(0.13, 0.55, 0.13, 1) --- Forest green color.

  • FUCHSIA = Color(1, 0, 1, 1) --- Fuchsia color.

  • GAINSBORO = Color(0.86, 0.86, 0.86, 1) --- Gainsboro color.

  • GHOST_WHITE = Color(0.97, 0.97, 1, 1) --- Ghost white color.

  • GOLD = Color(1, 0.84, 0, 1) --- Gold color.

  • GOLDENROD = Color(0.85, 0.65, 0.13, 1) --- Goldenrod color.

  • GRAY = Color(0.75, 0.75, 0.75, 1) --- Gray color.

  • GREEN = Color(0, 1, 0, 1) --- Green color.

  • GREEN_YELLOW = Color(0.68, 1, 0.18, 1) --- Green yellow color.

  • HONEYDEW = Color(0.94, 1, 0.94, 1) --- Honeydew color.

  • HOT_PINK = Color(1, 0.41, 0.71, 1) --- Hot pink color.

  • INDIAN_RED = Color(0.8, 0.36, 0.36, 1) --- Indian red color.

  • INDIGO = Color(0.29, 0, 0.51, 1) --- Indigo color.

  • IVORY = Color(1, 1, 0.94, 1) --- Ivory color.

  • KHAKI = Color(0.94, 0.9, 0.55, 1) --- Khaki color.

  • LAVENDER = Color(0.9, 0.9, 0.98, 1) --- Lavender color.

  • LAVENDER_BLUSH = Color(1, 0.94, 0.96, 1) --- Lavender blush color.

  • LAWN_GREEN = Color(0.49, 0.99, 0, 1) --- Lawn green color.

  • LEMON_CHIFFON = Color(1, 0.98, 0.8, 1) --- Lemon chiffon color.

  • LIGHT_BLUE = Color(0.68, 0.85, 0.9, 1) --- Light blue color.

  • LIGHT_CORAL = Color(0.94, 0.5, 0.5, 1) --- Light coral color.

  • LIGHT_CYAN = Color(0.88, 1, 1, 1) --- Light cyan color.

  • LIGHT_GOLDENROD = Color(0.98, 0.98, 0.82, 1) --- Light goldenrod color.

  • LIGHT_GRAY = Color(0.83, 0.83, 0.83, 1) --- Light gray color.

  • LIGHT_GREEN = Color(0.56, 0.93, 0.56, 1) --- Light green color.

  • LIGHT_PINK = Color(1, 0.71, 0.76, 1) --- Light pink color.

  • LIGHT_SALMON = Color(1, 0.63, 0.48, 1) --- Light salmon color.

  • LIGHT_SEA_GREEN = Color(0.13, 0.7, 0.67, 1) --- Light sea green color.

  • LIGHT_SKY_BLUE = Color(0.53, 0.81, 0.98, 1) --- Light sky blue color.

  • LIGHT_SLATE_GRAY = Color(0.47, 0.53, 0.6, 1) --- Light slate gray color.

  • LIGHT_STEEL_BLUE = Color(0.69, 0.77, 0.87, 1) --- Light steel blue color.

  • LIGHT_YELLOW = Color(1, 1, 0.88, 1) --- Light yellow color.

  • LIME = Color(0, 1, 0, 1) --- Lime color.

  • LIME_GREEN = Color(0.2, 0.8, 0.2, 1) --- Lime green color.

  • LINEN = Color(0.98, 0.94, 0.9, 1) --- Linen color.

  • MAGENTA = Color(1, 0, 1, 1) --- Magenta color.

  • MAROON = Color(0.69, 0.19, 0.38, 1) --- Maroon color.

  • MEDIUM_AQUAMARINE = Color(0.4, 0.8, 0.67, 1) --- Medium aquamarine color.

  • MEDIUM_BLUE = Color(0, 0, 0.8, 1) --- Medium blue color.

  • MEDIUM_ORCHID = Color(0.73, 0.33, 0.83, 1) --- Medium orchid color.

  • MEDIUM_PURPLE = Color(0.58, 0.44, 0.86, 1) --- Medium purple color.

  • MEDIUM_SEA_GREEN = Color(0.24, 0.7, 0.44, 1) --- Medium sea green color.

  • MEDIUM_SLATE_BLUE = Color(0.48, 0.41, 0.93, 1) --- Medium slate blue color.

  • MEDIUM_SPRING_GREEN = Color(0, 0.98, 0.6, 1) --- Medium spring green color.

  • MEDIUM_TURQUOISE = Color(0.28, 0.82, 0.8, 1) --- Medium turquoise color.

  • MEDIUM_VIOLET_RED = Color(0.78, 0.08, 0.52, 1) --- Medium violet red color.

  • MIDNIGHT_BLUE = Color(0.1, 0.1, 0.44, 1) --- Midnight blue color.

  • MINT_CREAM = Color(0.96, 1, 0.98, 1) --- Mint cream color.

  • MISTY_ROSE = Color(1, 0.89, 0.88, 1) --- Misty rose color.

  • MOCCASIN = Color(1, 0.89, 0.71, 1) --- Moccasin color.

  • NAVAJO_WHITE = Color(1, 0.87, 0.68, 1) --- Navajo white color.

  • NAVY_BLUE = Color(0, 0, 0.5, 1) --- Navy blue color.

  • OLD_LACE = Color(0.99, 0.96, 0.9, 1) --- Old lace color.

  • OLIVE = Color(0.5, 0.5, 0, 1) --- Olive color.

  • OLIVE_DRAB = Color(0.42, 0.56, 0.14, 1) --- Olive drab color.

  • ORANGE = Color(1, 0.65, 0, 1) --- Orange color.

  • ORANGE_RED = Color(1, 0.27, 0, 1) --- Orange red color.

  • ORCHID = Color(0.85, 0.44, 0.84, 1) --- Orchid color.

  • PALE_GOLDENROD = Color(0.93, 0.91, 0.67, 1) --- Pale goldenrod color.

  • PALE_GREEN = Color(0.6, 0.98, 0.6, 1) --- Pale green color.

  • PALE_TURQUOISE = Color(0.69, 0.93, 0.93, 1) --- Pale turquoise color.

  • PALE_VIOLET_RED = Color(0.86, 0.44, 0.58, 1) --- Pale violet red color.

  • PAPAYA_WHIP = Color(1, 0.94, 0.84, 1) --- Papaya whip color.

  • PEACH_PUFF = Color(1, 0.85, 0.73, 1) --- Peach puff color.

  • PERU = Color(0.8, 0.52, 0.25, 1) --- Peru color.

  • PINK = Color(1, 0.75, 0.8, 1) --- Pink color.

  • PLUM = Color(0.87, 0.63, 0.87, 1) --- Plum color.

  • POWDER_BLUE = Color(0.69, 0.88, 0.9, 1) --- Powder blue color.

  • PURPLE = Color(0.63, 0.13, 0.94, 1) --- Purple color.

  • REBECCA_PURPLE = Color(0.4, 0.2, 0.6, 1) --- Rebecca purple color.

  • RED = Color(1, 0, 0, 1) --- Red color.

  • ROSY_BROWN = Color(0.74, 0.56, 0.56, 1) --- Rosy brown color.

  • ROYAL_BLUE = Color(0.25, 0.41, 0.88, 1) --- Royal blue color.

  • SADDLE_BROWN = Color(0.55, 0.27, 0.07, 1) --- Saddle brown color.

  • SALMON = Color(0.98, 0.5, 0.45, 1) --- Salmon color.

  • SANDY_BROWN = Color(0.96, 0.64, 0.38, 1) --- Sandy brown color.

  • SEA_GREEN = Color(0.18, 0.55, 0.34, 1) --- Sea green color.

  • SEASHELL = Color(1, 0.96, 0.93, 1) --- Seashell color.

  • SIENNA = Color(0.63, 0.32, 0.18, 1) --- Sienna color.

  • SILVER = Color(0.75, 0.75, 0.75, 1) --- Silver color.

  • SKY_BLUE = Color(0.53, 0.81, 0.92, 1) --- Sky blue color.

  • SLATE_BLUE = Color(0.42, 0.35, 0.8, 1) --- Slate blue color.

  • SLATE_GRAY = Color(0.44, 0.5, 0.56, 1) --- Slate gray color.

  • SNOW = Color(1, 0.98, 0.98, 1) --- Snow color.

  • SPRING_GREEN = Color(0, 1, 0.5, 1) --- Spring green color.

  • STEEL_BLUE = Color(0.27, 0.51, 0.71, 1) --- Steel blue color.

  • TAN = Color(0.82, 0.71, 0.55, 1) --- Tan color.

  • TEAL = Color(0, 0.5, 0.5, 1) --- Teal color.

  • THISTLE = Color(0.85, 0.75, 0.85, 1) --- Thistle color.

  • TOMATO = Color(1, 0.39, 0.28, 1) --- Tomato color.

  • TRANSPARENT = Color(1, 1, 1, 0) --- Transparent color (white with zero alpha).

  • TURQUOISE = Color(0.25, 0.88, 0.82, 1) --- Turquoise color.

  • VIOLET = Color(0.93, 0.51, 0.93, 1) --- Violet color.

  • WEB_GRAY = Color(0.5, 0.5, 0.5, 1) --- Web gray color.

  • WEB_GREEN = Color(0, 0.5, 0, 1) --- Web green color.

  • WEB_MAROON = Color(0.5, 0, 0, 1) --- Web maroon color.

  • WEB_PURPLE = Color(0.5, 0, 0.5, 1) --- Web purple color.

  • WHEAT = Color(0.96, 0.87, 0.7, 1) --- Wheat color.

  • WHITE = Color(1, 1, 1, 1) --- White color.

  • WHITE_SMOKE = Color(0.96, 0.96, 0.96, 1) --- White smoke color.

  • YELLOW = Color(1, 1, 0, 1) --- Yellow color.

  • YELLOW_GREEN = Color(0.6, 0.8, 0.2, 1) --- Yellow green color.

Property Descriptions

Default

1.0

The color's alpha (transparency) component, typically on the range of 0 to 1.


Default

255

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


Default

0.0

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


Default

0

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


Default

0.0

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


Default

0

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


Default

0.0

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


Default

0.0

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


Default

0

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


Default

0.0

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


Default

0.0

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

Method Descriptions

  • Color Color ( ) constructor

Constructs a default-initialized Color with all components set to 0.


Constructs a Color as a copy of the given Color.


Constructs a Color from an existing color, but with a custom alpha value.

var red = Color(Color.red, 0.5) # 50% transparent red.

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


Constructs a Color either from an HTML color code or from a standardized color name, with alpha on the range of 0 to 1. Supported color names are the same as the constants.


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)`

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)`

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 clamp ( Color min=Color(0, 0, 0, 0), Color max=Color(1, 1, 1, 1) ) const

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


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

  • int find_named_color ( String name ) static


  • Color from_rgbe9995 ( int rgbe ) static



  • Color get_named_color ( int idx ) static


  • int get_named_color_count ( ) static


  • String get_named_color_name ( int idx ) static






  • Color inverted ( ) const

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)`

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


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 lerp_color = c1.lerp(c2, 0.5) # Equivalent to `Color(0.5, 0.5, 0.0)`

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

  • bool operator != ( ) operator





  • Color operator * ( int right ) operator






  • Color operator / ( int right ) operator


  • bool operator == ( ) operator



  • float operator [] ( int index ) operator


  • Color operator unary+ ( ) operator


  • Color operator unary- ( ) operator


  • int to_abgr32 ( ) const

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 ( ) const

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 ( ) const

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 ( ) const

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

Returns the color converted to an HTML hexadecimal color string in RGBA format (ex: ff34f822).

Setting with_alpha to false excludes alpha from the hexadecimal string (and uses RGB instead of RGBA format).

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

  • int to_rgba32 ( ) const

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 ( ) const

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