struct AutoExposureSettings

Settings that control automatic exposure (eye adaptation) post-process.

Public

Constructors

AutoExposureSettings

AutoExposureSettings() = default

Methods

staticGetRttiStatic

static RTTIType *GetRttiStatic()

GetRtti

RTTIType *GetRtti() const override

Returns an interface you can use to access class' Run Time Type Information.

Fields

HistogramLog2Min

float HistogramLog2Min

Determines minimum luminance value in the eye adaptation histogram.

The histogram is used for calculating the average brightness of the scene. Any luminance value below this value will not be included in the histogram and ignored in scene brightness calculations. In log2 units (-8 = 1/256). In the range [-16, 0].

HistogramLog2Max

float HistogramLog2Max

Determines maximum luminance value in the eye adaptation histogram.

The histogram is used for calculating the average brightness of the scene. Any luminance value above this value will not be included in the histogram and ignored in scene brightness calculations. In log2 units (4 = 16). In the range [0, 16].

HistogramPctLow

float HistogramPctLow

Percentage below which to ignore values in the eye adaptation histogram.

The histogram is used for calculating the average brightness of the scene. Total luminance in the histogram will be summed up and multiplied by this value to calculate minimal luminance. Luminance values below the minimal luminance will be ignored and not used in scene brightness calculations. This allows you to remove outliers on the lower end of the histogram (for example a few very dark pixels in an otherwise bright image). In range [0.0f, 1.0f].

HistogramPctHigh

float HistogramPctHigh

Percentage above which to ignore values in the eye adaptation histogram.

The histogram is used for calculating the average brightness of the scene. Total luminance in the histogram will be summed up and multiplied by this value to calculate maximum luminance. Luminance values above the maximum luminance will be ignored and not used in scene brightness calculations. This allows you to remove outliers on the high end of the histogram (for example a few very bright pixels). In range [0.0f, 1.0f].

MinEyeAdaptation

float MinEyeAdaptation

Clamps the minimum eye adaptation scale to this value.

This allows you to limit eye adaptation so that exposure is never too high (for example when in a very dark room you probably do not want the exposure to be so high that everything is still visible). In range [0.0f, 10.0f].

MaxEyeAdaptation

float MaxEyeAdaptation

Clamps the maximum eye adaptation scale to this value.

This allows you to limit eye adaptation so that exposure is never too low (for example when looking at a very bright light source you probably don't want the exposure to be so low that the rest of the scene is all white (overexposed). In range [0.0f, 10.0f].

EyeAdaptationSpeedUp

float EyeAdaptationSpeedUp

Determines how quickly does the eye adaptation adjust to larger values.

This affects how quickly does the automatic exposure changes when the scene brightness increases. In range [0.01f, 20.0f].

EyeAdaptationSpeedDown

float EyeAdaptationSpeedDown

Determines how quickly does the eye adaptation adjust to smaller values.

This affects how quickly does the automatic exposure changes when the scene brightness decreases. In range [0.01f, 20.0f].