Class AutoExposureSettings

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

Constructors

  • Parameters

    • OptionalisEnabled: boolean
    • OptionalhistogramPctLow: number
    • OptionalhistogramPctHigh: number
    • OptionalminEyeAdaptation: number
    • OptionalmaxEyeAdaptation: number
    • OptionaleyeAdaptationSpeedUp: number
    • OptionaleyeAdaptationSpeedDown: number

    Returns AutoExposureSettings

Properties

_eyeAdaptationSpeedDown: number
_eyeAdaptationSpeedUp: number
_histogramPctHigh: number
_histogramPctLow: number
_isEnabled: boolean
_maxEyeAdaptation: number
_minEyeAdaptation: number

Accessors

  • get eyeAdaptationSpeedDown(): number
  • 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, 50.0f].

    Returns number

  • set eyeAdaptationSpeedDown(value): void
  • Parameters

    • value: number

    Returns void

  • get eyeAdaptationSpeedUp(): number
  • 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].

    Returns number

  • set eyeAdaptationSpeedUp(value): void
  • Parameters

    • value: number

    Returns void

  • get histogramPctHigh(): number
  • 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].

    Returns number

  • set histogramPctHigh(value): void
  • Parameters

    • value: number

    Returns void

  • get histogramPctLow(): number
  • 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].

    Returns number

  • set histogramPctLow(value): void
  • Parameters

    • value: number

    Returns void

  • get isEnabled(): boolean
  • Determines should automatic exposure be applied to the HDR image. When turned on the average scene brightness will be calculated and used to automatically expose the image to the optimal range. Use the parameters provided by autoExposure to customize the automatic exposure effect. You may also use exposureScale to manually adjust the automatic exposure.

    When automatic exposure is turned off the camera's f-stop, shutter speed and ISO speed are used for determining the exposure. In that case you can also use exposureScale to further tweak the exposure.

    Returns boolean

  • set isEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get maxEyeAdaptation(): number
  • Clamps the maximum eye adaptation range 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). Represented in EV100 units. In range [-10.0f, 20.0f].

    Returns number

  • set maxEyeAdaptation(value): void
  • Parameters

    • value: number

    Returns void

  • get minEyeAdaptation(): number
  • Clamps the minimum eye adaptation range 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). Represented in EV100 units. in range [-10.0f, 20.0f].

    Returns number

  • set minEyeAdaptation(value): void
  • Parameters

    • value: number

    Returns void

Methods