Class Color

Describes a color in the from of RGBA (in order: R, G, B, A).

Hierarchy

Color

Index

Constructors

Properties

a b g r

Methods

add clone cloneTo scale setValue toGamma toLinear add equals gammaToLinearSpace linearToGammaSpace scale

Constructors

constructor

new Color(r?: number, g?: number, b?: number, a?: number): Color
Constructor of Color.
Parameters
- r: number = 1
  
  The red component of the color
- g: number = 1
  
  The green component of the color
- b: number = 1
  
  The blue component of the color
- a: number = 1
  
  The alpha component of the color
Returns Color
- Defined in math/Color.ts:100

Properties

a

a: number

The alpha component of the color, 0~1.

b

b: number

The blue component of the color, 0~1.

g

g: number

The green component of the color, 0~1.

r

r: number

The red component of the color, 0~1.

Methods

add

add(color: Color): Color
Determines the sum of this color and the specified color.

Returns
The added color
Parameters
- color: Color
  
  The specified color
Returns Color
- Defined in math/Color.ts:128

clone

clone(): Color
Creates a clone of this color.

Returns
A clone of this color

Returns Color
- Defined in math/Color.ts:155

cloneTo

cloneTo(out: Color): Color
Clones this color to the specified color.

Returns
The specified color
Parameters
- out: Color
  
  The specified color
Returns Color
- Defined in math/Color.ts:165

scale

scale(s: number): Color
Scale this color by the given value.

Returns
The scaled color
Parameters
- s: number
  
  The amount by which to scale the color
Returns Color
- Defined in math/Color.ts:142

setValue

setValue(r: number, g: number, b: number, a: number): Color
Set the value of this color.

Returns
This color.
Parameters
- r: number
  
  The red component of the color
- g: number
  
  The green component of the color
- b: number
  
  The blue component of the color
- a: number
  
  The alpha component of the color
Returns Color
- Defined in math/Color.ts:115

toGamma

toGamma(out: Color): Color
Modify components (r, g, b) of this color from linear space to gamma space.

Returns
The color in gamma space
Parameters
- out: Color
  
  The color in gamma space
Returns Color
- Defined in math/Color.ts:190

toLinear

toLinear(out: Color): Color
Modify components (r, g, b) of this color from gamma space to linear space.

Returns
The color in linear space
Parameters
- out: Color
  
  The color in linear space
Returns Color
- Defined in math/Color.ts:178

`Static` add

add(left: Color, right: Color, out: Color): Color
Determines the sum of two colors.

Returns
The added color
Parameters
- left: Color
  
  The first color to add
- right: Color
  
  The second color to add
- out: Color
  
  The sum of two colors
Returns Color
- Defined in math/Color.ts:59

`Static` equals

equals(left: Color, right: Color): boolean
Determines whether the specified colors are equals.

Returns
True if the specified colors are equals, false otherwise
Parameters
- left: Color
  
  The first color to compare
- right: Color
  
  The second color to compare
Returns boolean
- Defined in math/Color.ts:43

`Static` gammaToLinearSpace

gammaToLinearSpace(value: number): number
Modify a value from the gamma space to the linear space.

Returns
The value in linear space
Parameters
- value: number
  
  The value in gamma space
Returns number
- Defined in math/Color.ts:12

`Static` linearToGammaSpace

linearToGammaSpace(value: number): number
Modify a value from the linear space to the gamma space.

Returns
The value in gamma space
Parameters
- value: number
  
  The value in linear space
Returns number
- Defined in math/Color.ts:27

`Static` scale

scale(left: Color, s: number, out: Color): Color
Scale a color by the given value.

Returns
The scaled color
Parameters
- left: Color
  
  The color to scale
- s: number
  
  The amount by which to scale the color
- out: Color
  
  The scaled color
Returns Color
- Defined in math/Color.ts:75

Generated using TypeDoc