BloomEffect

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

Hierarchy

Index

Constructors

constructor

Find examples in Playground
  • 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

Properties

isSupported

Find examples in Playground
isSupported: boolean

Checks if all the post processes in the effect are supported.

kernel

Find examples in Playground
kernel: number

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

threshold

Find examples in Playground
threshold: number

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

weight

Find examples in Playground
weight: number

The strength of the bloom.

Methods

disposeEffects

Find examples in Playground
  • 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

getPostProcesses

Find examples in Playground

Generated using TypeDoc