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();
new Bokeh(gameObject, [radius], [amount], [contrast], [isTiltShift], [blurX], [blurY], [strength])
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. |
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.
The amount, or strength, of the bokeh effect. Defaults to 1.
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.
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.
The color contrast, or brightness, of the bokeh effect. Defaults to 0.2.
A reference to the Game Object that owns this effect.
Is this a Tilt Shift effect or a standard bokeh effect?
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.
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.
The FX_CONST type of this effect.
Destroys this FX Controller.
Sets the active state of this FX Controller.
A disabled FX Controller will not be updated.
name | type | description |
---|---|---|
value | boolean |
|
This FX Controller instance.