Class ClearColor

a

b

g

r

Static ReadonlyBLACK

Static ReadonlyBLUE

Static ReadonlyCYAN

Static ReadonlyGREEN

Static ReadonlyPURPLE

Static ReadonlyRED

Static ReadonlyWHITE

Static ReadonlyYELLOW

[iterator]

• "[iterator]"(): IterableIterator<number>

  Allows for iteration of components.

  Returns IterableIterator<number>

add

• add(color: Color): Color

  Blend this color with the given one using addition.

  Parameters

  • color: Color

  Returns Color

  A new color instance.

clone

• clone(): Color

  Create a new copy of this color object.

  Returns Color

  Reference to the newly cloned object.

copy

• copy(color: Color): this

  Copy a color object or CSS color into this one.

  Parameters

  • color: Color

  Returns this

  This color instance.

darken

• darken(scale: number): Color

  Darken this color value by 0..1.

  Parameters

  • scale: number

  Returns Color

  A new color instance.

fuzzyEqual

• fuzzyEqual(color: Color, tolerance?: number): boolean

  Compare this color with another one using a tolerance.

  Parameters

  • color: Color
  • Optionaltolerance: number

    Maximum allowed per-channel difference.

  Returns boolean

  Whether all components are approximately equal.

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

  A new color instance.

lighten

• lighten(scale: number): Color

  Lighten this color value by 0..1.

  Parameters

  • scale: number

  Returns Color

  A new color instance.

random

• random(): Color

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

  Returns Color

serialize

• serialize(): ColorLike

  Convert this color into plain serializable data.

  Returns ColorLike

  A plain color object.

set

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

  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

    Alpha value [0.0 .. 1.0].

  Returns this

  This color instance.

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

StaticfuzzyEqual

• fuzzyEqual(color1: Color, color2: Color, tolerance?: number): boolean

  Compare two colors using a tolerance.

  Parameters

  • color1: Color
  • color2: Color
  • Optionaltolerance: number

    Maximum allowed per-channel difference.

  Returns boolean

  Whether all components are approximately equal.

Staticlerp

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

  Parameters

  • from: Color
  • to: Color
  • t: number
  • Optionalout: 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
  • Optionalcolor: Color

  Returns Color

Staticsubtract

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

  Parameters

  • color1: Color
  • color2: Color
  • Optionalout: Color

  Returns Color

StaticvalidateSerial

• validateSerial(value: unknown): value is ColorLike

  Check whether a value matches the serialized color shape.

  Parameters

  • value: unknown

    Value to validate.

  Returns value is ColorLike

  Whether the value is a valid serialized color.