Class Color

The Color implements a a three-component color with an alpha component. The class follows the 'copy-on-write' pattern, which means that every operation such as Color.add or Color.subtract returns a copy of the color with updated values. It also implies that the values of the color cannot be directly modified.

The concept of immutability improves sharing of objects as all types in TypeScript are assigned by identity, instead of by-value (e.g. a copy) as in other programming languages like C.

Constructors

constructor

Properties

_a _b _g _r compareEpsilon

Accessors

a b g r black blue cyan darkCyan darkGray green lightBlue lightGray magenta mediumGray orange red transparent veryDarkGray veryVeryDarkGray white yellow

Methods

add assign clone divideScalar doAdd doAddScalar doDivideScalar doMultiply doMultiplyScalar doReplaceAlpha doSubtract getElementAtIndex getLinearToSRGB getSRGBToLinear isAlmostEqual isEqual multiply multiplyScalar replaceAlpha setElement subtract toHueSaturationValue toLinear toSRGB toString toVector3 toVector4 add convertLinearToSRGB convertSrgbToLinear divideScalar isAlmostEqual isEqual lerp multiply multiplyScalar subtract withByteValues withVector3 withVector4

Constructors

constructor

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

  • Parameters

    • Optionalr: number
    • Optionalg: number
    • Optionalb: number
    • Optionala: number

    Returns Color

Properties

Protected_a

_a: number

Protected_b

_b: number

Protected_g

_g: number

Protected_r

_r: number

Static ReadonlycompareEpsilon

compareEpsilon = 0.001

The default value to approximately compare colors,

Accessors

a

  • get a(): number

  • Returns number

  • set a(value): void

  • Parameters

    • value: number

    Returns void

b

  • get b(): number

  • Returns number

  • set b(value): void

  • Parameters

    • value: number

    Returns void

g

  • get g(): number

  • Returns number

  • set g(value): void

  • Parameters

    • value: number

    Returns void

r

  • get r(): number

  • Returns number

  • set r(value): void

  • Parameters

    • value: number

    Returns void

Staticblack

  • get black(): Color

  • Color with all elements set to 0.

    Returns Color

Staticblue

  • get blue(): Color

  • Pure blue color with solid alpha value.

    Returns Color

Staticcyan

  • get cyan(): Color

  • Pure cyan color with solid alpha value.

    Returns Color

StaticdarkCyan

StaticdarkGray

Staticgreen

  • get green(): Color

  • Pure green color with solid alpha value.

    Returns Color

StaticlightBlue

  • get lightBlue(): Color

  • Light blue color with solid alpha value.

    Returns Color

StaticlightGray

Staticmagenta

  • get magenta(): Color

  • Pure magenta color with solid alpha value.

    Returns Color

StaticmediumGray

Staticorange

Staticred

  • get red(): Color

  • Pure red color with solid alpha value.

    Returns Color

Statictransparent

StaticveryDarkGray

StaticveryVeryDarkGray

Staticwhite

  • get white(): Color

  • Color with all elements set to 1.

    Returns Color

Staticyellow

  • get yellow(): Color

  • Pure yellow color with solid alpha value.

    Returns Color

Methods

add

assign

  • assign(other): Color

  • Copies all properties defined by the prototype of Color from other to this instance.

    Parameters

    Returns Color

clone

  • clone(): Color

  • Clones this instance and returns a new Color with identical values.

    Returns Color

divideScalar

  • divideScalar(factor): Color

  • Returns a copy of the current color divided by a factor.

    Parameters

    • factor: number

    Returns Color

doAdd

doAddScalar

  • doAddScalar(value, addAlpha): Color

  • Adds another color to this one and returns it.

    Parameters

    • value: number
    • addAlpha: boolean

    Returns Color

doDivideScalar

  • doDivideScalar(factor): Color

  • Divides this color by a factor.

    Parameters

    • factor: number

    Returns Color

doMultiply

  • doMultiply(rhs): Color

  • Performs component-wise multiplication with another color.

    Parameters

    Returns Color

doMultiplyScalar

  • doMultiplyScalar(factor, multiplyAlpha): Color

  • Performs scalar multiplication of this color and returns it.

    Parameters

    • factor: number
    • multiplyAlpha: boolean

    Returns Color

doReplaceAlpha

  • doReplaceAlpha(alpha): Color

  • Sets the alpha value to the specified value.

    Parameters

    • alpha: number

    Returns Color

doSubtract

  • doSubtract(rhs): Color

  • Subtracts another color from this one and returns it.

    Parameters

    Returns Color

getElementAtIndex

  • getElementAtIndex(index): number

  • Accesses color components by an index.

    Parameters

    • index: number

      Index ranging [0, 3]

    Returns number

    Value of the component at the specified index.

getLinearToSRGB

  • getLinearToSRGB(): Color

  • Converts the current color from linear to sRGB and returns the result.

    Returns Color

getSRGBToLinear

  • getSRGBToLinear(): Color

  • Converts the current color from sRGB to linear space and returns the result.

    Returns Color

isAlmostEqual

  • isAlmostEqual(rhs, epsilon?): boolean

  • Returns whether the provided color, given a error margin, has the same color components values as this one.

    Parameters

    • rhs: Immutable<Color>

      The other Color to compare with.

    • Optionalepsilon: number

      Optional. Error margin within which the numbers should be considered equal.

    Returns boolean

    True if equal, false otherwise.

isEqual

  • isEqual(rhs): boolean

  • Returns whether the given color contains the same color components values as this one.

    Parameters

    Returns boolean

multiply

  • multiply(rhs): Color

  • Returns a copy of the current color multiplied by the given color.

    Parameters

    Returns Color

multiplyScalar

  • multiplyScalar(factor, multiplyAlpha): Color

  • Returns a copy of this color multiplied by the factor.

    Parameters

    • factor: number
    • multiplyAlpha: boolean

    Returns Color

replaceAlpha

  • replaceAlpha(alpha): Color

  • Returns a copy of this color with the specified alpha value.

    Parameters

    • alpha: number

    Returns Color

setElement

  • setElement(index, value): void

  • Assigns the value to the element at the specified index.

    Parameters

    • index: number
    • value: number

    Returns void

subtract

  • subtract(rhs): Color

  • Returns a copy of the current color subtracted by the given color.

    Parameters

    Returns Color

toHueSaturationValue

toLinear

toSRGB

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

toVector3

  • toVector3(): Vector3

  • Converts this instance to a Vector3 with R/G/B while ignoring the alpha value.

    Returns Vector3

toVector4

Staticadd

StaticconvertLinearToSRGB

  • convertLinearToSRGB(x): number

  • Converts a single color component from linear to SRGB.

    Parameters

    • x: number

      Component in linear space.

    Returns number

    Component in SRGB space.

StaticconvertSrgbToLinear

  • convertSrgbToLinear(x): number

  • Converts a single color component from SRGB to linear space.

    Parameters

    • x: number

      Component in SRGB space.

    Returns number

    Component in linear space.

StaticdivideScalar

  • divideScalar(rhs, factor): Color

  • Divides the given color by a factor.

    Parameters

    Returns Color

StaticisAlmostEqual

  • isAlmostEqual(lhs, rhs, epsilon?): boolean

  • Compares two colors with an error margin.

    Parameters

    • lhs: Immutable<Color>

      First color to compare.

    • rhs: Immutable<Color>

      Second color to compare.

    • Optionalepsilon: number

      Optional. Error margin within which the numbers should be considered equal.

    Returns boolean

    True if equal, false otherwise.

StaticisEqual

  • isEqual(lhs, rhs): boolean

  • Returns whether all the colors components contains the same values.

    Parameters

    Returns boolean

Staticlerp

  • lerp(a, b, t): Color

  • Linearly interpolates between two values.

    Parameters

    • a: Immutable<Color>

      Starting value to interpolate from.

    • b: Immutable<Color>

      Ending value to interpolate towards.

    • t: number

      Interpolation factor in specified range.

    Returns Color

    Interpolated vector.

Staticmultiply

StaticmultiplyScalar

  • multiplyScalar(lhs, factor, multiplyAlpha): Color

  • Multiply the color by the scalar.

    Parameters

    Returns Color

Staticsubtract

StaticwithByteValues

  • withByteValues(r?, g?, b?, a?): Color

  • Creates a color from the specified RGBA byte values in range [0-255].

    Parameters

    • Optionalr: number
    • Optionalg: number
    • Optionalb: number
    • Optionala: number

    Returns Color

StaticwithVector3

  • withVector3(vector, alpha): Color

  • Creates a color from the specified Vector3 and alpha value.

    Parameters

    Returns Color

StaticwithVector4

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods