RSX Code Reference
    Preparing search index...
    • rsx
    • ScreenSpaceLensFlareSettings

    Class ScreenSpaceLensFlareSettings

    Class that notifies its parent ManagedSettigns or ManagedSubSettings object when one of its members changes.

    Index
    • 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: number): 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: number): 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: number): 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: number): 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: number): 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: number): 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: number): 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: number): 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: number): 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: number): void

      Parameters

      • value: number

      Returns void

    • get isEnabled(): boolean

      Enables or disables the lens flare effect.

      Returns boolean

    • set isEnabled(value: boolean): 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: boolean): 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: boolean): 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: boolean): 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: number): void

      Parameters

      • value: number

      Returns void

    • Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.

      Parameters

      • action: () => void

        The scope where the object is modified.

      Returns void