docs.unity3d.com
    Show / Hide Table of Contents

    Class LensFlareDataElementSRP

    LensFlareDataElementSRP defines collection of parameters describing the behavior a Lens Flare Element.

    Inheritance
    Object
    LensFlareDataElementSRP
    Namespace: UnityEngine.Rendering
    Syntax
    [Serializable]
    public sealed class LensFlareDataElementSRP

    Constructors

    LensFlareDataElementSRP()

    Initialize default values

    Declaration
    public LensFlareDataElementSRP()

    Fields

    allowMultipleElement

    Enable multiple elements

    Declaration
    public bool allowMultipleElement
    Field Value
    Type Description
    Boolean

    angularOffset

    Angular offset

    Declaration
    public float angularOffset
    Field Value
    Type Description
    Single

    autoRotate

    Rotate the texture relative to the angle on the screen (the rotation will be added to the parameter 'rotation')

    Declaration
    public bool autoRotate
    Field Value
    Type Description
    Boolean

    blendMode

    Blend mode used

    Declaration
    public SRPLensFlareBlendMode blendMode
    Field Value
    Type Description
    SRPLensFlareBlendMode

    colorGradient

    Colors used uniformly for Uniform or Curve Distribution and Random when the distribution is 'Random'.

    Declaration
    public Gradient colorGradient
    Field Value
    Type Description
    Gradient

    distortionCurve

    Curve blending from screen center to the edges of the screen.

    Declaration
    public AnimationCurve distortionCurve
    Field Value
    Type Description
    AnimationCurve

    distortionRelativeToCenter

    If true the distortion is relative to center of the screen otherwise relative to lensFlare source screen position.

    Declaration
    public bool distortionRelativeToCenter
    Field Value
    Type Description
    Boolean

    distribution

    SRPLensFlareDistribution defined how we spread the flare element when count > 1

    Declaration
    public SRPLensFlareDistribution distribution
    Field Value
    Type Description
    SRPLensFlareDistribution

    enableRadialDistortion

    True to use or not the radial distortion.

    Declaration
    public bool enableRadialDistortion
    Field Value
    Type Description
    Boolean

    flareType

    FlareType used

    Declaration
    public SRPLensFlareType flareType
    Field Value
    Type Description
    SRPLensFlareType

    inverseSDF

    Inverse the gradient direction.

    Declaration
    public bool inverseSDF
    Field Value
    Type Description
    Boolean

    lengthSpread

    Length to spread the distribution of flares, spread start at 'starting position'

    Declaration
    public float lengthSpread
    Field Value
    Type Description
    Single

    lensFlareTexture

    Texture used to for this Lens Flare Element

    Declaration
    public Texture lensFlareTexture
    Field Value
    Type Description
    Texture

    modulateByLightColor

    Modulate by light color if the asset is used in a 'SRP Lens Flare Source Override'

    Declaration
    public bool modulateByLightColor
    Field Value
    Type Description
    Boolean

    position

    Position

    Declaration
    public float position
    Field Value
    Type Description
    Single

    positionCurve

    Curve describing how to place flares distribution (Used only for Uniform and Curve 'distribution')

    Declaration
    public AnimationCurve positionCurve
    Field Value
    Type Description
    AnimationCurve

    positionOffset

    Position offset

    Declaration
    public Vector2 positionOffset
    Field Value
    Type Description
    Vector2

    positionVariation

    Scale factor applied on the variation of the positions.

    Declaration
    public Vector2 positionVariation
    Field Value
    Type Description
    Vector2

    preserveAspectRatio

    Preserve Aspect Ratio

    Declaration
    public bool preserveAspectRatio
    Field Value
    Type Description
    Boolean

    rotation

    Local rotation of the texture

    Declaration
    public float rotation
    Field Value
    Type Description
    Single

    rotationVariation

    Scale factor applied on the variation of the rotation (relative to the current rotation or auto-rotate).

    Declaration
    public float rotationVariation
    Field Value
    Type Description
    Single

    scaleCurve

    Curve describing how to scale flares distribution (Used only for Uniform and Curve 'distribution')

    Declaration
    public AnimationCurve scaleCurve
    Field Value
    Type Description
    AnimationCurve

    scaleVariation

    Coefficient applied on the variation of the scale (relative to the current scale).

    Declaration
    public float scaleVariation
    Field Value
    Type Description
    Single

    seed

    Seed used to seed randomness

    Declaration
    public int seed
    Field Value
    Type Description
    Int32

    sizeXY

    Scale size on each dimension

    Declaration
    public Vector2 sizeXY
    Field Value
    Type Description
    Vector2

    targetSizeDistortion

    Target size used on the edge of the screen.

    Declaration
    public Vector2 targetSizeDistortion
    Field Value
    Type Description
    Vector2

    tint

    Tint of the texture can be modulated by the light we are attached to

    Declaration
    public Color tint
    Field Value
    Type Description
    Color

    translationScale

    Translation Scale

    Declaration
    public Vector2 translationScale
    Field Value
    Type Description
    Vector2

    uniformAngle

    Uniform angle (in degrees) used with multiple element enabled with Uniform distribution.

    Declaration
    public float uniformAngle
    Field Value
    Type Description
    Single

    uniformAngleCurve

    Uniform angle (remap from -180.0f to 180.0f) used with multiple element enabled with Curve distribution.

    Declaration
    public AnimationCurve uniformAngleCurve
    Field Value
    Type Description
    AnimationCurve

    uniformScale

    Uniform scale applied

    Declaration
    public float uniformScale
    Field Value
    Type Description
    Single

    visible

    Visibility checker for current element

    Declaration
    public bool visible
    Field Value
    Type Description
    Boolean

    Properties

    count

    Element can be repeated 'count' times

    Declaration
    public int count { get; set; }
    Property Value
    Type Description
    Int32

    edgeOffset

    Gradient Offset used for the Procedural Flare.

    Declaration
    public float edgeOffset { get; set; }
    Property Value
    Type Description
    Single

    fallOff

    Fall of the gradient used for the Procedural Flare.

    Declaration
    public float fallOff { get; set; }
    Property Value
    Type Description
    Single

    intensityVariation

    Scale factor applied on the variation of the intensities.

    Declaration
    public float intensityVariation { get; set; }
    Property Value
    Type Description
    Single

    localIntensity

    Intensity of this element

    Declaration
    public float localIntensity { get; set; }
    Property Value
    Type Description
    Single

    sdfRoundness

    Roundness of the polygon flare (0: Sharp Polygon, 1: Circle).

    Declaration
    public float sdfRoundness { get; set; }
    Property Value
    Type Description
    Single

    sideCount

    Side count of the regular polygon generated.

    Declaration
    public int sideCount { get; set; }
    Property Value
    Type Description
    Int32

    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