Class Color

A color manipulation class.

Hierarchy (View Summary)

Color
- ClearColor

Index

Constructors

Properties

a b g r BLACK BLUE CYAN GREEN PURPLE RED WHITE YELLOW

Methods

[iterator] add clone copy darken fuzzyEqual lerp lighten random serialize set add copy darken deserialize fuzzyEqual lerp lighten random serialize set subtract validateSerial

Constructors

constructor

new Color(r?: number, g?: number, b?: number, alpha?: number): Color
Parameters
- Optionalr: number
  The red channel [0 .. 1].
- Optionalg: number
  The green channel [0 .. 1].
- Optionalb: number
  The blue channe; [0 .. 1].
- Optionalalpha: number
  The alpha channel [0 .. 1].
Returns Color
- Defined in node_modules/marangi/dist/index.d.ts:24

Properties

a

a: number

b

b: number

g

g: number

r

r: number

`Static` `Readonly`BLACK

BLACK: Color

A black color constant.

`Static` `Readonly`BLUE

BLUE: Color

A blue color constant.

`Static` `Readonly`CYAN

CYAN: Color

A cyan color constant.

`Static` `Readonly`GREEN

GREEN: Color

A green color constant.

`Static` `Readonly`PURPLE

PURPLE: Color

A purple color constant.

`Static` `Readonly`RED

RED: Color

A red color constant.

`Static` `Readonly`WHITE

WHITE: Color

A white color constant.

`Static` `Readonly`YELLOW

YELLOW: Color

A yellow color constant.

Methods

[iterator]

"[iterator]"(): IterableIterator<number>
Allows for iteration of components.

Returns IterableIterator<number>
- Defined in node_modules/marangi/dist/index.d.ts:168

add

add(color: Color): Color
Blend this color with the given one using addition.
Parameters
- color: Color
Returns Color
A new color instance.
- Defined in node_modules/marangi/dist/index.d.ts:50

clone

clone(): Color
Create a new copy of this color object.

Returns Color
Reference to the newly cloned object.
- Defined in node_modules/marangi/dist/index.d.ts:38

copy

copy(color: Color): this
Copy a color object or CSS color into this one.
Parameters
- color: Color
Returns this
This color instance.
- Defined in node_modules/marangi/dist/index.d.ts:44

darken

darken(scale: number): Color
Darken this color value by 0..1.
Parameters
- scale: number
Returns Color
A new color instance.
- Defined in node_modules/marangi/dist/index.d.ts:57

fuzzyEqual

fuzzyEqual(color: Color, tolerance?: number): boolean
Compare this color with another one using a tolerance.
Parameters
- color: Color
- Optionaltolerance: number
  Maximum allowed per-channel difference.
Returns boolean
Whether all components are approximately equal.
- Defined in node_modules/marangi/dist/index.d.ts:83

lerp

lerp(color: Color, alpha: number): Color
Linearly interpolate between this color and the given one.
Parameters
- color: Color
- alpha: number
  With alpha = 0 being this color, and alpha = 1 being the given one.
Returns Color
A new color instance.
- Defined in node_modules/marangi/dist/index.d.ts:71

lighten

lighten(scale: number): Color
Lighten this color value by 0..1.
Parameters
- scale: number
Returns Color
A new color instance.
- Defined in node_modules/marangi/dist/index.d.ts:64

random

random(): Color
Generate random r,g,b values for this color object.

Returns Color
- Defined in node_modules/marangi/dist/index.d.ts:76

serialize

serialize(): ColorLike
Convert this color into plain serializable data.

Returns ColorLike
A plain color object.
- Defined in node_modules/marangi/dist/index.d.ts:88

set

set(r: number, g: number, b: number, alpha?: number): this
Set this color to the specified value.
Parameters
- r: number
  Red component [0 .. 255].
- g: number
  Green component [0 .. 255].
- b: number
  Blue component [0 .. 255].
- Optionalalpha: number
  Alpha value [0.0 .. 1.0].
Returns this
This color instance.
- Defined in node_modules/marangi/dist/index.d.ts:33

`Static`add

add(color1: Color, color2: Color, out?: Color): Color
Parameters
- color1: Color
- color2: Color
- Optionalout: Color
Returns Color
- Defined in node_modules/marangi/dist/index.d.ts:107

`Static`copy

copy(color: Color, out?: Color): Color
Parameters
- color: Color
- Optionalout: Color
Returns Color
- Defined in node_modules/marangi/dist/index.d.ts:101

`Static`darken

darken(color: Color, scale: number, out?: Color): typeof Color
Parameters
- color: Color
- scale: number
- Optionalout: Color
Returns typeof Color
- Defined in node_modules/marangi/dist/index.d.ts:119

`Static`deserialize

deserialize(value: ColorLike, out?: Color): Color
Copy serializable color data into a color instance.
Parameters
- value: ColorLike
  Serialized color data.
- Optionalout: Color
  Color instance to write into.
Returns Color
The populated color instance.
- Defined in node_modules/marangi/dist/index.d.ts:158

`Static`fuzzyEqual

fuzzyEqual(color1: Color, color2: Color, tolerance?: number): boolean
Compare two colors using a tolerance.
Parameters
- color1: Color
- color2: Color
- Optionaltolerance: number
  Maximum allowed per-channel difference.
Returns boolean
Whether all components are approximately equal.
- Defined in node_modules/marangi/dist/index.d.ts:145

`Static`lerp

lerp(from: Color, to: Color, t: number, out?: Color): Color
Parameters
- from: Color
- to: Color
- t: number
- Optionalout: Color
Returns Color
- Defined in node_modules/marangi/dist/index.d.ts:132

`Static`lighten

lighten(color: Color, scale: number, out?: Color): Color
Parameters
- color: Color
- scale: number
- Optionalout: Color
Returns Color
- Defined in node_modules/marangi/dist/index.d.ts:125

`Static`random

random(out?: Color): Color
Parameters
- Optionalout: Color
Returns Color
- Defined in node_modules/marangi/dist/index.d.ts:137

`Static`serialize

serialize(value: Color): ColorLike
Convert a color instance to a serializable plain object.
Parameters
- value: Color
  Color instance to convert.
Returns ColorLike
A plain object containing the color channels.
- Defined in node_modules/marangi/dist/index.d.ts:151

`Static`set

set(r: number, g: number, b: number, a: number, color?: Color): Color
Parameters
- r: number
- g: number
- b: number
- a: number
- Optionalcolor: Color
Returns Color
- Defined in node_modules/marangi/dist/index.d.ts:96

`Static`subtract

subtract(color1: Color, color2: Color, out?: Color): Color
Parameters
- color1: Color
- color2: Color
- Optionalout: Color
Returns Color
- Defined in node_modules/marangi/dist/index.d.ts:113

`Static`validateSerial

validateSerial(value: unknown): value is ColorLike
Check whether a value matches the serialized color shape.
Parameters
- value: unknown
  Value to validate.
Returns value is ColorLike
Whether the value is a valid serialized color.
- Defined in node_modules/marangi/dist/index.d.ts:164