struct
ScreenSpaceLensFlareSettings
Settings that control the screen-space lens flare effect.
Public
Constructors
ScreenSpaceLensFlareSettings
Methods
staticGetRttiStatic
Fields
Enabled
Enables or disables the lens flare effect.
DownsampleCount
Determines how many times to downsample the scene texture before using it for lens flare effect.
Lower values will use higher resolution texture for calculating lens flare, at the cost of lower performance. Valid range is [1, 6], default is 4.
Threshold
Determines the minimal threshold of pixel luminance to be included in the lens flare calculations.
Any pixel with luminance below this value will be ignored for the purposes of lens flare. Set to zero or negative to disable the threshold and include all pixels in the calculations.
GhostCount
Determines the number of ghost features to appear, shown as blurred blobs of bright areas of the scene.
GhostSpacing
Determines the distance between ghost features.
Value is in normalized screen space, in range [0,1] where 1 represents the full screen length.
Brightness
Determines the brightness of the lens flare effect.
Value of 1 means the lens flare will be displayed at the same intensity as the scene it was derived from. In range [0, 1], default being 0.05.
FilterSize
Determines the size of the filter when blurring the lens flare features.
Larger values yield a blurrier image and will require more performance.
Halo
Determines if a halo effect should be rendered as part of the lens flare.
HaloRadius
Determines how far away from the screen center does the halo appear, in normalized screen space (range [0,1]) where 0.5 represents half screen length.
HaloThickness
Determines the thickness of the halo ring.
In normalized screen space (range [0.01,0.5]).
HaloThreshold
Determines the minimal threshold of pixel luminance to be included for halo generation.
Any pixel with luminance below this value will be ignored for the purposes of halo generation.
HaloAspectRatio
Determines the shape of the halo.
Set to value other than 1 to make the halo an oval rather than a circle.
ChromaticAberration
Enables or disables chromatic aberration of the lens flare and halo features.
Chromatic aberration separates the values of red, green and blue channels according to a user provided offset.
ChromaticAberrationOffset
Determines the distance between pixels within which to sample different channels.
The value is in UV coordinates, range [0, 1].
BicubicUpsampling
Uses a higher quality upscaling when blending the lens flare features with scene color.
Results in less blocky artifacts at a cost to performance.