phaser - v4.0.0-rc.4
    Preparing search index...

    Class Blur

    The Blur Filter Controller.

    This filter controller manages 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.

    A Blur effect is added to a Camera via the FilterList component:

    const camera = this.cameras.main;

    camera.filters.internal.addBlur();
    camera.filters.external.addBlur();

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    active allowBaseDraw camera color currentPadding glcolor ignoreDestroy paddingOverride quality renderNode steps strength x y

    Methods

    destroy getPadding setActive setPaddingOverride

    Constructors

    • Parameters

      • camera: Cameras.Scene2D.Camera

        The Camera that owns this filter.

      • 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 filter, without removing and adding it from the Game Object.

    allowBaseDraw: boolean

    If true, this filter will be permitted to draw to the base texture. This can be unwanted if, for example, the filter doesn't actually draw anything.

    This is an internal flag used by the renderer. You should not modify this value directly.

    camera: Cameras.Scene2D.Camera

    A reference to the Camera that owns this filter.

    color: number

    The color of the blur as a number value.

    currentPadding: Geom.Rectangle

    The padding currently being used by this filter. This is set and used during rendering using getPadding. It is necessary for filters being used in an external list. You should not modify this value directly.

    glcolor: number[]

    The internal gl color array.

    ignoreDestroy: boolean

    Whether this filter controller will be destroyed when the FilterList that owns it is destroyed. If you enable this, you must ensure that you clean up the filter controller at an appropriate time. This allows you to reuse a controller for multiple objects; this is not recommended unless you know what you're doing. It tends to work best with external filters.

    paddingOverride: Geom.Rectangle

    Padding override. This is on by default. If this is set, the filter will use this padding instead of calculating it. Prefer using setPaddingOverride instead of modifying this directly.

    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.

    renderNode: string

    The ID of the RenderNode that this filter uses.

    steps: number

    The number of steps to run the Blur effect for.

    This value should always be an integer.

    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.

    x: number

    The horizontal offset of the blur effect.

    y: number

    The vertical offset of the blur effect.

    Methods

    • Returns the padding required for this filter, and sets currentPadding to the result. Most filters don't need extra padding, but some might sample beyond the texture size, such as a blur.

      The bounds are encoded as a Rectangle. To enlarge the bounds, the top and left values should be negative, and the bottom and right values should be positive.

      Returns Geom.Rectangle

    • Sets the active state of this filter.

      A disabled filter will not be used.

      Parameters

      • value: boolean

        true to enable this filter, or false to disable it.

      Returns this

    • Sets the padding override. If this is set, the filter will use this padding instead of calculating them. it Call setPaddingOverride(null) to clear the override. Call setPaddingOverride() to set the padding to 0.

      Parameters

      • Optionalleft: number

        The top padding. Default 0.

      • Optionaltop: number

        The top padding. Default 0.

      • Optionalright: number

        The right padding. Default 0.

      • Optionalbottom: number

        The bottom padding. Default 0.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods