ToneMapping

Description

sealed class Tinman.Engine.Components.ToneMapping

Defines coefficients for HDR tone mapping.

Photographic Tone Reproduction for Digital Images
https://dl.acm.org/doi/10.1145/566654.566575

The default settings of the ToneMapping class (see Reset) will map luminance directly to displayable pixel values.

Public / Constructors

ToneMapping

public constructor ToneMapping → ()

Creates a new instance of ToneMapping.

Public / Methods

Apply

public method Apply → (1)

parameters ⁱⁿ : LightingParameters: [not-null]
The LightingParameters object to update.

Applies the current tone mapping coefficients.

Reset

public method Reset → ()

Resets the tone mapping coefficients to their default value, which produces the same result as lighting in the normalized range [0..1].

Public / Attributes

ScaleAmbient

public attribute ScaleAmbient → (get,set)

value : float64: [>=0]
The scale factor.

Custom scale factor for ambient term to apply in linear sRGB color space.

Defaults to 1.

ScaleDiffuse

public attribute ScaleDiffuse → (get,set)

value : float64: [>=0]
The scale factor.

Custom scale factor for diffuse term to apply in linear sRGB color space.

Defaults to 1.

ScaleEmissive

public attribute ScaleEmissive → (get,set)

value : float64: [>=0]
The scale factor.

Custom scale factor for emissive term to apply in linear sRGB color space.

Defaults to 1.

ScaleReflection

public attribute ScaleReflection → (get,set)

value : float64: [>=0]
The scale factor.

Custom scale factor for reflection term to apply in linear sRGB color space.

Defaults to 1.

ToneAverage

public attribute ToneAverage → (get,set)

value : float64: [>=0]
The key value.

The average scene key value, see L’w in equation (1).

Defaults to 0.18.

ToneGrey

public attribute ToneGrey → (get,set)

value : float64: [>0]
The key value.

The key value a that represents middle-grey, see equation (2).

This value can be used to fine-tune the appearance of the tone-mapped output. Defaults to 0.18.

ToneWhite

public attribute ToneWhite → (get,set)

value : float64: [>0]
The luminance for white.

The smallest luminance L_white that will be mapped to 1 i.e. pure white, see equation (4).

Defaults to 1.0.