Class Exposure

A volume component that holds settings for the Exposure effect.

Inheritance

Object

VolumeComponent

Exposure

Inherited Members

VolumeComponent.active

VolumeComponent.OnEnable()

VolumeComponent.OnDisable()

VolumeComponent.Override(VolumeComponent, Single)

VolumeComponent.SetAllOverridesTo(Boolean)

VolumeComponent.GetHashCode()

VolumeComponent.OnDestroy()

VolumeComponent.Release()

VolumeComponent.displayName

VolumeComponent.parameters

Namespace: UnityEngine.Rendering.HighDefinition

Syntax

[Serializable]
public sealed class Exposure : VolumeComponent, IPostProcessComponent

Fields

adaptationMode

Specifies the method that HDRP uses to change the exposure when the Camera moves from dark to light and vice versa. This parameter is only used when Automatic or CurveMapping is set.

Declaration

[Tooltip("Specifies the method that HDRP uses to change the exposure when the Camera moves from dark to light and vice versa.")]
public AdaptationModeParameter adaptationMode

Field Value

Type	Description
AdaptationModeParameter

adaptationSpeedDarkToLight

Sets the speed at which the exposure changes when the Camera moves from a dark area to a bright area. This parameter is only used when Automatic or CurveMapping is set.

Declaration

[Tooltip("Sets the speed at which the exposure changes when the Camera moves from a dark area to a bright area.")]
public MinFloatParameter adaptationSpeedDarkToLight

Field Value

Type	Description
MinFloatParameter

adaptationSpeedLightToDark

Sets the speed at which the exposure changes when the Camera moves from a bright area to a dark area. This parameter is only used when Automatic or CurveMapping is set.

Declaration

[Tooltip("Sets the speed at which the exposure changes when the Camera moves from a bright area to a dark area.")]
public MinFloatParameter adaptationSpeedLightToDark

Field Value

Type	Description
MinFloatParameter

compensation

Sets the compensation that the Camera applies to the calculated exposure value. This parameter is only used when any mode but Fixed is set.

Declaration

[Tooltip("Sets the compensation that the Camera applies to the calculated exposure value.")]
public FloatParameter compensation

Field Value

Type	Description
FloatParameter

curveMap

Specifies a curve that remaps the Scene exposure on the x-axis to the exposure you want on the y-axis. This parameter is only used when CurveMapping is set.

Declaration

[Tooltip("Specifies a curve that remaps the Scene exposure on the x-axis to the exposure you want on the y-axis.")]
public AnimationCurveParameter curveMap

Field Value

Type	Description
AnimationCurveParameter

fixedExposure

Sets a static exposure value for Cameras in this Volume. This parameter is only used when Fixed is set.

Declaration

[Tooltip("Sets a static exposure value for Cameras in this Volume.")]
public FloatParameter fixedExposure

Field Value

Type	Description
FloatParameter

histogramPercentages

These values are the lower and upper percentages of the histogram that will be used to find a stable average luminance. Values outside of this range will be discarded and won't contribute to the average luminance.

Declaration

[Tooltip("Sets the range of values (in terms of percentages) of the histogram that are accepted while finding a stable average exposure. Anything outside the value is discarded.")]
public FloatRangeParameter histogramPercentages

Field Value

Type	Description
FloatRangeParameter

histogramUseCurveRemapping

Sets whether histogram exposure mode will remap the computed exposure with a curve remapping (akin to Curve Remapping mode)

Declaration

[Tooltip("Sets whether histogram exposure mode will remap the computed exposure with a curve remapping (akin to Curve Remapping mode).")]
public BoolParameter histogramUseCurveRemapping

Field Value

Type	Description
BoolParameter

limitMax

Sets the maximum value that the Scene exposure can be set to. This parameter is only used when Automatic or CurveMapping is set.

Declaration

[Tooltip("Sets the maximum value that the Scene exposure can be set to.")]
public FloatParameter limitMax

Field Value

Type	Description
FloatParameter

limitMin

Sets the minimum value that the Scene exposure can be set to. This parameter is only used when Automatic or CurveMapping is set.

Declaration

[Tooltip("Sets the minimum value that the Scene exposure can be set to.")]
public FloatParameter limitMin

Field Value

Type	Description
FloatParameter

luminanceSource

Specifies the luminance source that HDRP uses to calculate the current Scene exposure.

Declaration

[Tooltip("Specifies the luminance source that HDRP uses to calculate the current Scene exposure.")]
public LuminanceSourceParameter luminanceSource

Field Value

Type	Description
LuminanceSourceParameter

See Also

LuminanceSource

meteringMode

Specifies the metering method that HDRP uses the filter the luminance source.

Declaration

[Tooltip("Specifies the metering method that HDRP uses the filter the luminance source.")]
public MeteringModeParameter meteringMode

Field Value

Type	Description
MeteringModeParameter

See Also

MeteringMode

mode

Specifies the method that HDRP uses to process exposure.

Declaration

[Tooltip("Specifies the method that HDRP uses to process exposure.")]
public ExposureModeParameter mode

Field Value

Type	Description
ExposureModeParameter

See Also

ExposureMode

weightTextureMask

Sets the texture mask used to weight the pixels in the buffer when computing exposure.

Declaration

[Tooltip("Sets the texture mask to be used to weight the pixels in the buffer for the sake of computing exposure.")]
public NoInterpTextureParameter weightTextureMask

Field Value

Type	Description
NoInterpTextureParameter

Methods

IsActive()

Tells if the effect needs to be rendered or not.

Declaration

public bool IsActive()

Returns

Type	Description
Boolean	true if the effect should be rendered, false otherwise.

Implements

IPostProcessComponent.IsActive()