Class ToneMapper`Abstract`

Functions to manipulate the tone of a color.

Index

Methods

acesLuminance acesRgb agX map reinhard

Methods

`Static`acesLuminance

acesLuminance<C extends Xyz | Oklch | XyzD50>(color: C, exposure?: number): C
Map the tone using the ACES Luminance algorithm.
Type Parameters
- C extends Xyz | Oklch | XyzD50
Parameters
- color: C
  The color to map.
- Optionalexposure: number
  The exposure coefficient.
Returns C
The mapped color.

Throws
If the input color space is invalid, which should never happen if respecting the typeing.
- Defined in functions/ToneMapper.ts:115

`Static`acesRgb

acesRgb<C extends AcesCg | LinearRgb>(color: C, exposure?: number): C
Map the tone using the ACES RGB Narkowicz algorithm. This gives a "filmic" look.
Type Parameters
- C extends AcesCg | LinearRgb
Parameters
- color: C
  The color to map.
- exposure: number = 1.0
  The exposure coefficient.
Returns C
The mapped color.
- Defined in functions/ToneMapper.ts:156

`Static`agX

agX(color: LinearRgb, exposure?: number, look?: AgxLook): LinearRgb
Map the tone using the AGX algorithm.
Parameters
- color: LinearRgb
  The color to map.
- exposure: number = 1.0
  The exposure coefficient.
- look: AgxLook = "standard"
  The output look.
Returns LinearRgb
The mapped color.
- Defined in functions/ToneMapper.ts:193

`Static`map

map<C extends Xyz | Oklch | XyzD50>(
    color: C,
    opts:
        | _ToFullPartial<AcesLuminanceToneMapOpts>
        | _ToFullPartial<ReinhardToneMapOpts>,
): C
Type Parameters
- C extends Xyz | Oklch | XyzD50
Parameters
- color: C
- opts: _ToFullPartial<AcesLuminanceToneMapOpts> | _ToFullPartial<ReinhardToneMapOpts>
Returns C
- Defined in functions/ToneMapper.ts:267
map(color: LinearRgb, opts: _ToFullPartial<AgxToneMapOpts>): LinearRgb
Parameters
- color: LinearRgb
- opts: _ToFullPartial<AgxToneMapOpts>
Returns LinearRgb
- Defined in functions/ToneMapper.ts:273
map<C extends AcesCg | LinearRgb>(
color: C,
opts: _ToFullPartial<AcesRgbToneMapOpts>,
): C
Type Parameters
- C extends AcesCg | LinearRgb
Parameters
- color: C
- opts: _ToFullPartial<AcesRgbToneMapOpts>
Returns C
- Defined in functions/ToneMapper.ts:278
map<C extends Xyz | Oklch | XyzD50>(
color: C,
opts?: FullPartial<Omit<ReinhardToneMapOpts, "fn">>,
): C
Type Parameters
- C extends Xyz | Oklch | XyzD50
Parameters
- color: C
- Optionalopts: FullPartial<Omit<ReinhardToneMapOpts, "fn">>
Returns C
- Defined in functions/ToneMapper.ts:284
map<C extends Color>(color: C, opts?: FullPartial<ToneMapOpts>): C
Type Parameters
- C extends Color
Parameters
- color: C
- Optionalopts: FullPartial<ToneMapOpts>
Returns C
- Defined in functions/ToneMapper.ts:289

`Static`reinhard

reinhard<C extends Xyz | Oklch | XyzD50>(
    color: C,
    exposure?: number,
    maxWhite?: number,
): C
Map the tone using the Reinhard algorithm.
Type Parameters
- C extends Xyz | Oklch | XyzD50
Parameters
- color: C
  The color to map.
- exposure: number = 1.0
  The exposure coefficient.
- maxWhite: number = 1.0
  The maximum white value.
Returns C
The mapped color.

Throws
If the input color space is invalid, which should never happen if respecting the typeing.
- Defined in functions/ToneMapper.ts:368