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

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

Inherited from SRGBColorGenerated.constructor

Properties

`Protected`_a

_a: number

`Protected`_b

_b: number

`Protected`_g

_g: number

`Protected`_r

_r: number

Accessors

a

get a(): number

Returns number

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

Inherited from SRGBColorGenerated.a

b

get b(): number

Returns number

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

Inherited from SRGBColorGenerated.b

elementCount

get elementCount(): number

Gets the number of elements in this color.

Returns number

g

get g(): number

Returns number

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

Inherited from SRGBColorGenerated.g

r

get r(): number

Returns number

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

Inherited from SRGBColorGenerated.r

`Static`black

get black(): SRGBColor

SRGBColor with all elements set to 0.

Returns SRGBColor

`Static`blue

get blue(): SRGBColor

Pure blue SRGBcolor with solid alpha value.

Returns SRGBColor

`Static`cyan

get cyan(): SRGBColor

Pure cyan SRGBcolor with solid alpha value.

Returns SRGBColor

`Static`darkCyan

get darkCyan(): SRGBColor

Returns SRGBColor

`Static`darkGray

get darkGray(): SRGBColor

Returns SRGBColor

`Static`green

get green(): SRGBColor

Pure green SRGBcolor with solid alpha value.

Returns SRGBColor

`Static`lightBlue

get lightBlue(): SRGBColor

Light blue SRGBcolor with solid alpha value.

Returns SRGBColor

`Static`lightGray

get lightGray(): SRGBColor

Returns SRGBColor

`Static`magenta

get magenta(): SRGBColor

Pure magenta SRGBcolor with solid alpha value.

Returns SRGBColor

`Static`mediumGray

get mediumGray(): SRGBColor

Returns SRGBColor

`Static`orange

get orange(): SRGBColor

Returns SRGBColor

`Static`red

get red(): SRGBColor

Pure red SRGBcolor with solid alpha value.

Returns SRGBColor

`Static`transparent

get transparent(): SRGBColor

Returns SRGBColor

`Static`veryDarkGray

get veryDarkGray(): SRGBColor

Returns SRGBColor

`Static`veryVeryDarkGray

get veryVeryDarkGray(): SRGBColor

Returns SRGBColor

`Static`white

get white(): SRGBColor

SRGBColor with all elements set to 1.

Returns SRGBColor

`Static`yellow

get yellow(): SRGBColor

Pure yellow SRGBcolor with solid alpha value.

Returns SRGBColor

Methods

add

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

assign

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

Inherited from SRGBColorGenerated.assign

clone

clone(): SRGBColor

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

Returns SRGBColor

Inherited from SRGBColorGenerated.clone

divideScalar

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

doAdd

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

doDivideScalar

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

doMultiply

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

doMultiplyScalar

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

doReplaceAlpha

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

doSubtract

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

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.

isAlmostEqual

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

Overrides SRGBColorGenerated.isEqual

multiply

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

multiplyScalar

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

replaceAlpha

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

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<SRGBColor>): SRGBColor
Returns a copy of the current color subtracted by the given color.
Parameters
- rhs: Immutable<SRGBColor>
Returns SRGBColor

toColor

toColor(): Color

Converts the current color to a Color.

Returns Color

Note
No colorspace conversion is performed.

toHueSaturationValue

toHueSaturationValue(): HueSaturationValue

Converts this color to a HueSaturationValue color.

Returns HueSaturationValue

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

toVector4(): Vector4

Converts this instance to a Vector4.

Returns Vector4

`Static`add

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

`Static`divideScalar

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

`Static`isAlmostEqual

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

`Static`isEqual

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

Overrides SRGBColorGenerated.isEqual

`Static`lerp

lerp(a: Immutable<SRGBColor>, b: Immutable<SRGBColor>, t: number): SRGBColor
Linearly interpolates between two colors.
Parameters
- a: Immutable<SRGBColor>
  Starting value to interpolate from.
- b: Immutable<SRGBColor>
  Ending value to interpolate towards.
- t: number
  Interpolation factor in specified range.
Returns SRGBColor
Interpolated color.

`Static`multiply

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

`Static`multiplyScalar

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

`Static`subtract

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

`Static`withByteValues

withByteValues(r?: number, g?: number, b?: number, a?: number): SRGBColor
Creates a color from the specified RGBA byte values in range [0-255].
Parameters
- Optionalr: number
- Optionalg: number
- Optionalb: number
- Optionala: number
Returns SRGBColor

`Static`withColor

withColor(color: Immutable<Color>): SRGBColor
Creates a new SRGB color value from a generic color value.
Parameters
- color: Immutable<Color>
Returns SRGBColor

`Static`withVector3

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

`Static`withVector4

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

Class SRGBColor

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SRGBColor

Properties

Protected_a

Protected_b

Protected_g

Protected_r

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 SRGBColor

Staticblue

Returns SRGBColor

Staticcyan

Returns SRGBColor

StaticdarkCyan

Returns SRGBColor

StaticdarkGray

Returns SRGBColor

Staticgreen

Returns SRGBColor

StaticlightBlue

Returns SRGBColor

StaticlightGray

Returns SRGBColor

Staticmagenta

Returns SRGBColor

StaticmediumGray

Returns SRGBColor

Staticorange

Returns SRGBColor

Staticred

Returns SRGBColor

Statictransparent

Returns SRGBColor

StaticveryDarkGray

Returns SRGBColor

StaticveryVeryDarkGray

Returns SRGBColor

Staticwhite

Returns SRGBColor

Staticyellow

Returns SRGBColor

Methods

add

Parameters

Returns SRGBColor

assign

Parameters

Returns SRGBColor

clone

Returns SRGBColor

divideScalar

Parameters

Returns SRGBColor

`Protected`_a

`Protected`_b

`Protected`_g

`Protected`_r

`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`divideScalar

`Static`isAlmostEqual

`Static`isEqual

`Static`lerp