Class ScreenSpaceLensFlareSettings

Settings that control the screen-space lens flare effect.

Constructors

  • Parameters

    • OptionalisEnabled: boolean
    • OptionaldownscaleFactor: number
    • Optionalthreshold: number
    • OptionalghostCount: number
    • OptionalghostSpacing: number
    • Optionalbrightness: number
    • OptionalfilterSize: number
    • OptionalisUsingHaloEffect: boolean
    • OptionalhaloRadius: number
    • OptionalhaloThickness: number
    • OptionalhaloThreshold: number
    • OptionalhaloAspectRatio: number
    • OptionalisUsingChromaticAberration: boolean
    • OptionalchromaticAberrationOffset: number
    • OptionalisUsingBicubicUpsampling: boolean

    Returns ScreenSpaceLensFlareSettings

Properties

_brightness: number
_chromaticAberrationOffset: number
_downscaleFactor: number
_filterSize: number
_ghostCount: number
_ghostSpacing: number
_haloAspectRatio: number
_haloRadius: number
_haloThickness: number
_haloThreshold: number
_isEnabled: boolean
_isUsingBicubicUpsampling: boolean
_isUsingChromaticAberration: boolean
_isUsingHaloEffect: boolean
_threshold: number

Accessors

  • get brightness(): number
  • 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.

    Returns number

  • set brightness(value): void
  • Parameters

    • value: number

    Returns void

  • get chromaticAberrationOffset(): number
  • Determines the distance between pixels within which to sample different channels. The value is in UV coordinates, range [0, 1].

    Returns number

  • set chromaticAberrationOffset(value): void
  • Parameters

    • value: number

    Returns void

  • get downscaleFactor(): number
  • 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.

    Returns number

  • set downscaleFactor(value): void
  • Parameters

    • value: number

    Returns void

  • get filterSize(): number
  • Determines the size of the filter when blurring the lens flare features. Larger values yield a blurrier image and will require more performance.

    Returns number

  • set filterSize(value): void
  • Parameters

    • value: number

    Returns void

  • get ghostCount(): number
  • Determines the number of ghost features to appear, shown as blurred blobs of bright areas of the scene.

    Returns number

  • set ghostCount(value): void
  • Parameters

    • value: number

    Returns void

  • get ghostSpacing(): number
  • Determines the distance between ghost features. Value is in normalized screen space, in range [0,1] where 1 represents the full screen length.

    Returns number

  • set ghostSpacing(value): void
  • Parameters

    • value: number

    Returns void

  • get haloAspectRatio(): number
  • Determines the shape of the halo. Set to value other than 1 to make the halo an oval rather than a circle.

    Returns number

  • set haloAspectRatio(value): void
  • Parameters

    • value: number

    Returns void

  • get haloRadius(): number
  • 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.

    Returns number

  • set haloRadius(value): void
  • Parameters

    • value: number

    Returns void

  • get haloThickness(): number
  • Determines the thickness of the halo ring. In normalized screen space (range [0.01,0.5]).

    Returns number

  • set haloThickness(value): void
  • Parameters

    • value: number

    Returns void

  • get haloThreshold(): number
  • 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.

    Returns number

  • set haloThreshold(value): void
  • Parameters

    • value: number

    Returns void

  • get isEnabled(): boolean
  • Enables or disables the lens flare effect.

    Returns boolean

  • set isEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isUsingBicubicUpsampling(): boolean
  • Uses a higher quality upscaling when blending the lens flare features with scene color. Results in less blocky artifacts at a cost to performance.

    Returns boolean

  • set isUsingBicubicUpsampling(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isUsingChromaticAberration(): boolean
  • 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.

    Returns boolean

  • set isUsingChromaticAberration(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isUsingHaloEffect(): boolean
  • Determines if a halo effect should be rendered as part of the lens flare.

    Returns boolean

  • set isUsingHaloEffect(value): void
  • Parameters

    • value: boolean

    Returns void

  • get threshold(): number
  • 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.

    Returns number

  • set threshold(value): void
  • Parameters

    • value: number

    Returns void

Methods