Struct Color

Representation of the RGBA color.

Assembly: FlaxEngine.dll

File: Engine/Core/Math/Color.h

Syntax

public struct Color

Constructors

Color()

Empty constructor.

Declaration

public Color() = default

Color(const Color& rgb, float a)

Initializes a new instance of the Color struct.

Declaration

public Color(const Color& rgb, float a)

Parameters

Color rgb The red, green and blue channels value.

float a The alpha channel value.

Color(const Color32& color)

Initializes a new instance of the Color struct.

Declaration

public Color(const Color32& color)

Parameters

Color32 color The other color (32-bit RGBA).

Color(const Float3& rgb, float a)

Initializes a new instance of the Color struct.

Declaration

public Color(const Float3& rgb, float a)

Parameters

Float3 rgb The red, green and blue channels value.

float a The alpha channel value.

Color(const Float4& rgba)

Initializes a new instance of the Color struct.

Declaration

public Color(const Float4& rgba)

Parameters

Float4 rgba The red, green, blue and alpha channels value.

Color(float rgba)

Initializes a new instance of the Color struct.

Declaration

public Color(float rgba)

Parameters

float rgba The RGBA channels value.

Fields

A

The alpha channel value.

Declaration

public float A

Field Value

float

AliceBlue

Declaration

public static Color AliceBlue

Field Value

Color

AntiqueWhite

Declaration

public static Color AntiqueWhite

Field Value

Color

Aqua

Declaration

public static Color Aqua

Field Value

Color

Aquamarine

Declaration

public static Color Aquamarine

Field Value

Color

Azure

Declaration

public static Color Azure

Field Value

Color

B

The blue channel value.

Declaration

public float B

Field Value

float

Beige

Declaration

public static Color Beige

Field Value

Color

Bisque

Declaration

public static Color Bisque

Field Value

Color

Black

Declaration

public static Color Black

Field Value

Color

BlanchedAlmond

Declaration

public static Color BlanchedAlmond

Field Value

Color

Blue

Declaration

public static Color Blue

Field Value

Color

BlueViolet

Declaration

public static Color BlueViolet

Field Value

Color

Brown

Declaration

public static Color Brown

Field Value

Color

BurlyWood

Declaration

public static Color BurlyWood

Field Value

Color

CadetBlue

Declaration

public static Color CadetBlue

Field Value

Color

Chartreuse

Declaration

public static Color Chartreuse

Field Value

Color

Chocolate

Declaration

public static Color Chocolate

Field Value

Color

Coral

Declaration

public static Color Coral

Field Value

Color

CornflowerBlue

Declaration

public static Color CornflowerBlue

Field Value

Color

Cornsilk

Declaration

public static Color Cornsilk

Field Value

Color

Crimson

Declaration

public static Color Crimson

Field Value

Color

Cyan

Declaration

public static Color Cyan

Field Value

Color

DarkBlue

Declaration

public static Color DarkBlue

Field Value

Color

DarkCyan

Declaration

public static Color DarkCyan

Field Value

Color

DarkGoldenrod

Declaration

public static Color DarkGoldenrod

Field Value

Color

DarkGray

Declaration

public static Color DarkGray

Field Value

Color

DarkGreen

Declaration

public static Color DarkGreen

Field Value

Color

DarkKhaki

Declaration

public static Color DarkKhaki

Field Value

Color

DarkMagenta

Declaration

public static Color DarkMagenta

Field Value

Color

DarkOliveGreen

Declaration

public static Color DarkOliveGreen

Field Value

Color

DarkOrange

Declaration

public static Color DarkOrange

Field Value

Color

DarkOrchid

Declaration

public static Color DarkOrchid

Field Value

Color

DarkRed

Declaration

public static Color DarkRed

Field Value

Color

DarkSalmon

Declaration

public static Color DarkSalmon

Field Value

Color

DarkSeaGreen

Declaration

public static Color DarkSeaGreen

Field Value

Color

DarkSlateBlue

Declaration

public static Color DarkSlateBlue

Field Value

Color

DarkSlateGray

Declaration

public static Color DarkSlateGray

Field Value

Color

DarkTurquoise

Declaration

public static Color DarkTurquoise

Field Value

Color

DarkViolet

Declaration

public static Color DarkViolet

Field Value

Color

DeepPink

Declaration

public static Color DeepPink

Field Value

Color

DeepSkyBlue

Declaration

public static Color DeepSkyBlue

Field Value

Color

DimGray

Declaration

public static Color DimGray

Field Value

Color

DodgerBlue

Declaration

public static Color DodgerBlue

Field Value

Color

Firebrick

Declaration

public static Color Firebrick

Field Value

Color

FloralWhite

Declaration

public static Color FloralWhite

Field Value

Color

ForestGreen

Declaration

public static Color ForestGreen

Field Value

Color

Fuchsia

Declaration

public static Color Fuchsia

Field Value

Color

G

The green channel value.

Declaration

public float G

Field Value

float

Gainsboro

Declaration

public static Color Gainsboro

Field Value

Color

GhostWhite

Declaration

public static Color GhostWhite

Field Value

Color

Gold

Declaration

public static Color Gold

Field Value

Color

Goldenrod

Declaration

public static Color Goldenrod

Field Value

Color

Gray

Declaration

public static Color Gray

Field Value

Color

Green

Declaration

public static Color Green

Field Value

Color

GreenYellow

Declaration

public static Color GreenYellow

Field Value

Color

Honeydew

Declaration

public static Color Honeydew

Field Value

Color

HotPink

Declaration

public static Color HotPink

Field Value

Color

IndianRed

Declaration

public static Color IndianRed

Field Value

Color

Indigo

Declaration

public static Color Indigo

Field Value

Color

Ivory

Declaration

public static Color Ivory

Field Value

Color

Khaki

Declaration

public static Color Khaki

Field Value

Color

Lavender

Declaration

public static Color Lavender

Field Value

Color

LavenderBlush

Declaration

public static Color LavenderBlush

Field Value

Color

LawnGreen

Declaration

public static Color LawnGreen

Field Value

Color

LemonChiffon

Declaration

public static Color LemonChiffon

Field Value

Color

LightBlue

Declaration

public static Color LightBlue

Field Value

Color

LightCoral

Declaration

public static Color LightCoral

Field Value

Color

LightCyan

Declaration

public static Color LightCyan

Field Value

Color

LightGoldenrodYellow

Declaration

public static Color LightGoldenrodYellow

Field Value

Color

LightGray

Declaration

public static Color LightGray

Field Value

Color

LightGreen

Declaration

public static Color LightGreen

Field Value

Color

LightPink

Declaration

public static Color LightPink

Field Value

Color

LightSalmon

Declaration

public static Color LightSalmon

Field Value

Color

LightSeaGreen

Declaration

public static Color LightSeaGreen

Field Value

Color

LightSkyBlue

Declaration

public static Color LightSkyBlue

Field Value

Color

LightSlateGray

Declaration

public static Color LightSlateGray

Field Value

Color

LightSteelBlue

Declaration

public static Color LightSteelBlue

Field Value

Color

LightYellow

Declaration

public static Color LightYellow

Field Value

Color

Lime

Declaration

public static Color Lime

Field Value

Color

LimeGreen

Declaration

public static Color LimeGreen

Field Value

Color

Linen

Declaration

public static Color Linen

Field Value

Color

Magenta

Declaration

public static Color Magenta

Field Value

Color

Maroon

Declaration

public static Color Maroon

Field Value

Color

MediumAquamarine

Declaration

public static Color MediumAquamarine

Field Value

Color

MediumBlue

Declaration

public static Color MediumBlue

Field Value

Color

MediumOrchid

Declaration

public static Color MediumOrchid

Field Value

Color

MediumPurple

Declaration

public static Color MediumPurple

Field Value

Color

MediumSeaGreen

Declaration

public static Color MediumSeaGreen

Field Value

Color

MediumSlateBlue

Declaration

public static Color MediumSlateBlue

Field Value

Color

MediumSpringGreen

Declaration

public static Color MediumSpringGreen

Field Value

Color

MediumTurquoise

Declaration

public static Color MediumTurquoise

Field Value

Color

MediumVioletRed

Declaration

public static Color MediumVioletRed

Field Value

Color

MidnightBlue

Declaration

public static Color MidnightBlue

Field Value

Color

MintCream

Declaration

public static Color MintCream

Field Value

Color

MistyRose

Declaration

public static Color MistyRose

Field Value

Color

Moccasin

Declaration

public static Color Moccasin

Field Value

Color

NavajoWhite

Declaration

public static Color NavajoWhite

Field Value

Color

Navy

Declaration

public static Color Navy

Field Value

Color

OldLace

Declaration

public static Color OldLace

Field Value

Color

Olive

Declaration

public static Color Olive

Field Value

Color

OliveDrab

Declaration

public static Color OliveDrab

Field Value

Color

Orange

Declaration

public static Color Orange

Field Value

Color

OrangeRed

Declaration

public static Color OrangeRed

Field Value

Color

Orchid

Declaration

public static Color Orchid

Field Value

Color

PaleGoldenrod

Declaration

public static Color PaleGoldenrod

Field Value

Color

PaleGreen

Declaration

public static Color PaleGreen

Field Value

Color

PaleTurquoise

Declaration

public static Color PaleTurquoise

Field Value

Color

PaleVioletRed

Declaration

public static Color PaleVioletRed

Field Value

Color

PapayaWhip

Declaration

public static Color PapayaWhip

Field Value

Color

PeachPuff

Declaration

public static Color PeachPuff

Field Value

Color

Peru

Declaration

public static Color Peru

Field Value

Color

Pink

Declaration

public static Color Pink

Field Value

Color

Plum

Declaration

public static Color Plum

Field Value

Color

PowderBlue

Declaration

public static Color PowderBlue

Field Value

Color

Purple

Declaration

public static Color Purple

Field Value

Color

R

The red channel value.

Declaration

public float R

Field Value

float

Raw

The packed values into array floats.

Declaration

public float Raw[4]

Field Value

float

Red

Declaration

public static Color Red

Field Value

Color

RosyBrown

Declaration

public static Color RosyBrown

Field Value

Color

RoyalBlue

Declaration

public static Color RoyalBlue

Field Value

Color

SaddleBrown

Declaration

public static Color SaddleBrown

Field Value

Color

Salmon

Declaration

public static Color Salmon

Field Value

Color

SandyBrown

Declaration

public static Color SandyBrown

Field Value

Color

SeaGreen

Declaration

public static Color SeaGreen

Field Value

Color

SeaShell

Declaration

public static Color SeaShell

Field Value

Color

Sienna

Declaration

public static Color Sienna

Field Value

Color

Silver

Declaration

public static Color Silver

Field Value

Color

SkyBlue

Declaration

public static Color SkyBlue

Field Value

Color

SlateBlue

Declaration

public static Color SlateBlue

Field Value

Color

SlateGray

Declaration

public static Color SlateGray

Field Value

Color

Snow

Declaration

public static Color Snow

Field Value

Color

SpringGreen

Declaration

public static Color SpringGreen

Field Value

Color

SteelBlue

Declaration

public static Color SteelBlue

Field Value

Color

Tan

Declaration

public static Color Tan

Field Value

Color

Teal

Declaration

public static Color Teal

Field Value

Color

Thistle

Declaration

public static Color Thistle

Field Value

Color

Tomato

Declaration

public static Color Tomato

Field Value

Color

Transparent

Declaration

public static Color Transparent

Field Value

