Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Screen Space Lens Flare override reference for URP

Reference for the Screen Space Lens Flare override.
Read time 4 minutesLast updated 24 days ago

Refer to Add screen space lens flares for more information.

Properties

Property

Description

IntensitySet the strength of all the types of lens flares. If the value is 0, URP doesn't calculate or render any lens flares. The default is 0.
Tint ColorSet the color URP uses to tint all the types of lens flares. The default is white.
Bloom Mip BiasSet the mipmap level URP uses to sample the Bloom pyramid and create the lens flares. The higher the mipmap level, the smaller and more pixelated the sample source, and the blurrier the result. The range is 0 through 5. 0 is the full-resolution mipmap level. The default is 1. Refer to Mipmaps introduction for more information. This property only appears if you open the More (⋮) menu and select Advanced Properties.

Flares

Use the Flares settings to control regular flares, reversed flares and warped flares.

Property

Description

Regular MultiplierSet the strength of regular flares. If the value is 0, URP doesn't calculate or render regular flares. The default is 1.
Reversed MultiplierSet the strength of reversed flares. If the value is 0, URP doesn't calculate or render reversed flares. The default is 1.
Warped MultiplerSet the strength of warped flares. If the value is 0, URP doesn't calculate or render warped flares. The default is 1.
    ScaleScale the width (x) and height (y) of warped flares. The defaults are 1. This property only appears if you open the More (⋮) menu and select Advanced Properties.
SamplesSet the number of times URP repeats the regular, reversed and warped flares. The range is 1 through 3. The default is 1. Increasing Samples has a big impact on performance.
    Sample DimmerSet the strength of the lens flares URP adds if you set Samples to 2 or 3. The higher the value, the less intense the flares. This property only appears if you open the More (⋮) menu and select Advanced Properties.
Vignette EffectSet the strength of the regular, reversed and warped flares in a circular area in the center of the screen. Use Vignette Effect to avoid lens flare obscuring the scene too much. The default value is 1, which means URP doesn't render flares at the center of the screen.
Starting PositionControl how far the position of the regular, reversed and warped flares differ from the bright area they're sampled from, in metres. If the value is 0, URP places the lens flares at the same position as the bright areas they're sampled from. The range is 1 through 3. The default is 1.25.
ScaleSet the size of regular, reversed and warped lens flares. The range is 1 through 4. The default is 1.5.

Streaks

Use the Streaks settings to control flares stretched in one direction.

Property

Description

MultiplierSet the strength of streaks. If the value is 0, URP doesn't calculate or render streaks. The default is 1.
    LengthSet the length of streaks. The range is 0 through 1. 1 is the approximate width of the screen. The default value is 0.5.
    OrientationSet the angle of streaks, in degrees. The default value is 0, which creates horizontal streaks.
    ThresholdControl how localized the streak effect is. The higher the Threshold, the more localized the effect. The range is 0 through 1. The default value is 0.25.
    ResolutionControl the resolution detail of streaks. URP renders lower-resolution streaks faster. The options are Half, Quarter and Eighth full resolution. This property only appears if you open the More (⋮) menu and select Advanced Properties.

The effect of changing Threshold from 0 (a larger flare effect) to 1 (a smaller flare effect).

Chromatic Aberration

Use the Chromatic Aberration settings to control chromatic aberration on all the lens flare types. Chromatic aberration splits light into its color components, which mimics the effect that a real-world camera produces when its lens fails to join all colors to the same point.
The chromatic aberration effect is strongest at the edges of the screen, and decreases in strength towards the center of the screen.

Property

Description

IntensitySet the strength of the chromatic aberration effect. If the value is 0, URP doesn't split the colors.