Phaser API Documentation

  Version: 
Filter

The Bokeh FX Controller.

This FX controller manages the bokeh effect for a Game Object.

Bokeh refers to a visual effect that mimics the photographic technique of creating a shallow depth of field. This effect is used to emphasize the game's main subject or action, by blurring the background or foreground elements, resulting in a more immersive and visually appealing experience. It is achieved through rendering techniques that simulate the out-of-focus areas, giving a sense of depth and realism to the game's graphics.

This effect can also be used to generate a Tilt Shift effect, which is a technique used to create a miniature effect by blurring everything except a small area of the image. This effect is achieved by blurring the top and bottom elements, while keeping the center area in focus.

A Bokeh effect is added to a Game Object via the FX component:

const sprite = this.add.sprite();

sprite.preFX.addBokeh();
sprite.postFX.addBokeh();

Constructor:

new Bokeh(gameObject, [radius], [amount], [contrast], [isTiltShift], [blurX], [blurY], [strength])

Parameters:

name type arguments Default description
gameObject Phaser.GameObjects.GameObject

A reference to the Game Object that has this fx.

radius number <optional> 0.5

The radius of the bokeh effect.

amount number <optional> 1

The amount of the bokeh effect.

contrast number <optional> 0.2

The color contrast of the bokeh effect.

isTiltShift boolean <optional> false

Is this a bokeh or Tile Shift effect?

blurX number <optional> 1

If Tilt Shift, the amount of horizontal blur.

blurY number <optional> 1

If Tilt Shift, the amount of vertical blur.

strength number <optional> 1

If Tilt Shift, the strength of the blur.

Since: 3.60.0
Source: src/fx/Bokeh.js (Line 11)

Extends


Members

active: boolean
Focus
Focus

Description:

Toggle this boolean to enable or disable this effect, without removing and adding it from the Game Object.

Only works for Pre FX.

Post FX are always active.

Type:
boolean
Inherited from: Phaser.FX.Controller#active
Since: 3.60.0
Source: src/fx/Controller.js (Line 47)
Focus
Focus
amount: number
Focus
Focus

Description:

The amount, or strength, of the bokeh effect. Defaults to 1.

Type:
number
Since: 3.60.0
Source: src/fx/Bokeh.js (Line 81)
Focus
Focus
blurX: number
Focus
Focus

Description:

If a Tilt Shift effect this controls the amount of horizontal blur.

Setting this value on a non-Tilt Shift effect will have no effect.

Type:
number
Since: 3.60.0
Source: src/fx/Bokeh.js (Line 119)
Focus
Focus
blurY: number
Focus
Focus

Description:

If a Tilt Shift effect this controls the amount of vertical blur.

Setting this value on a non-Tilt Shift effect will have no effect.

Type:
number
Since: 3.60.0
Source: src/fx/Bokeh.js (Line 130)
Focus
Focus
contrast: number
Focus
Focus

Description:

The color contrast, or brightness, of the bokeh effect. Defaults to 0.2.

Type:
number
Since: 3.60.0
Source: src/fx/Bokeh.js (Line 90)
Focus
Focus

Description:

A reference to the Game Object that owns this effect.

Type:
Inherited from: Phaser.FX.Controller#gameObject
Since: 3.60.0
Source: src/fx/Controller.js (Line 38)
Focus
Focus
isTiltShift: boolean
Focus
Focus

Description:

Is this a Tilt Shift effect or a standard bokeh effect?

Type:
boolean
Since: 3.60.0
Source: src/fx/Bokeh.js (Line 99)
Focus
Focus
radius: number
Focus
Focus

Description:

The radius of the bokeh effect.

This is a float value, where a radius of 0 will result in no effect being applied, and a radius of 1 will result in a strong bokeh. However, you can exceed this value for even stronger effects.

Type:
number
Since: 3.60.0
Source: src/fx/Bokeh.js (Line 68)
Focus
Focus
strength: number
Focus
Focus

Description:

If a Tilt Shift effect this controls the strength of the blur.

Setting this value on a non-Tilt Shift effect will have no effect.

Type:
number
Since: 3.60.0
Source: src/fx/Bokeh.js (Line 108)
Focus
Focus
type: number
Focus
Focus

Description:

The FX_CONST type of this effect.

Type:
number
Inherited from: Phaser.FX.Controller#type
Since: 3.60.0
Source: src/fx/Controller.js (Line 29)
Focus
Focus

Methods

destroy()
Focus
Focus

Description:

Destroys this FX Controller.

Inherited from: Phaser.FX.Controller#destroy
Since: 3.60.0
Source: src/fx/Controller.js (Line 81)
Focus
Focus
setActive(value)
Focus
Focus

Description:

Sets the active state of this FX Controller.

A disabled FX Controller will not be updated.

Parameters:

name type description
value boolean

true to enable this FX Controller, or false to disable it.

Returns:
Description:

This FX Controller instance.

Inherited from: Phaser.FX.Controller#setActive
Since: 3.60.0
Source: src/fx/Controller.js (Line 62)
Focus
Focus