docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class ScreenSpaceLensFlare

    A volume component that holds settings for the Screen Space Lens Flare effect.

    Inheritance
    object
    Object
    ScriptableObject
    VolumeComponent
    ScreenSpaceLensFlare
    Implements
    IApplyRevertPropertyContextMenuItemProvider
    IPostProcessComponent
    Inherited Members
    VolumeComponent.active
    VolumeComponent.displayName
    VolumeComponent.parameters
    VolumeComponent.OnEnable()
    VolumeComponent.OnDisable()
    VolumeComponent.Override(VolumeComponent, float)
    VolumeComponent.SetAllOverridesTo(bool)
    VolumeComponent.GetHashCode()
    VolumeComponent.AnyPropertiesIsOverridden()
    VolumeComponent.OnDestroy()
    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.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: UnityEngine.Rendering.HighDefinition
    Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
    Syntax
    [Serializable]
    [VolumeComponentMenu("Post-processing/Screen Space Lens Flare")]
    [SupportedOnRenderPipeline(typeof(HDRenderPipelineAsset))]
    public class ScreenSpaceLensFlare : VolumeComponent, IApplyRevertPropertyContextMenuItemProvider, IPostProcessComponent

    Constructors

    Name Description
    ScreenSpaceLensFlare()

    Default constructor for the lens flare volume component.

    Fields

    Name Description
    bloomMip

    Controls the bloom Mip used as a source for the Lens Flare effect. A high value will result in a blurrier result for all flares.

    chromaticAbberationIntensity

    Controls the strength of the Chromatic Aberration effect. The higher the value, the more light is dispersed on the sides of the screen

    chromaticAbberationSampleCount

    Controls the number of samples HDRP uses to render the Chromatic Aberration effect. A lower sample number results in better performance.

    firstFlareIntensity

    Controls the intensity of the Regular Flare sample. Those flares are sampled using scaled screen coordinates.

    intensity

    Sets the global intensity of the Screen Space Lens Flare effect. When set to 0, the pass is skipped.

    resolution

    Specifies the resolution at which the streak effect is evaluated.

    sampleDimmer

    Controls the value by which each additionnal sample is multiplied. A value of 1 keep the same intensities for all samples. A value of 0.7 multiplies the first sample by 1 (0.7 power 0), the second sample by 0.7 (0.7 power 1) and the third sample by 0.49 (0.7 power 2).

    samples

    Controls the number of times the flare effect is repeated for each flare type (regular, reversed, warped). This parameter has a strong impact on performance.

    scale

    Controls the scale at which the flares are sampled. This parameter only impacts regular, reversed and warped flares.

    secondaryFlareIntensity

    Controls the intensity of the Reversed Flare sample. Those flares are sampled using scaled and flipped screen coordinates.

    spectralLut

    Specifies a Texture which HDRP uses to shift the hue of chromatic aberrations. If null, HDRP creates a default texture.

    startingPosition

    Controls the starting position of the flares in screen space relative to their source. This parameter only impacts regular, reversed and warped flares.

    streaksIntensity

    Controls the intensity of streaks effect. This effect has an impact on performance when above zero. When this intensity is zero, this effect is not evaluated to save costs.

    streaksLength

    Controls the length of streaks effect. A value of one creates streaks about the width of the screen.

    streaksOrientation

    Controls the orientation of streaks effect in degrees. A value of 0 produces horizontal streaks.

    streaksThreshold

    Controls the threshold of horizontal streak effect. A high value makes the effect more localised on the high intensity areas of the screen.

    tintColor

    Sets the color used to tint all the flares.

    vignetteEffect

    Controls the intensity of the vignette effect to occlude the Lens Flare effect at the center of the screen. This parameter only impacts regular, reversed and warped flares.

    warpedFlareIntensity

    Controls the intensity of the Warped Flare sample. Those flares are sampled using polar screen coordinates.

    warpedFlareScale

    Sets the scale of the Warped Flare sample. A value of 1,1 will keep this flare circular.

    Methods

    Name Description
    IsActive()

    Mandatory function, cannot have an Override without it

    IsStreaksActive()

    Returns true is streakIntensity is above zero.

    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)