Class Bloom

Readonlyview

applied

• get applied(): boolean

  Gets if Bloom is currently applied.

  This is true when View.renderMode is in Bloom.renderModes.

  Returns boolean

intensity

• get intensity(): number

  Composite intensity. Default 0.15.

  Returns number
• set intensity(value: number): void

  Parameters

  • value: number

  Returns void

knee

• get knee(): number

  Soft-knee width. Default 0.5.

  Returns number
• set knee(value: number): void

  Parameters

  • value: number

  Returns void

renderModes

• get renderModes(): number[]

  Gets which rendering modes in which to apply Bloom.

  The View will apply Bloom whenever View.renderMode has been set one of these values.

  Default value is [RealisticRender].

  Returns number[]
• set renderModes(value: number[]): void

  Sets which rendering modes in which to apply Bloom.

  The View will apply Bloom whenever View.renderMode has been set one of these values.

  Default value is [RealisticRender].

  Parameters

  • value: number[]

  Returns void

threshold

• get threshold(): number

  Luminance threshold. Default 4.0.

  Returns number
• set threshold(value: number): void

  Parameters

  • value: number

  Returns void

fromParams

• fromParams(params: BloomParams): SDKResult<any>

  Configures this Bloom.

  Parameters

  • params: BloomParams

  Returns SDKResult<any>

toParams

• toParams(): SDKResult<BloomParams>

  Gets this Bloom as JSON.

  Returns SDKResult<BloomParams>