Class Color

Represents an RGB color using values ranging from O and 1 for each color component.

Implements

Constructors

constructor

Properties

b g r black blue brightBlue brightCyan brightGreen brightMagenta brightOrange brightPurple brightRed brightWhite brightYellow cyan dimBlue dimCyan dimGreen dimMagenta dimOrange dimRed dimWhite dimYellow faintWhite green magenta mediumWhite orange red white yellow

Accessors

bByte gByte rByte

Methods

assign desaturate duplicate equals serialize set setWithBytes setWithHex setWithValue toColor32 toString fromBytes fromString lerp

Constructors

constructor

  • new Color(): Color

  • Create a new instance from either:

    • a (R, G, B) triplet (values ranging from 0 to 1)
    • a 24 bit color value
    • an hexadecimal color string (web style)

    Returns Color

  • new Color(r, g, b): Color

  • Parameters

    • r: number
    • g: number
    • b: number

    Returns Color

  • new Color(color): Color

  • Parameters

    Returns Color

  • new Color(color24): Color

  • Parameters

    • color24: number

    Returns Color

  • new Color(hexColor): Color

  • Parameters

    • hexColor: string

    Returns Color

Properties

b

b: number

g

g: number

r

r: number

Static Readonlyblack

black: Readonly<Color>

Static Readonlyblue

blue: Readonly<Color>

Static ReadonlybrightBlue

brightBlue: Readonly<Color>

Static ReadonlybrightCyan

brightCyan: Readonly<Color>

Static ReadonlybrightGreen

brightGreen: Readonly<Color>

Static ReadonlybrightMagenta

brightMagenta: Readonly<Color>

Static ReadonlybrightOrange

brightOrange: Readonly<Color>

Static ReadonlybrightPurple

brightPurple: Readonly<Color>

Static ReadonlybrightRed

brightRed: Readonly<Color>

Static ReadonlybrightWhite

brightWhite: Readonly<Color>

Static ReadonlybrightYellow

brightYellow: Readonly<Color>

Static Readonlycyan

cyan: Readonly<Color>

Static ReadonlydimBlue

dimBlue: Readonly<Color>

Static ReadonlydimCyan

dimCyan: Readonly<Color>

Static ReadonlydimGreen

dimGreen: Readonly<Color>

Static ReadonlydimMagenta

dimMagenta: Readonly<Color>

Static ReadonlydimOrange

dimOrange: Readonly<Color>

Static ReadonlydimRed

dimRed: Readonly<Color>

Static ReadonlydimWhite

dimWhite: Readonly<Color>

Static ReadonlydimYellow

dimYellow: Readonly<Color>

Static ReadonlyfaintWhite

faintWhite: Readonly<Color>

Static Readonlygreen

green: Readonly<Color>

Static Readonlymagenta

magenta: Readonly<Color>

Static ReadonlymediumWhite

mediumWhite: Readonly<Color>

Static Readonlyorange

orange: Readonly<Color>

Static Readonlyred

red: Readonly<Color>

Static Readonlywhite

white: Readonly<Color>

Static Readonlyyellow

yellow: Readonly<Color>

Accessors

bByte

  • get bByte(): number

  • Returns number

gByte

  • get gByte(): number

  • Returns number

rByte

  • get rByte(): number

  • Returns number

Methods

assign

  • assign(other): Color

  • Parameters

    Returns Color

desaturate

  • desaturate(): number

  • Returns number

duplicate

  • duplicate(): Color

  • Returns Color

equals

  • equals(other): boolean

  • Parameters

    Returns boolean

serialize

  • serialize(dataView, byteOffset?): [DataView, number]

  • Parameters

    • dataView: DataView
    • OptionalbyteOffset: number

    Returns [DataView, number]

set

  • set(r, g, b): Color

  • Parameters

    • r: number
    • g: number
    • b: number

    Returns Color

setWithBytes

  • setWithBytes(rByte, gByte, bByte): Color

  • Parameters

    • rByte: number
    • gByte: number
    • bByte: number

    Returns Color

setWithHex

  • setWithHex(hexColor): Color

  • Parameters

    • hexColor: string

    Returns Color

setWithValue

  • setWithValue(color24): Color

  • Parameters

    • color24: number

    Returns Color

toColor32

  • toColor32(): number

  • Returns number

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

StaticfromBytes

  • fromBytes(rByte, gByte, bByte): Color

  • Parameters

    • rByte: number
    • gByte: number
    • bByte: number

    Returns Color

StaticfromString

  • fromString(hexColor): Color

  • Parameters

    • hexColor: string

    Returns Color

Staticlerp

  • lerp(color1, color2, t): Color

  • Parameters

    Returns Color

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods