UWAL / Color

Type Aliases

ColorParam

type ColorParam = Color | GPUColor;

Type Parameters

Type Parameter

Classes

Color

Utility class to convert, adjust, and compare color values.

Constructors

Constructor

new Color(
   hexOrRed?, 
   green?, 
   blue?, 
   alpha?
): Color;

Create a new color from a single hex value or using 3 or 4 channel components.

Parameters

Parameter	Type	Default value	Description
hexOrRed?	number	0x000000	RGB hex or red channel in 0 - 255 format.
green?	number	undefined	Green channel in 0 - 255 format.
blue?	number	undefined	Blue channel in 0 - 255 format.
alpha?	number	1	Alpha value in 0 - 1 format.

Returns

Color

Methods

Set()

Set(hex, alpha?): Color;

Update this color to a new value.

Parameters

Parameter	Type	Default value	Description
hex	number	undefined	Hex value.
alpha?	number	1	Alpha value.

Returns

Color

Premultiply()

Premultiply(alpha?, dst?): Color;

Multiply this color with an alpha value.

Parameters

Parameter	Type	Description
alpha?	number	Alpha value to multiply in 0 - 1 format. Defaults to the color's alpha.
dst?	Color	Destination color. A new one is created if omitted.

Returns

Color

Random()

Random(alpha?): Color;

Set this color to a random value.

Parameters

Parameter	Type	Default value	Description
alpha?	number	1	Alpha value. Call with undefined to randomize it.

Returns

Color

Equals()

Equals(color): boolean;

Compare this color value with the provided one.

Parameters

Parameter	Type	Description
color	number | ColorParam	Color to compare.

Returns

boolean

Accessors

RGB

Get Signature

get RGB(): number[];

Returns

number[]

This color components in 0 - 255 format. Alpha is omitted.

Set Signature

set RGB(values): void;

Set this color components using 0 - 255 format. Alpha defaults to 255 if omitted.

Parameters

Parameter	Type	Description
values	number[]	3 or 4 color channels.

Returns

void

RGBA

Get Signature

get RGBA(): number[];

Returns

number[]

This color components in 0 - 255 format.

Set Signature

set RGBA(values): void;

Set this color components using 0 - 255 format.

Alias

Color.RGB

Parameters

Parameter	Type	Description
values	number[]	3 or 4 color channels.

Returns

void

A

Get Signature

get A(): number;

Returns

number

This color alpha in 0 - 255 format.

Set Signature

set A(value): void;

Set this color alpha in 0 - 255 format.

Parameters

Parameter	Type	Description
value	number	Alpha value.

Returns

void

rgb

Get Signature

get rgb(): number[];

Returns

number[]

This color components in 0 - 1 format. Alpha is omitted.

Set Signature

set rgb(values): void;

Set this color components using 0 - 1 format. Alpha defaults to 1 if omitted.

Parameters

Parameter	Type	Description
values	number[]	3 or 4 color channels.

Returns

void

rgba

Get Signature

get rgba(): number[];

Returns

number[]

This color components in 0 - 1 format.

Set Signature

set rgba(values): void;

Set this color components using 0 - 1 format.

Alias

Color.rgb

Parameters

Parameter	Type	Description
values	number[]	3 or 4 color channels.

Returns

void

a

Get Signature

get a(): number;

Returns

number

This color alpha in 0 - 1 format.

Set Signature

set a(value): void;

Set this color alpha in 0 - 1 format.

Parameters

Parameter	Type	Description
value	number	Alpha value.

Returns

void