Class Color

Immutable RGB color.

Index

Constructors

Properties

b g r

Accessors

black blue cyan green magenta orange red white yellow

Methods

toHex equals fromHex fromInteger lerp lerpHSL lerpHSV random toInteger

Constructors

constructor

new Color(r: number, g: number, b: number): Color
Constructor.
Parameters
- r: number
  The red channel [0, 1].
- g: number
  The green channel [0, 1].
- b: number
  The blue channel [0, 1].
Returns Color

Properties

`Readonly`b

b: number

The blue channel [0, 1].

`Readonly`g

g: number

The green channel [0, 1].

`Readonly`r

r: number

The red channel [0, 1].

Accessors

`Static`black

get black(): Color
Black.

Returns Color

`Static`blue

get blue(): Color
Blue.

Returns Color

`Static`cyan

get cyan(): Color
Cyan.

Returns Color

`Static`green

get green(): Color
Green.

Returns Color

`Static`magenta

get magenta(): Color
Magenta.

Returns Color

`Static`orange

get orange(): Color
Orange.

Returns Color

`Static`red

get red(): Color
Red.

Returns Color

`Static`white

get white(): Color
White.

Returns Color

`Static`yellow

get yellow(): Color
Yellow.

Returns Color

Methods

toHex

toHex(): string
Calculates the closest hexadecimal code.

Returns string
Hexadecimal code as a string in the HTML format, including the "#".

`Static`equals

equals(start: Color, end: Color): boolean
Determines whether two colors are exactly equal.
Parameters
- start: Color
  The first color.
- end: Color
  The second color.
Returns boolean
True if the colors are equal, false otherwise.

`Static`fromHex

fromHex(value: string): Color
Creates a color from a hexadecimal code.
Parameters
- value: string
  The hexadecimal code.
Returns Color
The corresponding color.

`Static`fromInteger

fromInteger(value: number): Color
Decodes a 32-bit integer to a color.
Parameters
- value: number
  The encoded color.
Returns Color
The decoded color.

`Static`lerp

lerp(start: Color, end: Color, weight: number): Color
Linearly interpolates between two colors in RGB space.
Parameters
- start: Color
  The start color.
- end: Color
  The end color.
- weight: number
  The interpolation fraction between the two colors.
Returns Color
The interpolated color.

`Static`lerpHSL

lerpHSL(start: Color, end: Color, weight: number): Color
Linearly interpolates between two colors in HSL space.
Parameters
- start: Color
  The start color.
- end: Color
  The end color.
- weight: number
  The interpolation fraction between the two colors.
Returns Color
The interpolated color.

`Static`lerpHSV

lerpHSV(start: Color, end: Color, weight: number): Color
Linearly interpolates between two colors in HSV space.
Parameters
- start: Color
  The start color.
- end: Color
  The end color.
- weight: number
  The interpolation fraction between the two colors.
Returns Color
The interpolated color.

`Static`random

random(): Color
Creates a random color.

Returns Color
The random color.

`Static`toInteger

toInteger(r: number, g: number, b: number, a: number): number
Encodes a color to a 32-bit integer.
Parameters
- r: number
  The red channel [0, 1].
- g: number
  The green channel [0, 1].
- b: number
  The blue channel [0, 1].
- a: number
  The alpha channel [0, 1].
Returns number
The encoded color.