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

    Class ParallelFilters

    The Parallel Filters Controller.

    This filter controller splits the input into two lists of filters, runs each list separately, and then blends the results together.

    The Parallel Filters effect is useful for reusing an input. Ordinarily, a filter modifies the input and passes it to the next filter. This effect allows you to split the input and re-use it elsewhere. It does not gain performance benefits from parallel processing; it is a convenience for reusing the input.

    The Parallel Filters effect is not a filter itself. It is a controller that manages two FilterLists, and the final Blend filter that combines the results. The FilterLists are named 'top' and 'bottom'. The 'top' output is applied as a blend texture to the 'bottom' output.

    You do not have to populate both lists. If only one is populated, it will be blended with the original input at the end. This is useful when you want to retain image data that would be lost in the filter process.

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

    const camera = this.cameras.main;
    camera.filters.internal.addParallelFilters();
    camera.filters.external.addParallelFilters();

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    active allowBaseDraw blend bottom camera currentPadding ignoreDestroy paddingOverride renderNode top

    Methods

    destroy getPadding setActive setPaddingOverride

    Constructors

    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.

    blend: Blend

    The Blend filter controller that combines the top and bottom FilterLists. This is just another filter controller. See Phaser.Filters.Blend for more information.

    The texture property of the Blend controller will be overwritten during rendering.

    bottom: FilterList

    The bottom FilterList.

    camera: Cameras.Scene2D.Camera

    A reference to the Camera that owns this filter.

    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.

    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.

    renderNode: string

    The ID of the RenderNode that this filter uses.

    top: FilterList

    The top FilterList.

    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