Class Light`Abstract`

Class for color light manipulation.

Index

Methods

balance darken lighten

Methods

`Static`balance

balance<C extends LightnessColorSpaces>(
    color: C,
    ratio: number,
    targetGray?: number,
): C
Balance the light shifting it towards the middle gray.
Type Parameters
- C extends LightnessColorSpaces
Parameters
- color: C
  The color to balance.
- ratio: number
  The shifting ratio between 0-1.
- OptionaltargetGray: number
  Optional target gray. Default is the middle gray.
Returns C
The mapped color.

Throws
If the color space has no lightness, which is impossible if typeing is respected.
- Defined in functions/Light.ts:28

`Static`darken

darken<C extends LightnessColorSpaces>(color: C, ratio: number): C
Shift the light towards the black.
Type Parameters
- C extends LightnessColorSpaces
Parameters
- color: C
  The color to balance.
- ratio: number
  The shifting ratio between 0-1.
Returns C
The mapped color.

Throws
If the color space has no lightness, which is impossible if typeing is respected.
- Defined in functions/Light.ts:53

`Static`lighten

lighten<C extends LightnessColorSpaces>(color: C, ratio: number): C
Shift the light towards the white.
Type Parameters
- C extends LightnessColorSpaces
Parameters
- color: C
  The color to balance.
- ratio: number
  The shifting ratio between 0-1.
Returns C
The mapped color.

Throws
If the color space has no lightness, which is impossible if typeing is respected.
- Defined in functions/Light.ts:76