Color

Turquoise

Declaration

public static Color Turquoise

Field Value

Color

Violet

Declaration

public static Color Violet

Field Value

Color

Wheat

Declaration

public static Color Wheat

Field Value

Color

White

Declaration

public static Color White

Field Value

Color

WhiteSmoke

Declaration

public static Color WhiteSmoke

Field Value

Color

Yellow

Declaration

public static Color Yellow

Field Value

Color

YellowGreen

Declaration

public static Color YellowGreen

Field Value

Color

Methods

AlphaMultiplied(float multiplier)

Returns the color with alpha channel multiplied by the given scale factor. The RGB channels remain the same.

Declaration

public Color AlphaMultiplied(float multiplier) const

Parameters

float multiplier The multiplier.

Returns

Color The modified color.

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

Initializes a new instance of the Color struct.

Declaration

public Color(float r, float g, float b, float a=1)

Parameters

float r The red channel value.

float g The green channel value.

float b The blue channel value.

float a The alpha channel value.

Returns

FORCE_INLINE

FromARGB(uint32 argb)

Initializes from packed ARGB value (bottom bits contain Blue).

Declaration

public static Color FromARGB(uint32 argb)

Parameters

uint32 argb The packed ARGB value (bottom bits contain Blue).

Returns

Color The color.

FromBytes(byte r, byte g, byte b, byte a=255)

Initializes from values in range [0;255].

Declaration

public static Color FromBytes(byte r, byte g, byte b, byte a=255)

Parameters

byte r The red channel.

byte g The green channel.

byte b The blue channel.

byte a The alpha channel.

Returns

Color The color.

FromHex(const String& hex)

Declaration

public static Color FromHex(const String& hex)

Parameters

String hex

Returns

Color

FromHex(const String& hex, bool& isValid)

Declaration

public static Color FromHex(const String& hex, bool& isValid)

Parameters

String hex

bool isValid

Returns

Color

FromHSV(const Float3& hsv, float alpha=1.0f)

Creates RGB color from Hue[0-360], Saturation[0-1] and Value[0-1] packed to XYZ vector.

Declaration

public static Color FromHSV(const Float3& hsv, float alpha=1.0f)

Parameters

Float3 hsv The HSV color.

float alpha The alpha value. Default is 1.

Returns

Color The RGB color.

FromHSV(float hue, float saturation, float value, float alpha=1.0f)

Creates RGB color from Hue[0-360], Saturation[0-1] and Value[0-1].

Declaration

public static Color FromHSV(float hue, float saturation, float value, float alpha=1.0f)

Parameters

float hue The hue angle in degrees [0-360].

float saturation The saturation normalized [0-1].

float value The value normalized [0-1].

float alpha The alpha value. Default is 1.

Returns

Color The RGB color.

FromRGB(uint32 rgb, float a=1.0f)

Initializes from packed RGB value (bottom bits contain Blue) of the color and separate alpha channel value.

Declaration

public static Color FromRGB(uint32 rgb, float a=1.0f)

Parameters

uint32 rgb The packed RGB value (bottom bits contain Blue).

float a The alpha channel.

Returns

Color The color.

FromRGBA(uint32 rgba)

Initializes from packed RGBA value (bottom bits contain Alpha).

Declaration

public static Color FromRGBA(uint32 rgba)

Parameters

uint32 rgba The packed RGBA value (bottom bits contain Alpha).

Returns

Color The color.

GetHashCode()

Declaration

public uint32 GetHashCode() const

Returns

uint32

GetHashCode(const Color& v)

Declaration

public static uint32 GetHashCode(const Color& v)

Parameters

Color v

Returns

uint32

HasOpacity()

Declaration

public bool HasOpacity() const

Returns

bool

IsTransparent()

Declaration

public bool IsTransparent() const

Returns

bool

Lerp(const Color& start, const Color& end, float amount)

Performs a linear interpolation between two colors.

Declaration

