Class BloomSettings

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

Hierarchy

  • FrameworkObject
    • BloomSettings

Constructors

  • Parameters

    • OptionalisInternalConstructor: boolean

    Returns BloomSettings

Accessors

  • get filterSize(): number
  • Determines the distance that bloom spreads light. A value of 1 will spread ligh across the entire image.

    Returns number

  • set filterSize(value): void
  • Parameters

    • value: number

    Returns void

  • get intensity(): number
  • Determines the intensity of the bloom effect. Ideally should be in [0, 4] range but higher values are allowed.

    Returns number

  • set intensity(value): void
  • Parameters

    • value: number

    Returns void

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

    Returns boolean

  • set isEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get threshold(): number
  • Determines the minimal threshold of pixel luminance to be included in the bloom calculations. Any pixel with luminance below this value will be ignored for the purposes of bloom. The value represents luminance after it is scaled by exposure. 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

  • get tint(): Immutable<Color>
  • Tint color to apply to the bloom highlight. A pure white means the bloom inherits the underlying scene color.

    Returns Immutable<Color>

  • set tint(value): void
  • Parameters

    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