Class Saturation`Abstract`

Functions to manipulate color saturation.

Index

Methods

balance decrease increase toGrayscale

Methods

`Static`balance

balance<C extends ChromaColorSpaces>(
    color: C,
    ratio: number,
    targetChroma?: number,
): C
Balance the saturation pushing it towards a middle saturation.
Type Parameters
- C extends ChromaColorSpaces
Parameters
- color: C
  The color to manipulate.
- ratio: number
  The shift ratio.
- OptionaltargetChroma: number
  Optional chroma "middle value".
Returns C
The manipulated color.

Throws
If the color space has no chroma, which is impossible if typeing is respected.

Throws
If the chroma is unbounded.
- Defined in functions/Saturation.ts:30

`Static`decrease

decrease<C extends ChromaColorSpaces>(
    color: C,
    ratio: number,
    targetChroma?: number,
): C
Decrease the saturation.
Type Parameters
- C extends ChromaColorSpaces
Parameters
- color: C
  The color to manipulate.
- ratio: number
  The shift ratio.
- OptionaltargetChroma: number
  Optional min chroma.
Returns C
The manipulated color.

Throws
If the color space has no chroma, which is impossible if typeing is respected.

Throws
If the chroma is unbounded.
- Defined in functions/Saturation.ts:70

`Static`increase

increase<C extends ChromaColorSpaces>(
    color: C,
    ratio: number,
    targetChroma?: number,
): C
Increase the saturation.
Type Parameters
- C extends ChromaColorSpaces
Parameters
- color: C
  The color to manipulate.
- ratio: number
  The shift ratio.
- OptionaltargetChroma: number
  Optional max chroma.
Returns C
The manipulated color.

Throws
If the color space has no chroma, which is impossible if typeing is respected.

Throws
If the chroma is unbounded.
- Defined in functions/Saturation.ts:103

`Static`toGrayscale

toGrayscale<C extends ChromaColorSpaces>(color: C): C
Map the coor to the gray scale.
Type Parameters
- C extends ChromaColorSpaces
Parameters
- color: C
  The color to manipulate.
Returns C
The manipulated color.
- Defined in functions/Saturation.ts:131