Phaser API Documentation

  Version: 
addBloom([color], [offsetX], [offsetY], [blurStrength], [strength], [steps])

Description:

Adds a Bloom effect.

Bloom is an effect used to reproduce an imaging artifact of real-world cameras. The effect produces fringes of light extending from the borders of bright areas in an image, contributing to the illusion of an extremely bright light overwhelming the camera or eye capturing the scene.

Parameters:

name type arguments Default description
color number <optional>

The color of the Bloom, as a hex value.

offsetX number <optional> 1

The horizontal offset of the bloom effect.

offsetY number <optional> 1

The vertical offset of the bloom effect.

blurStrength number <optional> 1

The strength of the blur process of the bloom effect.

strength number <optional> 1

The strength of the blend process of the bloom effect.

steps number <optional> 4

The number of steps to run the Bloom effect for. This value should always be an integer.

Returns:
Description:

The Bloom FX Controller.

Since: 3.60.0