phaser - v3.90.0
    Preparing search index...

    Class Blur

    The Blur FX Controller.

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

    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.

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

    const sprite = this.add.sprite();

    sprite.preFX.addBlur();
    sprite.postFX.addBlur();

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    active color gameObject glcolor quality steps strength type x y

    Methods

    destroy setActive

    Constructors

    • Parameters

      • gameObject: GameObject

        A reference to the Game Object that has this fx.

      • Optionalquality: number

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

      • Optionalx: number

        The horizontal offset of the blur effect. Default 2.

      • Optionaly: number

        The vertical offset of the blur effect. Default 2.

      • Optionalstrength: number

        The strength of the blur effect. Default 1.

      • Optionalcolor: number

        The color of the blur, as a hex value. Default 0xffffff.

      • Optionalsteps: number

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

      Returns Blur

    Properties

    active: boolean

    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.

    color: number

    The color of the blur as a number value.

    gameObject: GameObject

    A reference to the Game Object that owns this effect.

    glcolor: number[]

    The internal gl color array.

    quality: number

    The quality of the blur effect.

    This can be:

    0 for Low Quality 1 for Medium Quality 2 for High Quality

    The higher the quality, the more complex shader is used and the more processing time is spent on the GPU calculating the final blur. This value is used in conjunction with the steps value, as one has a direct impact on the other.

    Keep this value as low as you can, while still achieving the desired effect you need for your game.

    steps: number

    The number of steps to run the Blur effect for.

    This value should always be an integer.

    It defaults to 4. The higher the value, the smoother the blur, but at the cost of exponentially more gl operations.

    Keep this to the lowest possible number you can have it, while still looking correct for your game.

    strength: number

    The strength of the blur effect.

    type: number

    The FX_CONST type of this effect.

    x: number

    The horizontal offset of the blur effect.

    y: number

    The vertical offset of the blur effect.

    Methods

    • Destroys this FX Controller.

      Returns void

    • Sets the active state of this FX Controller.

      A disabled FX Controller will not be updated.

      Parameters

      • value: boolean

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

      Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods