Skip to main content
Version: Phaser v3.88.2

BarrelFXPipeline

The Barrel FX Pipeline.

A barrel effect allows you to apply either a 'pinch' or 'expand' distortion to

a Game Object. The amount of the effect can be modified in real-time.

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


const sprite = this.add.sprite();



sprite.postFX.addBarrel();

Constructor

new BarrelFXPipeline(game)

Parameters

nametypeoptionaldescription
gamePhaser.GameNoA reference to the Phaser Game instance.

Scope: static

Extends

Phaser.Renderer.WebGL.Pipelines.PostFXPipeline

Source: src/renderer/webgl/pipelines/fx/BarrelFXPipeline.js#L11
Since: 3.60.0

Inherited Members​

From Phaser.Renderer.WebGL.Pipelines.PostFXPipeline:

From Phaser.Renderer.WebGL.WebGLPipeline:

Public Members​

amount​

amount: number​

Description:

The amount of distortion applied to the barrel effect.

Typically keep this within the range 1 (no distortion) to +- 1.

Source: src/renderer/webgl/pipelines/fx/BarrelFXPipeline.js#L47
Since: 3.60.0

Inherited Methods​

From Phaser.Events.EventEmitter:

From Phaser.Renderer.WebGL.Pipelines.PostFXPipeline:

From Phaser.Renderer.WebGL.WebGLPipeline: