Class BloomSettings

Settings that control the bloom effect. Bloom adds an extra highlight to bright areas of the scene.

Constructors

Properties

_coefficients1: Vector4
_coefficients2: Vector4
_filterSize: number
_intensity: number
_isEnabled: boolean
_quality: EnumValue<BloomQuality, number>
_threshold: number
_tint: Color

Accessors

  • get coefficients1(): Vector4
  • Scale factors applied to the first 4 mip levels of the blur.

    Returns Vector4

  • set coefficients1(value): void
  • Parameters

    Returns void

  • get coefficients2(): Vector4
  • Scale factors applied to the second 4 mip levels of the blur.

    Returns Vector4

  • set coefficients2(value): void
  • Parameters

    Returns void

  • 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(): Color
  • Tint color to apply to the bloom highlight. A pure white means the bloom inherits the underlying scene color.

    Returns Color

  • set tint(value): void
  • Parameters

    Returns void

Methods