Home Original page

Color |

add

  • Returns Color

    Reference to this object for method chaining.

clone

  • Returns Color

    Reference to the newly cloned object.

copy

  • Parameters

    Returns Color

    Reference to this object for method chaining.

darken

  • darken(scale: number): Color

    Returns Color

    Reference to this object for method chaining.

equals

  • equals(color: Color): boolean

    Returns boolean

    True if the colors are equal, otherwise false.

lerp

  • Parameters

    • color: Color
    • alpha: number

    Returns Color

    Reference to this object for method chaining.

lighten

  • lighten(scale: number): Color

    Returns Color

    Reference to this object for method chaining.

parseCSS

  • parseCSS(cssColor: string): Color

    Parameters

    • cssColor: string

    Returns Color

    Reference to this object for method chaining

parseHex

  • parseHex(hexColor: `#${string}`, argb?: boolean): Color

    Parameters

    • hexColor: `#${string}`
    • Optionalargb: boolean = false

    Returns Color

    Reference to this object for method chaining

parseRGB

  • parseRGB(rgbColor: string): Color

    Parameters

    • rgbColor: string

    Returns Color

    Reference to this object for method chaining

random

  • random(min?: number, max?: number): Color

    Parameters

    • Optionalmin: number = 0
    • Optionalmax: number = 255

    Returns Color

    Reference to this object for method chaining

setColor

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

    Parameters

    • r: number = 0
    • g: number = 0
    • b: number = 0
    • Optionalalpha: number = 1.0

    Returns Color

    Reference to this object for method chaining.

setFloat

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

    Parameters

    • r: number
    • g: number
    • b: number
    • Optionalalpha: number = 1.0

    Returns Color

    Reference to this object for method chaining.

setHSL

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

    Parameters

    • h: number
    • s: number
    • l: number

    Returns Color

    Reference to this object for method chaining.

setHSV

  • setHSV(h: number, s: number, v: number): Color

    Parameters

    • h: number
    • s: number
    • v: number

    Returns Color

    Reference to this object for method chaining.

toArray

  • Returns Float32Array<ArrayBufferLike>

    A Float Array representation of this color

toHex

  • Returns string

    The color in "#RRGGBB" format

toHex8

  • toHex8(alpha?: number): string

    Parameters

    • alpha: number = ...

    Returns string

    The color in "#RRGGBBAA" format

toRGB

  • toRGB(): `rgb(${number},${number},${number})`

    Returns `rgb(${number},${number},${number})`

    The color in "rgb(R,G,B)" format

toRGBA

  • toRGBA(alpha?: number): `rgba(${number},${number},${number},${number})`

    Parameters

    • Optionalalpha: number = ...

    Returns `rgba(${number},${number},${number},${number})`

    The color in "rgba(R,G,B,A)" format

toUint32

  • toUint32(alpha?: number): number

    Parameters

    • Optionalalpha: number = 1.0

    Returns number

    A Uint32 ARGB representation of this color