docs.unity3d.com
    Show / Hide Table of Contents

    Class LensFlareComponentSRP

    Data-Driven Lens Flare can be added on any gameobeject

    Inheritance
    Object
    Object
    Component
    Behaviour
    MonoBehaviour
    LensFlareComponentSRP
    Inherited Members
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(String, Single)
    MonoBehaviour.InvokeRepeating(String, Single, Single)
    MonoBehaviour.CancelInvoke(String)
    MonoBehaviour.IsInvoking(String)
    MonoBehaviour.StartCoroutine(String)
    MonoBehaviour.StartCoroutine(String, Object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(String)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(Object)
    MonoBehaviour.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, Component)
    Component.TryGetComponent<T>(T)
    Component.GetComponent(String)
    Component.GetComponentInChildren(Type, Boolean)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(Boolean)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, Boolean)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(Boolean)
    Component.GetComponentsInChildren<T>(Boolean, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    UnityEngine.Component.GetComponentInParent(System.Type, System.Boolean)
    Component.GetComponentInParent(Type)
    UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, Boolean)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(Boolean)
    Component.GetComponentsInParent<T>(Boolean, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(String)
    Component.SendMessageUpwards(String, Object, SendMessageOptions)
    Component.SendMessageUpwards(String, Object)
    Component.SendMessageUpwards(String)
    Component.SendMessageUpwards(String, SendMessageOptions)
    Component.SendMessage(String, Object)
    Component.SendMessage(String)
    Component.SendMessage(String, Object, SendMessageOptions)
    Component.SendMessage(String, SendMessageOptions)
    Component.BroadcastMessage(String, Object, SendMessageOptions)
    Component.BroadcastMessage(String, Object)
    Component.BroadcastMessage(String)
    Component.BroadcastMessage(String, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Component.rigidbody
    Component.rigidbody2D
    Component.camera
    Component.light
    Component.animation
    Component.constantForce
    Component.renderer
    Component.audio
    Component.networkView
    Component.collider
    Component.collider2D
    Component.hingeJoint
    Component.particleSystem
    Object.GetInstanceID()
    Object.GetHashCode()
    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, Boolean)
    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, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, Boolean)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindObjectOfType(Type, Boolean)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: UnityEngine.Rendering
    Syntax
    [ExecuteAlways]
    [AddComponentMenu("Rendering/Lens Flare (SRP)")]
    public sealed class LensFlareComponentSRP : MonoBehaviour

    Fields

    allowOffScreen

    If allowOffScreen is true then If the lens flare is outside the screen we still emit the flare on screen

    Declaration
    public bool allowOffScreen
    Field Value
    Type Description
    Boolean

    attenuationByLightShape

    If component attached to a light, attenuation the lens flare per light type

    Declaration
    public bool attenuationByLightShape
    Field Value
    Type Description
    Boolean

    distanceAttenuationCurve

    Attenuation by distance

    Declaration
    public AnimationCurve distanceAttenuationCurve
    Field Value
    Type Description
    AnimationCurve

    intensity

    Intensity

    Declaration
    [Min(0F)]
    public float intensity
    Field Value
    Type Description
    Single

    maxAttenuationDistance

    Distance used to scale the Distance Attenuation Curve

    Declaration
    [Min(1E-05F)]
    public float maxAttenuationDistance
    Field Value
    Type Description
    Single

    maxAttenuationScale

    Distance used to scale the Scale Attenuation Curve

    Declaration
    [Min(1E-05F)]
    public float maxAttenuationScale
    Field Value
    Type Description
    Single

    occlusionOffset

    Z Occlusion Offset allow us to offset the plane where the disc of occlusion is place (closer to camera), value on world space. Useful for instance to sample occlusion outside a light bulb if we place a flare inside the light bulb

    Declaration
    public float occlusionOffset
    Field Value
    Type Description
    Single

    occlusionRadius

    Radius around the light used to occlude the flare (value in world space)

    Declaration
    [Min(0F)]
    public float occlusionRadius
    Field Value
    Type Description
    Single

    radialScreenAttenuationCurve

    Attenuation used radially, which allow for instance to enable flare only on the edge of the screen

    Declaration
    public AnimationCurve radialScreenAttenuationCurve
    Field Value
    Type Description
    AnimationCurve

    sampleCount

    Random Samples Count used inside the disk with 'occlusionRadius'

    Declaration
    [Range(1F, 64F)]
    public uint sampleCount
    Field Value
    Type Description
    UInt32

    scale

    Global Scale

    Declaration
    [Min(0F)]
    public float scale
    Field Value
    Type Description
    Single

    scaleByDistanceCurve

    Scale by distance, use the same distance as distanceAttenuationCurve

    Declaration
    public AnimationCurve scaleByDistanceCurve
    Field Value
    Type Description
    AnimationCurve

    useOcclusion

    Enable Occlusion feature

    Declaration
    public bool useOcclusion
    Field Value
    Type Description
    Boolean

    Properties

    lensFlareData

    Lens flare asset used on this component

    Declaration
    public LensFlareDataSRP lensFlareData { get; set; }
    Property Value
    Type Description
    LensFlareDataSRP

    Extension Methods

    ReflectionUtils.Invoke(Object, String, Object[])
    ReflectionUtils.SetField(Object, String, Object)
    ReflectionUtils.GetField(Object, String)
    ReflectionUtils.GetFields(Object)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023