Class Color

constructor

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

  Parameters

  • r: number = 1
  • g: number = 1
  • b: number = 1
  • a: number = 1

  Returns Color

a

b

g

r

rgb

• set rgb(v: number): void

  Set color components.

  Parameters

  • v: number

  Returns void

rgba

• set rgba(v: number): void

  Set all components.

  Parameters

  • v: number

  Returns void

asReadonly

• asReadonly(): ReadonlyColor

  Returns a read-only version of this.

  Returns ReadonlyColor

  Same instance as ReadonlyColor

  Remarks

  Does not actually make this instance read-only if typing is ignored.

clone

• clone(): Color

  Clone this color.

  Returns Color

copyFrom

• copyFrom(other: ColorLike): this

  Copy all components from other.

  Parameters

  • other: ColorLike

  Returns this

  Self

copyToARGB

• copyToARGB(array: TypedArray, offset?: number, normalized?: boolean): void

  Copy components into array in ARGB order.

  Parameters

  • array: TypedArray

    Typed array
  • offset: number = 0

    Optional, offset into array
  • normalized: boolean = false

    Optional, if true copy in range [0,1], otherwise copy in range [0,255] (default)

  Returns void

  Self

copyToRGB

• copyToRGB(array: TypedArray, offset?: number, normalized?: boolean): void

  Copy components into array in RGB order.

  Parameters

  • array: TypedArray

    Typed array
  • offset: number = 0

    Optional, offset into array
  • normalized: boolean = false

    Optional, if true copy in range [0,1], otherwise copy in range [0,255] (default)

  Returns void

  Self

copyToRGBA

• copyToRGBA(array: TypedArray, offset?: number, normalized?: boolean): void

  Copy components into array in RGBA order.

  Parameters

  • array: TypedArray

    Typed array
  • offset: number = 0

    Optional, offset into array
  • normalized: boolean = false

    Optional, if true copy in range [0,1], otherwise copy in range [0,255] (default)

  Returns void

  Self

equals

• equals(r: number, g: number, b: number, epsilon?: number): boolean

  Check if the given color components match this color's color components.

  Parameters

  • r: number
  • g: number
  • b: number
  • epsilon: number = Number.EPSILON

    Optional, epsilon for comparison

  Returns boolean

  Remarks

  Only compares color components, ignores alpha.

equalsColor

• equalsColor(other: ColorLike, epsilon?: number): boolean

  Check if the color matches this color.

  Parameters

  • other: ColorLike
  • Optionalepsilon: number

    Optional, epsilon for comparison

  Returns boolean

  Remarks

  Compares color components and alpha.

equalsColorWithAlpha

• equalsColorWithAlpha(other: ColorLike, epsilon?: number): boolean

  Check if the color matches this color.

  Parameters

  • other: ColorLike
  • Optionalepsilon: number

    Optional, epsilon for comparison

  Returns boolean

  Remarks

  Only compares color components, ignores alpha.

equalsWithAlpha

• equalsWithAlpha(
      r: number,
      g: number,
      b: number,
      a: number,
      epsilon?: number,
  ): boolean

  Check if the given components match this color's components.

  Parameters

  • r: number
  • g: number
  • b: number
  • a: number
  • epsilon: number = Number.EPSILON

    Optional, epsilon for comparison

  Returns boolean

  Remarks

  Compares color components and alpha.

set

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

  Set components.

  Parameters

  • r: number

    Red
  • g: number

    Green
  • b: number

    Blue
  • Optionala: number

    Optional, alpha

  Returns this

  Self

setHSL

• setHSL(h: number, s: number, l: number, a?: number): Color

  Set from HSL components.

  Parameters

  • h: number

    Hue
  • s: number

    Saturation
  • l: number

    Lightness
  • Optionala: number

    Optional, alpha

  Returns Color

  Self

setHSV

• setHSV(h: number, s: number, v: number, a?: number): this

  Set from HSV components.

  Parameters

  • h: number

    Hue
  • s: number

    Saturation
  • v: number

    Value
  • Optionala: number

    Optional, alpha

  Returns this

  Self

toCSSString

• toCSSString(): string

  Get a CSS color string (hex) in format #rrggbbaa.

  Returns string

  CSS hex string

toHSL

• toHSL<T extends HSL>(target: T): T

  Type Parameters

  • T extends HSL

  Parameters

  • target: T

  Returns T

• toHSL(): HSL

  Returns HSL

toHSLA

• toHSLA<T extends HSLA>(target: T): T

  Type Parameters

  • T extends HSLA

  Parameters

  • target: T

  Returns T

• toHSLA(): HSLA

  Returns HSLA

toHSV

• toHSV<T extends HSV>(target: T): T

  Type Parameters

  • T extends HSV

  Parameters

  • target: T

  Returns T

• toHSV(): HSV

  Returns HSV

toHSVA

• toHSVA<T extends HSVA>(target: T): T

  Type Parameters

  • T extends HSVA

  Parameters

  • target: T

  Returns T

• toHSVA(): HSVA

  Returns HSVA

Staticblack

• black(): Color

  Returns Color

Staticblue

• blue(): Color

  Returns Color

Staticfrom

• from(v: ColorLike): Color

  Parameters

  • v: ColorLike

  Returns Color

StaticfromHexString

• fromHexString(hex: string): Color

  Parameters

  • hex: string

  Returns Color

StaticfromHSL

• fromHSL(h: number, s?: number, l?: number, a?: number): Color

  Parameters

  • h: number
  • s: number = 1
  • l: number = 1
  • Optionala: number

  Returns Color

StaticfromHSV

• fromHSV(h: number, s?: number, v?: number, a?: number): Color

  Parameters

  • h: number
  • s: number = 1
  • v: number = 1
  • Optionala: number

  Returns Color

Staticgreen

• green(): Color

  Returns Color

Staticred

• red(): Color

  Returns Color

Statictransparent

• transparent(): Color

  Returns Color

Staticwhite

• white(): Color

  Returns Color