Class Exposure

A volume component that holds settings for the Exposure effect.

Inheritance
object
Object
ScriptableObject
VolumeComponent
Exposure
Implements
IPostProcessComponent
Inherited Members
VolumeComponent.active
VolumeComponent.displayName
VolumeComponent.parameters
VolumeComponent.GetHashCode()
VolumeComponent.AnyPropertiesIsOverridden()
VolumeComponent.Release()
VolumeComponent.GetSourceTerm()
ScriptableObject.SetDirty()
ScriptableObject.CreateInstance<T>()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[Serializable]
[VolumeComponentMenu("Exposure")]
[SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))]
public sealed class Exposure : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider, 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
[Header("Adaptation")]
[Tooltip("Specifies the method that HDRP uses to change the exposure when the Camera moves from dark to light and vice versa. Progressive Adaptation in scene view requires Always Refresh.")]
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

centerAroundExposureTarget

Sets whether the procedural metering mask is centered around the exposure target (to be set on the camera)

Declaration
[Header("Procedural Mask")]
[Tooltip("Sets whether histogram exposure mode will remap the computed exposure with a curve remapping (akin to Curve Remapping mode).")]
public BoolParameter centerAroundExposureTarget
Field Value
Type Description
BoolParameter

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
[Header("Histogram")]
[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

limitMaxCurveMap

Specifies a curve that determines for each current exposure value (x-value) what maximum value is allowed to auto-adaptation (y-axis). This parameter is only used when CurveMapping is set.

Declaration
[Tooltip("Specifies a curve that determines for each current exposure value (x-value) what maximum value is allowed to auto-adaptation (y-axis).")]
public AnimationCurveParameter limitMaxCurveMap
Field Value
Type Description
AnimationCurveParameter

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

limitMinCurveMap

Specifies a curve that determines for each current exposure value (x-value) what minimum value is allowed to auto-adaptation (y-axis). This parameter is only used when CurveMapping is set.

Declaration
[Tooltip("Specifies a curve that determines for each current exposure value (x-value) what minimum value is allowed to auto-adaptation (y-axis).")]
public AnimationCurveParameter limitMinCurveMap
Field Value
Type Description
AnimationCurveParameter

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

maskMaxIntensity

All pixels above this threshold (in EV100 units) will be assigned a weight of 0 in the metering mask.

Declaration
[Tooltip("All pixels above this threshold (in EV100 units) will be assigned a weight of 0 in the metering mask.")]
public FloatParameter maskMaxIntensity
Field Value
Type Description
FloatParameter

maskMinIntensity

All pixels below this threshold (in EV100 units) will be assigned a weight of 0 in the metering mask.

Declaration
[Tooltip("All pixels below this threshold (in EV100 units) will be assigned a weight of 0 in the metering mask.")]
public FloatParameter maskMinIntensity
Field Value
Type Description
FloatParameter

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

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

proceduralCenter

Sets the center of the procedural metering mask ([0,0] being bottom left of the screen and [1,1] top right of the screen)

Declaration
public NoInterpVector2Parameter proceduralCenter
Field Value
Type Description
NoInterpVector2Parameter

proceduralRadii

Sets the radii of the procedural mask, in terms of fraction of half the screen (i.e. 0.5 means a mask that stretch half of the screen in both directions).

Declaration
public NoInterpVector2Parameter proceduralRadii
Field Value
Type Description
NoInterpVector2Parameter

proceduralSoftness

Sets the softness of the mask, the higher the value the less influence is given to pixels at the edge of the mask.

Declaration
public NoInterpMinFloatParameter proceduralSoftness
Field Value
Type Description
NoInterpMinFloatParameter

targetMidGray

Sets the desired Mid gray level used by the auto exposure (i.e. to what grey value the auto exposure system maps the average scene luminance). Note that the lens model used in HDRP is not of a perfect lens, hence it will not map precisely to the selected value.

Declaration
[Tooltip("Sets the desired Mid gray level used by the auto exposure (i.e. to what grey value the auto exposure system maps the average scene luminance).")]
public TargetMidGrayParameter targetMidGray
Field Value
Type Description
TargetMidGrayParameter

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 Texture2DParameter weightTextureMask
Field Value
Type Description
Texture2DParameter

Methods

IsActive()

Tells if the effect needs to be rendered or not.

Declaration
public bool IsActive()
Returns
Type Description
bool

true if the effect should be rendered, false otherwise.

Implements

UnityEngine.Rendering.IPostProcessComponent