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

    Class Blend

    The Blend Filter Controller.

    This filter controller manages the blend effect for a Camera. A blend effect allows you to apply another texture to the view using a specific blend mode. This supports blend modes not otherwise available in WebGL.

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

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    active allowBaseDraw amount blendMode camera color currentPadding glTexture ignoreDestroy paddingOverride renderNode

    Methods

    destroy getPadding setActive setPaddingOverride setTexture

    Constructors

    • Parameters

      • camera: Cameras.Scene2D.Camera

        The camera that owns this filter.

      • Optionaltexture: Textures.Texture

        The texture to apply to the view. Default '__WHITE'.

      • OptionalblendMode: BlendModes

        The blend mode to apply to the view. Default Phaser.BlendModes.NORMAL.

      • Optionalamount: number

        The amount of the blend effect to apply to the view. At 0, the original image is preserved. At 1, the blend texture is fully applied. The expected range is 0 to 1, but you can go outside that range for different effects. Default 1.

      • Optionalcolor: number[]

        The color to apply to the blend texture. Each value corresponds to a color channel in RGBA. The expected range is 0 to 1, but you can go outside that range for different effects. Default [1, 1, 1, 1].

      Returns Blend

    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.

    amount: number

    The amount of the blend effect to apply to the view. At 0, the original image is preserved. At 1, the blend texture is fully applied.

    blendMode: BlendModes

    The blend mode to apply to the view. This supports blend modes not otherwise available in WebGL.

    camera: Cameras.Scene2D.Camera

    A reference to the Camera that owns this filter.

    color: number[]

    The color to apply to the blend texture. Each value corresponds to a color channel in RGBA. The expected range is 0 to 1, but you can go outside that range for different effects.

    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.

    glTexture: WebGLTextureWrapper

    The underlying texture used for the mask.

    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.

    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

    • Sets the texture used for the blend.

      Parameters

      • Optionaltexture: string

        The unique string-based key of the texture to use for displacement, which must exist in the Texture Manager. Default '__WHITE'.

      Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods