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

new Color(r?: number, g?: number, b?: number, a?: number): Color
Parameters
- Optionalr: number
- Optionalg: number
- Optionalb: number
- Optionala: number
Returns Color

Inherited from ColorGenerated.constructor

Properties

`Protected`_a

_a: number

`Protected`_b

_b: number

`Protected`_g

_g: number

`Protected`_r

_r: number

`Static` `Readonly`compareEpsilon

compareEpsilon: 0.001

The default value to approximately compare colors,

Accessors

a

get a(): number

Returns number

Inherited from ColorGenerated.a
set a(value: number): void
Parameters
- value: number
Returns void

Inherited from ColorGenerated.a

b

get b(): number

Returns number

Inherited from ColorGenerated.b
set b(value: number): void
Parameters
- value: number
Returns void

Inherited from ColorGenerated.b

elementCount

get elementCount(): number

Gets the number of elements in this color.

Returns number

g

get g(): number

Returns number

Inherited from ColorGenerated.g
set g(value: number): void
Parameters
- value: number
Returns void

Inherited from ColorGenerated.g

r

get r(): number

Returns number

Inherited from ColorGenerated.r
set r(value: number): void
Parameters
- value: number
Returns void

Inherited from ColorGenerated.r

`Static`black

get black(): Color

Color with all elements set to 0.

Returns Color

`Static`blue

get blue(): Color

Pure blue color with solid alpha value.

Returns Color

`Static`cyan

get cyan(): Color

Pure cyan color with solid alpha value.

Returns Color

`Static`darkCyan

get darkCyan(): Color

Returns Color

`Static`darkGray

get darkGray(): Color

Returns Color

`Static`green

get green(): Color

Pure green color with solid alpha value.

Returns Color

`Static`lightBlue

get lightBlue(): Color

Light blue color with solid alpha value.

Returns Color

`Static`lightGray

get lightGray(): Color

Returns Color

`Static`magenta

get magenta(): Color

Pure magenta color with solid alpha value.

Returns Color

`Static`mediumGray

get mediumGray(): Color

Returns Color

`Static`orange

get orange(): Color

Returns Color

`Static`red

get red(): Color

Pure red color with solid alpha value.

Returns Color

`Static`transparent

get transparent(): Color

Returns Color

`Static`veryDarkGray

get veryDarkGray(): Color

Returns Color

`Static`veryVeryDarkGray

get veryVeryDarkGray(): Color

Returns Color

`Static`white

get white(): Color

Color with all elements set to 1.

Returns Color

`Static`yellow

get yellow(): Color

Pure yellow color with solid alpha value.

Returns Color

Methods

add

add(rhs: Immutable<Color>): Color
Returns a copy of the current color added by the given one.
Parameters
- rhs: Immutable<Color>
Returns Color

assign

assign(other: Immutable<Color>): Color
Copies all properties defined by the prototype of Color from other to this instance.
Parameters
- other: Immutable<Color>
Returns Color

Inherited from ColorGenerated.assign

clone

clone(): Color

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

Returns Color

Inherited from ColorGenerated.clone

divideScalar

divideScalar(factor: number): Color
Returns a copy of the current color divided by a factor.
Parameters
- factor: number
Returns Color

doAdd

doAdd(rhs: Immutable<Color>): Color
Adds another color to this one and returns it.
Parameters
- rhs: Immutable<Color>
Returns Color

doAddScalar

doAddScalar(value: number, addAlpha: boolean): Color
Adds another color to this one and returns it.
Parameters
- value: number
- addAlpha: boolean
Returns Color

doDivideScalar

doDivideScalar(factor: number): Color
Divides this color by a factor.
Parameters
- factor: number
Returns Color

doMultiply

doMultiply(rhs: Immutable<Color>): Color
Performs component-wise multiplication with another color.
Parameters
- rhs: Immutable<Color>
Returns Color

doMultiplyScalar

doMultiplyScalar(factor: number, multiplyAlpha: boolean): Color
Performs scalar multiplication of this color and returns it.
Parameters
- factor: number
- multiplyAlpha: boolean
Returns Color

doReplaceAlpha

doReplaceAlpha(alpha: number): Color
Sets the alpha value to the specified value.
Parameters
- alpha: number
Returns Color

doSubtract

doSubtract(rhs: Immutable<Color>): Color
Subtracts another color from this one and returns it.
Parameters
- rhs: Immutable<Color>
Returns Color

getElementAtIndex

getElementAtIndex(index: number): 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: Immutable<Color>, epsilon?: number): 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: Immutable<Color>): boolean
Returns whether the given color contains the same color components values as this one.
Parameters
- rhs: Immutable<Color>
Returns boolean

Overrides ColorGenerated.isEqual

multiply

multiply(rhs: Immutable<Color>): Color
Returns a copy of the current color multiplied by the given color.
Parameters
- rhs: Immutable<Color>
Returns Color

multiplyScalar

multiplyScalar(factor: number, multiplyAlpha: boolean): Color
Returns a copy of this color multiplied by the factor.
Parameters
- factor: number
- multiplyAlpha: boolean
Returns Color

replaceAlpha

replaceAlpha(alpha: number): Color
Returns a copy of this color with the specified alpha value.
Parameters
- alpha: number
Returns Color

setElement

setElement(index: number, value: number): void
Assigns the value to the element at the specified index.
Parameters
- index: number
- value: number
Returns void

subtract

subtract(rhs: Immutable<Color>): Color
Returns a copy of the current color subtracted by the given color.
Parameters
- rhs: Immutable<Color>
Returns Color

toHueSaturationValue

toHueSaturationValue(): HueSaturationValue

Converts this color to a HueSaturationValue color.

Returns HueSaturationValue

toLinear

toLinear(): LinearColor

Converts this instance to a LinearColor.

Returns LinearColor

Note
No colorspace conversion is performed. If a colorspace conversion is required, use toSRGB first and then SRGBColor#toLinear.

toSRGB

toSRGB(): SRGBColor

Converts this instance to a SRGBColor.

Returns SRGBColor

Note
No colorspace conversion is performed. If a colorspace conversion is required, use toLinear first and then LinearColor#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

toVector4(): Vector4

Converts this instance to a Vector4.

Returns Vector4

`Static`add

add(lhs: Immutable<Color>, rhs: Immutable<Color>): Color
Adds two colors together.
Parameters
- lhs: Immutable<Color>
- rhs: Immutable<Color>
Returns Color

`Static`convertLinearToSRGB

convertLinearToSRGB(x: number): number
Converts a single color component from linear to SRGB.
Parameters
- x: number
  Component in linear space.
Returns number
Component in SRGB space.

`Static`convertSrgbToLinear

convertSrgbToLinear(x: number): number
Converts a single color component from SRGB to linear space.
Parameters
- x: number
  Component in SRGB space.
Returns number
Component in linear space.

`Static`divideScalar

divideScalar(rhs: Immutable<Color>, factor: number): Color
Divides the given color by a factor.
Parameters
- rhs: Immutable<Color>
- factor: number
Returns Color

`Static`isAlmostEqual

isAlmostEqual(
    lhs: Immutable<Color>,
    rhs: Immutable<Color>,
    epsilon?: number,
): 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.

`Static`isEqual

isEqual(lhs: Immutable<Color>, rhs: Immutable<Color>): boolean
Returns whether all the colors components contains the same values.
Parameters
- lhs: Immutable<Color>
- rhs: Immutable<Color>
Returns boolean

Overrides ColorGenerated.isEqual

`Static`lerp

lerp(a: Immutable<Color>, b: Immutable<Color>, t: number): 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.

`Static`multiply

multiply(lhs: Immutable<Color>, rhs: Immutable<Color>): Color
Multiplies both colors.
Parameters
- lhs: Immutable<Color>
- rhs: Immutable<Color>
Returns Color

`Static`multiplyScalar

multiplyScalar(
    lhs: Immutable<Color>,
    factor: number,
    multiplyAlpha: boolean,
): Color
Multiply the color by the scalar.
Parameters
- lhs: Immutable<Color>
- factor: number
- multiplyAlpha: boolean
Returns Color

`Static`subtract

subtract(lhs: Immutable<Color>, rhs: Immutable<Color>): Color
Subtract both colors.
Parameters
- lhs: Immutable<Color>
- rhs: Immutable<Color>
Returns Color

`Static`withByteValues

withByteValues(r?: number, g?: number, b?: number, a?: number): 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

`Static`withVector3

withVector3(vector: Immutable<Vector3>, alpha: number): Color
Creates a color from the specified Vector3 and alpha value.
Parameters
- vector: Immutable<Vector3>
- alpha: number
Returns Color

`Static`withVector4

withVector4(vector: Immutable<Vector4>): Color
Creates a color from the specified Vector4.
Parameters
- vector: Immutable<Vector4>
Returns Color

Class Color

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Color

Properties

Protected_a

Protected_b

Protected_g

Protected_r

Static ReadonlycompareEpsilon

Accessors

a

Returns number

Parameters

Returns void

b

Returns number

Parameters

Returns void

elementCount

Returns number

g

Returns number

Parameters

Returns void

r

Returns number

Parameters

Returns void

Staticblack

Returns Color

Staticblue

Returns Color

Staticcyan

Returns Color

StaticdarkCyan

Returns Color

StaticdarkGray

Returns Color

Staticgreen

Returns Color

StaticlightBlue

Returns Color

StaticlightGray

Returns Color

Staticmagenta

Returns Color

StaticmediumGray

Returns Color

Staticorange

Returns Color

Staticred

Returns Color

Statictransparent

Returns Color

StaticveryDarkGray

Returns Color

StaticveryVeryDarkGray

Returns Color

Staticwhite

Returns Color

Staticyellow

Returns Color

Methods

add

Parameters

Returns Color

assign

Parameters

Returns Color

clone

Returns Color

divideScalar

Parameters

`Protected`_a

`Protected`_b

`Protected`_g

`Protected`_r

`Static` `Readonly`compareEpsilon

`Static`black

`Static`blue

`Static`cyan

`Static`darkCyan

`Static`darkGray

`Static`green

`Static`lightBlue

`Static`lightGray

`Static`magenta

`Static`mediumGray

`Static`orange

`Static`red

`Static`transparent

`Static`veryDarkGray

`Static`veryVeryDarkGray

`Static`white

`Static`yellow

`Static`add

`Static`convertLinearToSRGB