docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class Exposure

    A volume component that holds settings for the Exposure effect.

    Inheritance
    object
    Object
    ScriptableObject
    VolumeComponent
    Exposure
    Implements
    IApplyRevertPropertyContextMenuItemProvider
    IPostProcessComponent
    Inherited Members
    VolumeComponent.active
    VolumeComponent.displayName
    VolumeComponent.parameters
    VolumeComponent.Override(VolumeComponent, float)
    VolumeComponent.SetAllOverridesTo(bool)
    VolumeComponent.GetHashCode()
    VolumeComponent.AnyPropertiesIsOverridden()
    VolumeComponent.Release()
    VolumeComponent.TryGetRevertMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)
    VolumeComponent.GetSourceTerm()
    VolumeComponent.TryGetApplyMethodForFieldName(SerializedProperty, out Action<SerializedProperty>)
    VolumeComponent.GetSourceName(Component)
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(string)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.Equals(object)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    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

    Name Description
    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.

    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.

    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.

    centerAroundExposureTarget

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

    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.

    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.

    fixedExposure

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

    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.

    histogramUseCurveRemapping

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

    limitMax

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

    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.

    limitMin

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

    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.

    luminanceSource

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

    maskMaxIntensity

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

    maskMinIntensity

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

    meteringMode

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

    mode

    Specifies the method that HDRP uses to process exposure.

    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)

    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).

    proceduralSoftness

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

    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.

    weightTextureMask

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

    Methods

    Name Description
    IsActive()

    Tells if the effect needs to be rendered or not.

    In This Article
    Back to top
    Copyright © 2023 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)