Class BloomSettings

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

Index

Constructors

Accessors

coefficients1 coefficients2 filterSize intensity isEnabled quality threshold tint

Methods

markAsDirty modify

Constructors

`Protected`constructor

new BloomSettings(isInternalConstructor?: boolean): BloomSettings
Parameters
- OptionalisInternalConstructor: boolean
Returns BloomSettings

Overrides FrameworkObject.constructor

Accessors

coefficients1

get coefficients1(): Immutable<Vector4>

Scale factors applied to the first 4 mip levels of the blur.

Returns Immutable<Vector4>
set coefficients1(value: Immutable<Vector4>): void
Parameters
- value: Immutable<Vector4>
Returns void

coefficients2

get coefficients2(): Immutable<Vector4>

Scale factors applied to the second 4 mip levels of the blur.

Returns Immutable<Vector4>
set coefficients2(value: Immutable<Vector4>): void
Parameters
- value: Immutable<Vector4>
Returns void

filterSize

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: number): void
Parameters
- value: number
Returns void

intensity

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: number): void
Parameters
- value: number
Returns void

isEnabled

get isEnabled(): boolean

Enables or disables the bloom effect.

Returns boolean
set isEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

quality

get quality(): EnumValue<BloomQuality>

Quality of the bloom effect. High quality uses a full resolution input, low quality uses a half resolution input, default is high.

Returns EnumValue<BloomQuality>
set quality(value: EnumValue<BloomQuality>): void
Parameters
- value: EnumValue<BloomQuality>
Returns void

threshold

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: number): void
Parameters
- value: number
Returns void

tint

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: Immutable<Color>): void
Parameters
- value: Immutable<Color>
Returns void

Methods

markAsDirty

markAsDirty(dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>): void
Marks the object as dirty.
Parameters
- dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>
  Flags specifying what kind of member was changed.
Returns void

modify

modify(action: () => void): 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