Class LensFlareDataElementSRP

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

Inheritance
object
LensFlareDataElementSRP
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
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
bool

angularOffset

Angular offset

Declaration
public float angularOffset
Field Value
Type Description
float

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
bool

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
bool

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
bool

flareType

FlareType used

Declaration
public SRPLensFlareType flareType
Field Value
Type Description
SRPLensFlareType

hoopFactor

Hoop thickness

Declaration
[Range(-1, 1)]
public float hoopFactor
Field Value
Type Description
float

inverseSDF

Inverse the gradient direction.

Declaration
public bool inverseSDF
Field Value
Type Description
bool

lengthSpread

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

Declaration
public float lengthSpread
Field Value
Type Description
float

lensFlareDataSRP

Current Element is himselft another LensFlareDataSRP

Declaration
public LensFlareDataSRP lensFlareDataSRP
Field Value
Type Description
LensFlareDataSRP

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
bool

noiseAmplitude

Noise parameter amplitude

Declaration
public float noiseAmplitude
Field Value
Type Description
float

noiseFrequency

Noise parameter frequency

Declaration
public int noiseFrequency
Field Value
Type Description
int

noiseSpeed

Noise parameter Speed

Declaration
public float noiseSpeed
Field Value
Type Description
float

position

Position

Declaration
public float position
Field Value
Type Description
float

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
bool

ringThickness

Ring thickness

Declaration
[Range(0, 1)]
public float ringThickness
Field Value
Type Description
float

rotation

Local rotation of the texture

Declaration
public float rotation
Field Value
Type Description
float

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
float

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
float

seed

Seed used to seed randomness

Declaration
public int seed
Field Value
Type Description
int

shapeCutOffRadius

To simulate the cutoff of the flare by the circular shape of the lens.

Declaration
public float shapeCutOffRadius
Field Value
Type Description
float

shapeCutOffSpeed

To simulate the cutoff of the flare by the circular shape of the lens. How quickly this cutoff happen.

Declaration
public float shapeCutOffSpeed
Field Value
Type Description
float

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

tintColorType

Specify how to tint flare.

Declaration
public SRPLensFlareColorType tintColorType
Field Value
Type Description
SRPLensFlareColorType

tintGradient

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

Declaration
public TextureGradient tintGradient
Field Value
Type Description
TextureGradient

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
float

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
float

visible

Visibility checker for current element

Declaration
public bool visible
Field Value
Type Description
bool

Properties

count

Element can be repeated 'count' times

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

edgeOffset

Gradient Offset used for the Procedural Flare.

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

fallOff

Fall of the gradient used for the Procedural Flare.

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

intensityVariation

Scale factor applied on the variation of the intensities.

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

localIntensity

Intensity of this element

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

sdfRoundness

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

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

sideCount

Side count of the regular polygon generated.

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

Methods

Clone()

Clone the current LensFlareDataElementSRP.

Declaration
public LensFlareDataElementSRP Clone()
Returns
Type Description
LensFlareDataElementSRP

Cloned LensFlareDataElementSRP.

Extension Methods