Class Color

constructor

• new Color(r?: number, g?: number, b?: number, alpha?: number): Color

  Parameters

  • r: number = 1

    The red channel [0 .. 1].
  • g: number = 1

    The green channel [0 .. 1].
  • b: number = 1

    The blue channe; [0 .. 1].
  • alpha: number = 1

    The alpha channel [0 .. 1].

  Returns Color

a

b

g

r

Static ReadonlyBLACK

Static ReadonlyBLUE

Static ReadonlyCYAN

Static ReadonlyGREEN

Static ReadonlyPURPLE

Static ReadonlyRED

Static ReadonlyWHITE

Static ReadonlyYELLOW

[iterator]

• "[iterator]"(): Generator<number, void, unknown>

  Allows for iteration of components.

  Returns Generator<number, void, unknown>

  Yields

add

• add(color: Color): Color

  Blend this color with the given one using addition.

  Parameters

  • color: Color

  Returns Color

  Reference to this object for method chaining.

clone

• clone(): Color

  Create a new copy of this color object.

  Returns Color

  Reference to the newly cloned object.

copy

• copy(color: Color): Color

  Copy a color object or CSS color into this one.

  Parameters

  • color: Color

  Returns Color

  Reference to this object for method chaining.

darken

• darken(scale: number): Color

  Darken this color value by 0..1.

  Parameters

  • scale: number

  Returns Color

  Reference to this object for method chaining.

lerp

• lerp(color: Color, alpha: number): Color

  Linearly interpolate between this color and the given one.

  Parameters

  • color: Color
  • alpha: number

    With alpha = 0 being this color, and alpha = 1 being the given one.

  Returns Color

  Reference to this object for method chaining.

lighten

• lighten(scale: number): Color

  Lighten this color value by 0..1.

  Parameters

  • scale: number

  Returns Color

  Reference to this object for method chaining.

random

• random(): Color

  Generate random r,g,b values for this color object.

  Returns Color

set

• set(r: number, g: number, b: number, alpha?: number): Color

  Set this color to the specified value.

  Parameters

  • r: number

    Red component [0 .. 255].
  • g: number

    Green component [0 .. 255].
  • b: number

    Blue component [0 .. 255].
  • Optionalalpha: number = 1.0

    Alpha value [0.0 .. 1.0].

  Returns Color

  Reference to this object for method chaining.

Staticadd

• add(color1: Color, color2: Color, out?: Color): Color

  Parameters

  • color1: Color
  • color2: Color
  • Optionalout: Color = ...

  Returns Color

Staticcopy

• copy(color: Color, out?: Color): Color

  Parameters

  • color: Color
  • Optionalout: Color = ...

  Returns Color

Staticdarken

• darken(color: Color, scale: number, out?: Color): typeof Color

  Parameters

  • color: Color
  • scale: number
  • Optionalout: Color = ...

  Returns typeof Color

Staticlerp

• lerp(from: Color, to: Color, t: number, out?: Color): Color

  Parameters

  • from: Color
  • to: Color
  • t: number
  • out: Color = ...

  Returns Color

Staticlighten

• lighten(color: Color, scale: number, out?: Color): Color

  Parameters

  • color: Color
  • scale: number
  • Optionalout: Color = ...

  Returns Color

Staticrandom

• random(out?: Color): Color

  Parameters

  • Optionalout: Color = ...

  Returns Color

Staticset

• set(r: number, g: number, b: number, a: number, color?: Color): Color

  Parameters

  • r: number
  • g: number
  • b: number
  • a: number
  • color: Color = ...

  Returns Color

Staticsubtract

• subtract(color1: Color, color2: Color, out?: Color): Color

  Parameters

  • color1: Color
  • color2: Color
  • Optionalout: Color = ...

  Returns Color