public static Color Lerp(const Color& start, const Color& end, float amount)

Parameters

Color start The start color.

Color end The end color.

float amount The value between 0 and 1 indicating the weight of interpolation.

Returns

Color The linear interpolation of the two colors.

Lerp(const Color& start, const Color& end, float amount, Color& result)

Performs a linear interpolation between two colors.

Declaration

public static void Lerp(const Color& start, const Color& end, float amount, Color& result)

Parameters

Color start The start color.

Color end The end color.

float amount The value between 0 and 1 indicating the weight of interpolation.

Color result When the method completes, contains the linear interpolation of the two colors.

LinearToSrgb(const Color& linear)

Declaration

public static Color LinearToSrgb(const Color& linear)

Parameters

Color linear

Returns

Color

NearEqual(const Color& a, const Color& b)

Declaration

public static bool NearEqual(const Color& a, const Color& b)

Parameters

Color a

Color b

Returns

bool

NearEqual(const Color& a, const Color& b, float epsilon)

Declaration

public static bool NearEqual(const Color& a, const Color& b, float epsilon)

Parameters

Color a

Color b

float epsilon

Returns

bool

operator!=(const Color& other)

Declaration

public bool operator!=(const Color& other) const

Parameters

Color other

Returns

bool

operator-(const Color& b)

Declaration

public Color operator-(const Color& b) const

Parameters

Color b

Returns

Color

operator-(float b)

Declaration

public Color operator-(float b) const

Parameters

float b

Returns

Color

operator*(const Color& b)

Declaration

public Color operator*(const Color& b) const

Parameters

Color b

Returns

Color

operator*(float b)

Declaration

public Color operator*(float b) const

Parameters

float b

Returns

Color

operator*=(const Color& b)

Declaration

public Color operator*=(const Color& b)

Parameters

Color b

Returns

Color

operator*=(const float b)

Declaration

public Color operator*=(const float b)

Parameters

float b

Returns

Color

operator/(float b)

Declaration

public Color operator/(float b) const

Parameters

float b

Returns

Color

operator+(const Color& b)

Declaration

public Color operator+(const Color& b) const

Parameters

Color b

Returns

Color

operator+(float b)

Declaration

public Color operator+(float b) const

Parameters

float b

Returns

Color

operator+=(const Color& b)

Declaration

public Color operator+=(const Color& b)

Parameters

Color b

Returns

Color

operator-=(const Color& b)

Declaration

public Color operator-=(const Color& b)

Parameters

Color b

Returns

Color

operator==(const Color& other)

Declaration

public bool operator==(const Color& other) const

Parameters

Color other

Returns

bool

Random()

Gets random color with opaque alpha.

Declaration

public static Color Random()

Returns

Color The color.

RGBMultiplied(Color multiplier)

Returns the color with RGB channels multiplied by the given color. The alpha channel remains the same.

Declaration

public Color RGBMultiplied(Color multiplier) const

Parameters

Color multiplier The multiplier.

Returns

Color The modified color.

RGBMultiplied(float multiplier)

Returns the color with RGB channels multiplied by the given scale factor. The alpha channel remains the same.

Declaration

public Color RGBMultiplied(float multiplier) const

Parameters

float multiplier The multiplier.

Returns

Color The modified color.

SrgbToLinear(const Color& srgb)

Declaration

public static Color SrgbToLinear(const Color& srgb)

Parameters

Color srgb

Returns

Color

ToFloat3()

Declaration

public Float3 ToFloat3() const

Returns

Float3

ToFloat4()

Declaration

public Float4 ToFloat4() const

Returns

Float4

ToHexString()

Declaration

public String ToHexString() const

Returns

String

ToHSV()

Gets Hue[0-360], Saturation[0-1] and Value[0-1] from RGB color.

Declaration

public Float3 ToHSV() const

Returns

Float3 HSV color

ToString()

Declaration

public String ToString() const

Returns

String