Class ChromaticAberrationSettings

Settings that control the chromatic aberration effect.

Hierarchy

  • FrameworkObject
    • ChromaticAberrationSettings

Constructors

Accessors

  • get fringeTexture(): Texture
  • Optional texture to apply to generate the channel shift fringe, allowing you to modulate the shifted colors. This texture should be 3x1 size, where the first pixel modules red, second green and third blue channel. If using the complex aberration effect you can use a larger texture, Nx1 size.

    Returns Texture

  • set fringeTexture(value): void
  • Optional texture to apply to generate the channel shift fringe, allowing you to modulate the shifted colors. This texture should be 3x1 size, where the first pixel modules red, second green and third blue channel. If using the complex aberration effect you can use a larger texture, Nx1 size.

    Parameters

    Returns void

  • get fringeTextureHandle(): ResourceHandle<Texture>
  • Optional texture to apply to generate the channel shift fringe, allowing you to modulate the shifted colors. This texture should be 3x1 size, where the first pixel modules red, second green and third blue channel. If using the complex aberration effect you can use a larger texture, Nx1 size.

    Returns ResourceHandle<Texture>

  • set fringeTextureHandle(value): void
  • Parameters

    Returns void

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

    Returns boolean

  • set isEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get shiftAmount(): 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 shiftAmount(value): void
  • Parameters

    • value: number

    Returns void

Methods

  • Marks the object as dirty.

    Parameters

    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.

        • (): void
        • Returns void

    Returns void