Class Color

constructor

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

• Parameters

  • Optionalr: number = 0

    red component [0 .. 255]
  • Optionalg: number = 0

    green component [0 .. 255]
  • Optionalb: number = 0

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

    alpha value [0.0 .. 1.0]

  Returns Color

glArray

alpha

• get alpha(): number

• Color Alpha Component [0.0 .. 1.0]

  Returns number
• set alpha(value?): void

• Parameters

  • value: number = 1.0

  Returns void

b

• get b(): number

• Color Blue Component [0 .. 255]

  Returns number
• set b(value): void

• Parameters

  • value: number

  Returns void

g

• get g(): number

• Color Green Component [0 .. 255]

  Returns number
• set g(value): void

• Parameters

  • value: number

  Returns void

r

• get r(): number

• Color Red Component [0 .. 255]

  Returns number
• set r(value): void

• Parameters

  • value: number

  Returns void

add

• add(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

• Copy a color object or CSS color into this one.

  Parameters

  • color: string | Color

  Returns Color

  Reference to this object for method chaining

darken

• darken(scale): Color

• Darken this color value by 0..1

  Parameters

  • scale: number

  Returns Color

  Reference to this object for method chaining

equals

• equals(color): boolean

• Return true if the r,g,b,a values of this color are equal with the given one.

  Parameters

  • color: Color

  Returns boolean

lerp

• lerp(color, alpha): 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): Color

• Lighten this color value by 0..1

  Parameters

  • scale: number

  Returns Color

  Reference to this object for method chaining

parseCSS

• parseCSS(cssColor): Color

• Parse a CSS color string and set this color to the corresponding r,g,b values

  Parameters

  • cssColor: string

  Returns Color

  Reference to this object for method chaining

parseHex

• parseHex(hexColor, argb?): Color

• Parse a Hex color ("#RGB", "#RGBA" or "#RRGGBB", "#RRGGBBAA" format) and set this color to the corresponding r,g,b,a values

  Parameters

  • hexColor: string
  • Optionalargb: boolean = false

    true if format is #ARGB, or #AARRGGBB (as opposed to #RGBA or #RGGBBAA)

  Returns Color

  Reference to this object for method chaining

parseRGB

• parseRGB(rgbColor): Color

• Parse an RGB or RGBA CSS color string

  Parameters

  • rgbColor: string

  Returns Color

  Reference to this object for method chaining

random

• random(min?, max?): Color

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

  Parameters

  • Optionalmin: number = 0

    minimum value for the random range
  • Optionalmax: number = 255

    maxmium value for the random range

  Returns Color

  Reference to this object for method chaining

setColor

• setColor(r, g, b, alpha?): 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

setFloat

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

• set this color to the specified normalized float values

  Parameters

  • r: number

    red component [0.0 .. 1.0]
  • g: number

    green component [0.0 .. 1.0]
  • b: number

    blue component [0.0 .. 1.0]
  • Optionalalpha: number = 1.0

    alpha value [0.0 .. 1.0]

  Returns Color

  Reference to this object for method chaining

setHSL

• setHSL(h, s, l): Color

• set this color to the specified HSL value

  Parameters

  • h: number

    hue (a value from 0 to 1)
  • s: number

    saturation (a value from 0 to 1)
  • l: number

    lightness (a value from 0 to 1)

  Returns Color

  Reference to this object for method chaining

setHSV

• setHSV(h, s, v): Color

• set this color to the specified HSV value

  Parameters

  • h: number

    hue (a value from 0 to 1)
  • s: number

    saturation (a value from 0 to 1)
  • v: number

    value (a value from 0 to 1)

  Returns Color

  Reference to this object for method chaining

toArray

• toArray(): Float32Array

• return an Float Array representation of this object

  Returns Float32Array

toHex

• toHex(): string

• return the color in "#RRGGBB" format

  Returns string

toHex8

• toHex8(alpha?): string

• Get the color in "#RRGGBBAA" format

  Parameters

  • alpha: number = ...

  Returns string

toRGB

• toRGB(): string

• Get the color in "rgb(R,G,B)" format

  Returns string

toRGBA

• toRGBA(alpha?): string

• Get the color in "rgba(R,G,B,A)" format

  Parameters

  • Optionalalpha: number = ...

    alpha value [0.0 .. 1.0]

  Returns string

toUint32

• toUint32(alpha?): number

• Pack this color RGB components into a Uint32 ARGB representation

  Parameters

  • Optionalalpha: number = 1.0

    alpha value [0.0 .. 1.0]

  Returns number