Color.API

Class: Color

Color

new Color(r, g, b, a)

Represents color information in rgba format.

Parameters:

Name	Type	Argument	Default	Description
r	Number	<optional>	0	Red value (floating point data)
g	Number	<optional>	0	Green value (floating point data)
b	Number	<optional>	0	Blue value (floating point data)
a	Number	<optional>	1	Alpha value (floating point data)

Source:

• util/Color.js , lineno 12

Members

a :Number

Alpha value (floating point data)

Type:

• Number

Source:

• util/Color.js , lineno 32

b :Number

Blue value (floating point data)

Type:

• Number

Source:

• util/Color.js , lineno 27

g :Number

Green value (floating point data)

Type:

• Number

Source:

• util/Color.js , lineno 22

r :Number

Red value (floating point data)

Type:

• Number

Source:

• util/Color.js , lineno 17

Methods

<static> black() → {Color}

Create a new color with r=0,g=0,b=0,a=1

Source:

• util/Color.js , lineno 115

Returns:

Type

Color

<static> blue() → {Color}

Create a new color with r=0,g=0,b=1,a=1

Source:

• util/Color.js , lineno 142

Returns:

Type

Color

<static> green() → {Color}

Create a new color with r=0,g=1,b=0,a=1

Source:

• util/Color.js , lineno 133

Returns:

Type

Color

<static> red() → {Color}

Create a new color with r=1,g=0,b=0,a=1

Source:

• util/Color.js , lineno 124

Returns:

Type

Color

<static> white() → {Color}

Create a new color with r=1,g=1,b=1,a=1

Source:

• util/Color.js , lineno 106

Returns:

Type

Color

copy(color) → {Color}

Returns a copy of the color

Parameters:

Name	Type	Argument	Description
color	Color	<optional>	The out color

Source:

• util/Color.js , lineno 69

Returns:

Type

Color

equals(color) → {boolean}

Check if color equals another color.

Parameters:

Name	Type	Description
color	Color	Another color

Source:

• util/Color.js , lineno 79

Returns:

Type

boolean

set(color) → {Color}

Set from another color.

Parameters:

Name	Type	Description
color	Color	Another color

Source:

• util/Color.js , lineno 59

Returns:

Type

Color

setf(r, g, b, a) → {Color}

Set rgba components.

Parameters:

Name	Type	Argument	Default	Description
r	Number	<optional>	0	Red value (floating point data)
g	Number	<optional>	0	Green value (floating point data)
b	Number	<optional>	0	Blue value (floating point data)
a	Number	<optional>	1	Alpha value (floating point data)

Source:

• util/Color.js , lineno 45

Returns:

Type

Color

toFloat32Array(arr) → {Float32Array}

Returns a Float32Array representation of the color.

Parameters:

Name	Type	Argument	Description
arr	Float32Array	<optional>	The out Float32Array

Source:

• util/Color.js , lineno 92

Returns:

Type

Float32Array

toString() → {String}

Return a string representation of the color.

Source:

• util/Color.js , lineno 151

Returns:

Type

String

Generated with wicked.