Class SRGBColor

The SRGBColor implements a color in SRGB color space. The class follows the 'copy-on-write' pattern, which means that every operation such as SRGBColor.divideScalar or SRGBColor.multiply 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

Accessors

a b g r black transparent white

Methods

add assign clone divideScalar doAdd doDivideScalar doMultiply doMultiplyScalar doSubtract getElementAtIndex isAlmostEqual isEqual multiply multiplyScalar setElement subtract toColor toHueSaturationValue toLinear toString toVector3 toVector4 add divideScalar isAlmostEqual isEqual multiply multiplyScalar subtract withColor

Constructors

constructor

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

  • Parameters

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

    Returns SRGBColor

Properties

Protected_a

_a: number

Protected_b

_b: number

Protected_g

_g: number

Protected_r

_r: number

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

Statictransparent

Staticwhite

Methods

add

assign

  • assign(other): SRGBColor

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

    Parameters

    Returns SRGBColor

clone

  • clone(): SRGBColor

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

    Returns SRGBColor

divideScalar

  • divideScalar(factor): SRGBColor

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

    Parameters

    • factor: number

    Returns SRGBColor

doAdd

doDivideScalar

  • doDivideScalar(factor): SRGBColor

  • Divides this color by a factor.

    Parameters

    • factor: number

    Returns SRGBColor

doMultiply

doMultiplyScalar

  • doMultiplyScalar(factor, multiplyAlpha): SRGBColor

  • Performs scalar multiplication of this color and returns it.

    Parameters

    • factor: number
    • multiplyAlpha: boolean

    Returns SRGBColor

doSubtract

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.

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<SRGBColor>

      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

multiplyScalar

  • multiplyScalar(factor, multiplyAlpha): SRGBColor

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

    Parameters

    • factor: number
    • multiplyAlpha: boolean

    Returns SRGBColor

setElement

  • setElement(index, value): void

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

    Parameters

    • index: number
    • value: number

    Returns void

subtract

toColor

  • toColor(): Color

  • Converts the current color to a Color.

    Returns Color

    Note

    No colorspace conversion is performed.

toHueSaturationValue

toLinear

  • toLinear(): LinearColor

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

    Returns LinearColor

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

StaticdivideScalar

StaticisAlmostEqual

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

  • Compares two colors with an error margin.

    Parameters

    • lhs: Immutable<SRGBColor>

      First color to compare.

    • rhs: Immutable<SRGBColor>

      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

Staticmultiply

StaticmultiplyScalar

Staticsubtract

StaticwithColor

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods