Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BloomEffect

The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras

Hierarchy

Index

Constructors

constructor

  • new BloomEffect(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean): BloomEffect
  • Creates a new instance of @see BloomEffect

    Parameters

    • scene: Scene

      The scene the effect belongs to.

    • bloomScale: number

      The ratio of the blur texture to the input texture that should be used to compute the bloom.

    • bloomWeight: number

      The the strength of bloom.

    • bloomKernel: number

      The size of the kernel to be used when applying the blur.

    • Optional pipelineTextureType: number

      The type of texture to be used when performing the post processing.

    • Optional blockCompilation: boolean

      If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)

    Returns BloomEffect

Accessors

isSupported

  • get isSupported(): boolean
  • Checks if all the post processes in the effect are supported.

    Returns boolean

kernel

  • get kernel(): number
  • set kernel(value: number): any
  • Specifies the size of the bloom blur kernel, relative to the final output size

    Returns number

  • Specifies the size of the bloom blur kernel, relative to the final output size

    Parameters

    • value: number

    Returns any

threshold

  • get threshold(): number
  • set threshold(value: number): any
  • The luminance threshold to find bright areas of the image to bloom.

    Returns number

  • The luminance threshold to find bright areas of the image to bloom.

    Parameters

    • value: number

    Returns any

weight

  • get weight(): number
  • set weight(value: number): any
  • The strength of the bloom.

    Returns number

  • The strength of the bloom.

    Parameters

    • value: number

    Returns any

Methods

disposeEffectsSearch playground for disposeEffects

  • disposeEffects(camera: Camera): void
  • Disposes each of the internal effects for a given camera.

    Parameters

    • camera: Camera

      The camera to dispose the effect on.

    Returns void

getPostProcessesSearch playground for getPostProcesses

  • Gets a list of the post processes contained in the effect.

    Parameters

    • Optional camera: Camera

      The camera to get the post processes on.

    Returns Nullable<Array<PostProcess>>

    The list of the post processes in the effect.

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Property
  • Method
  • Inherited method
  • Static method