Documentation

Class: Bloom

Bloom

Bloom is an Effect added to the Camera that allows bright areas in the image to bleed into less bright areas.

new Bloom(radius, strength [, downScale] [, anisotropy])

Parameters:
Name Type Argument Description
radius

The radius of the bloom effect.
strength

The strength of the bloom effect.
downScale <optional>

How many times smaller the bloom should be calculated relative to the render target.
anisotropy <optional>

Defines the ratio between the horizontal and vertical bloom. For the JJ Abrams people among us.
Properties:
Name Type Description
strength number

The strength of the bloom effect.
thresholdLuminance number

The threshold luminance for pixels that are allowed to bleed.
Author:
  • derschmale <http://www.derschmale.com>

Extends

Members

entity

The target entity.

Inherited From:

onUpdate

If provided, this method will be called every frame, allowing updating the entity.

Inherited From:

Methods

_swapHDRFrontAndBack()

Child classes need to call this when rendering to and from full-resolution textures. This will effectively swap hdrSource and hdrTarget to allow ping-ponging.

Inherited From:

isSupported()

Returns whether this Effect is supported considering the current capabilities.

Inherited From: