Phaser API Documentation

  Version: 
addBlur([quality], [x], [y], [strength], [color], [steps])

Description:

Adds a Blur effect.

A Gaussian blur is the result of blurring an image by a Gaussian function. It is a widely used effect, typically to reduce image noise and reduce detail. The visual effect of this blurring technique is a smooth blur resembling that of viewing the image through a translucent screen, distinctly different from the bokeh effect produced by an out-of-focus lens or the shadow of an object under usual illumination.

Parameters:

name type arguments Default description
quality number <optional> 0

The quality of the blur effect. Can be either 0 for Low Quality, 1 for Medium Quality or 2 for High Quality.

x number <optional> 2

The horizontal offset of the blur effect.

y number <optional> 2

The vertical offset of the blur effect.

strength number <optional> 1

The strength of the blur effect.

color number <optional> 0xffffff

The color of the blur, as a hex value.

steps number <optional> 4

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

Returns:
Description:

The Blur FX Controller.

Since: 3.60.0