Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Color

A utility class containing predefined colors and methods converting between different color representations.

Hierarchy

  • Color

Index

Properties

Static AQUA

AQUA: number

Static BLACK

BLACK: number

Static BLUE

BLUE: number

Static FUCHSIA

FUCHSIA: number

Static GRAY

GRAY: number

Static GREEN

GREEN: number

Static LIME

LIME: number

Static MAROON

MAROON: number

Static NAVY

NAVY: number

Static OLIVE

OLIVE: number

Static PURPLE

PURPLE: number

Static RED

RED: number

Static SILVER

SILVER: number

Static TEAL

TEAL: number

Static WHITE

WHITE: number

Static YELLOW

YELLOW: number

Methods

Static argb

  • argb(alpha: number, red: number, green: number, blue: number): number
  • Creates an ARGB color, stored in an unsigned integer. Channels are expected in the range 0 - 255.

    Parameters

    • alpha: number
    • red: number
    • green: number
    • blue: number

    Returns number

Static getAlpha

  • getAlpha(color: number): number

Static getBlue

  • getBlue(color: number): number

Static getGreen

  • getGreen(color: number): number

Static getRed

  • getRed(color: number): number

Static interpolate

  • interpolate(startColor: number, endColor: number, ratio: number): number
  • Calculates a smooth transition between one color to the next. ratio is expected between 0 and 1.

    Parameters

    • startColor: number
    • endColor: number
    • ratio: number

    Returns number

Static multiply

  • multiply(color: number, factor: number): number
  • Multiplies all channels of an (A)RGB color with a certain factor.

    Parameters

    • color: number
    • factor: number

    Returns number

Static rgb

  • rgb(red: number, green: number, blue: number): number
  • Creates an RGB color, stored in an unsigned integer. Channels are expected in the range 0 - 255.

    Parameters

    • red: number
    • green: number
    • blue: number

    Returns number

Static setAlpha

  • setAlpha(color: number, alpha: number): number

Static setBlue

  • setBlue(color: number, blue: number): number

Static setGreen

  • setGreen(color: number, green: number): number

Static setRed

  • setRed(color: number, red: number): number

Static toVector

  • toVector(color: number, out?: Vector<number>): Vector<number>
  • Converts a color to a vector containing the RGBA components (in this order) scaled between 0 and 1.

    Parameters

    • color: number
    • Optional out: Vector<number>

    Returns Vector<number>

Generated using TypeDoc