unreal.CameraExposureSettings

class unreal.CameraExposureSettings(method=AutoExposureMethod.AEM_HISTOGRAM, low_percent=10.0, high_percent=90.0, min_brightness=0.03, max_brightness=8.0, speed_up=3.0, speed_down=1.0, bias=1.0, bias_curve=None, meter_mask=None, histogram_log_min=- 8.0, histogram_log_max=4.0, calibration_constant=18.0, apply_physical_camera_exposure=False)

Bases: unreal.StructBase

Camera Exposure Settings

C++ Source:

  • Module: Engine

  • File: Scene.h

Editor Properties: (see get_editor_property/set_editor_property)

  • apply_physical_camera_exposure (bool): [Read-Write] Apply Physical Camera Exposure: Enables physical camera exposure using ShutterSpeed/ISO/Aperture.

  • bias (float): [Read-Write] Bias: Logarithmic adjustment for the exposure. Only used if a tonemapper is specified. 0: no adjustment, -1:2x darker, -2:4x darker, 1:2x brighter, 2:4x brighter, …

  • bias_curve (CurveFloat): [Read-Write] Bias Curve: Exposure compensation based on the scene EV100. Used to calibrate the final exposure differently depending on the average scene luminance. 0: no adjustment, -1:2x darker, -2:4x darker, 1:2x brighter, 2:4x brighter, …

  • calibration_constant (float): [Read-Write] Calibration Constant: Calibration constant for 18% albedo.

  • high_percent (float): [Read-Write] High Percent: The eye adaptation will adapt to a value extracted from the luminance histogram of the scene color. The value is defined as having x percent below this brightness. Higher values give bright spots on the screen more priority but can lead to less stable results. Lower values give the medium and darker values more priority but might cause burn out of bright spots. >0, <100, good values are in the range 80 .. 95

  • histogram_log_max (float): [Read-Write] Histogram Log Max: temporary exposed until we found good values 4: 16, 8: 256

  • histogram_log_min (float): [Read-Write] Histogram Log Min: temporary exposed until we found good values, -8: 1/256, -10: 1/1024

  • low_percent (float): [Read-Write] Low Percent: The eye adaptation will adapt to a value extracted from the luminance histogram of the scene color. The value is defined as having x percent below this brightness. Higher values give bright spots on the screen more priority but can lead to less stable results. Lower values give the medium and darker values more priority but might cause burn out of bright spots. >0, <100, good values are in the range 70 .. 80

  • max_brightness (float): [Read-Write] Max Brightness: A good value should be positive (2 is a good value). This is the maximum brightness the auto exposure can adapt to. It should be tweaked in a bright lighting situation (too small: image appears too bright, too large: image appears too dark). Note: Tweaking emissive materials and lights or tweaking auto exposure can look the same. Tweaking auto exposure has global effect and defined the HDR range - you don’t want to change that late in the project development. Eye Adaptation is disabled if MinBrightness = MaxBrightness

  • meter_mask (Texture): [Read-Write] Meter Mask: Exposure metering mask. Bright spots on the mask will have high influence on auto-exposure metering and dark spots will have low influence.

  • method (AutoExposureMethod): [Read-Write] Method: Luminance computation method

  • min_brightness (float): [Read-Write] Min Brightness: A good value should be positive near 0. This is the minimum brightness the auto exposure can adapt to. It should be tweaked in a dark lighting situation (too small: image appears too bright, too large: image appears too dark). Note: Tweaking emissive materials and lights or tweaking auto exposure can look the same. Tweaking auto exposure has global effect and defined the HDR range - you don’t want to change that late in the project development. Eye Adaptation is disabled if MinBrightness = MaxBrightness

  • speed_down (float): [Read-Write] Speed Down: In F-stops per second, should be >0

  • speed_up (float): [Read-Write] Speed Up: In F-stops per second, should be >0

property apply_physical_camera_exposure

[Read-Write] Apply Physical Camera Exposure: Enables physical camera exposure using ShutterSpeed/ISO/Aperture.

Type

(bool)

property bias

[Read-Write] Bias: Logarithmic adjustment for the exposure. Only used if a tonemapper is specified. 0: no adjustment, -1:2x darker, -2:4x darker, 1:2x brighter, 2:4x brighter, …

Type

(float)

property bias_curve

[Read-Write] Bias Curve: Exposure compensation based on the scene EV100. Used to calibrate the final exposure differently depending on the average scene luminance. 0: no adjustment, -1:2x darker, -2:4x darker, 1:2x brighter, 2:4x brighter, …

Type

(CurveFloat)

property calibration_constant

[Read-Write] Calibration Constant: Calibration constant for 18% albedo.

Type

(float)

property high_percent

[Read-Write] High Percent: The eye adaptation will adapt to a value extracted from the luminance histogram of the scene color. The value is defined as having x percent below this brightness. Higher values give bright spots on the screen more priority but can lead to less stable results. Lower values give the medium and darker values more priority but might cause burn out of bright spots. >0, <100, good values are in the range 80 .. 95

Type

(float)

property histogram_log_max

[Read-Write] Histogram Log Max: temporary exposed until we found good values 4: 16, 8: 256

Type

(float)

property histogram_log_min

[Read-Write] Histogram Log Min: temporary exposed until we found good values, -8: 1/256, -10: 1/1024

Type

(float)

property low_percent

[Read-Write] Low Percent: The eye adaptation will adapt to a value extracted from the luminance histogram of the scene color. The value is defined as having x percent below this brightness. Higher values give bright spots on the screen more priority but can lead to less stable results. Lower values give the medium and darker values more priority but might cause burn out of bright spots. >0, <100, good values are in the range 70 .. 80

Type

(float)

property max_brightness

[Read-Write] Max Brightness: A good value should be positive (2 is a good value). This is the maximum brightness the auto exposure can adapt to. It should be tweaked in a bright lighting situation (too small: image appears too bright, too large: image appears too dark). Note: Tweaking emissive materials and lights or tweaking auto exposure can look the same. Tweaking auto exposure has global effect and defined the HDR range - you don’t want to change that late in the project development. Eye Adaptation is disabled if MinBrightness = MaxBrightness

Type

(float)

property meter_mask

[Read-Write] Meter Mask: Exposure metering mask. Bright spots on the mask will have high influence on auto-exposure metering and dark spots will have low influence.

Type

(Texture)

property method

[Read-Write] Method: Luminance computation method

Type

(AutoExposureMethod)

property min_brightness

[Read-Write] Min Brightness: A good value should be positive near 0. This is the minimum brightness the auto exposure can adapt to. It should be tweaked in a dark lighting situation (too small: image appears too bright, too large: image appears too dark). Note: Tweaking emissive materials and lights or tweaking auto exposure can look the same. Tweaking auto exposure has global effect and defined the HDR range - you don’t want to change that late in the project development. Eye Adaptation is disabled if MinBrightness = MaxBrightness

Type

(float)

property speed_down

[Read-Write] Speed Down: In F-stops per second, should be >0

Type

(float)

property speed_up

[Read-Write] Speed Up: In F-stops per second, should be >0

Type

(float)