phaser - v3.90.0
    Preparing search index...

    Interface PostPipeline

    Provides methods used for setting the WebGL rendering post pipeline of a Game Object.

    interface PostPipeline {
        hasPostPipeline: boolean;
        postFX: GameObjects.Components.FX;
        postPipelineData: object;
        postPipelines: PostFXPipeline[];
        preFX: GameObjects.Components.FX;
        clearFX(): this;
        getPostPipeline(
            pipeline: string | Function | PostFXPipeline,
        ): PostFXPipeline | PostFXPipeline[];
        initPostPipeline(preFX?: boolean): void;
        removePostPipeline(pipeline: string | PostFXPipeline): this;
        resetPostPipeline(resetData?: boolean): void;
        setPostPipeline(
            pipelines:
                | string
                | Function
                | string[]
                | Function[]
                | PostFXPipeline
                | PostFXPipeline[],
            pipelineData?: object,
            copyData?: boolean,
        ): this;
        setPostPipelineData(key: string, value?: any): this;
    }

    Implemented by

    Index

    Properties

    hasPostPipeline postFX postPipelineData postPipelines preFX

    Methods

    clearFX getPostPipeline initPostPipeline removePostPipeline resetPostPipeline setPostPipeline setPostPipelineData

    Properties

    hasPostPipeline: boolean

    Does this Game Object have any Post Pipelines set?

    postFX: GameObjects.Components.FX

    The Post FX component of this Game Object.

    This component allows you to apply a variety of built-in effects to this Game Object, such as glow, blur, bloom, displacements, vignettes and more. You access them via this property, for example:

    const player = this.add.sprite();
    player.postFX.addBloom();

    All FX are WebGL only and do not have Canvas counterparts.

    Please see the FX Class for more details and available methods.

    This property is always null until the initPostPipeline method is called.

    postPipelineData: object

    An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.

    postPipelines: PostFXPipeline[]

    The WebGL Post FX Pipelines this Game Object uses for post-render effects.

    The pipelines are processed in the order in which they appear in this array.

    If you modify this array directly, be sure to set the hasPostPipeline property accordingly.

    preFX: GameObjects.Components.FX

    The Pre FX component of this Game Object.

    This component allows you to apply a variety of built-in effects to this Game Object, such as glow, blur, bloom, displacements, vignettes and more. You access them via this property, for example:

    const player = this.add.sprite();
    player.preFX.addBloom();

    Only the following Game Objects support Pre FX:

    • Image
    • Sprite
    • TileSprite
    • Text
    • RenderTexture
    • Video

    All FX are WebGL only and do not have Canvas counterparts.

    Please see the FX Class for more details and available methods.

    Methods

    • Removes all Pre and Post FX Controllers from this Game Object.

      If you wish to remove a single controller, use the preFX.remove(fx) or postFX.remove(fx) methods instead.

      If you wish to clear a single controller, use the preFX.clear() or postFX.clear() methods instead.

      Returns this

    • This should only be called during the instantiation of the Game Object.

      It is called by default by all core Game Objects and doesn't need calling again.

      After that, use setPostPipeline.

      Parameters

      • OptionalpreFX: boolean

        Does this Game Object support Pre FX? Default false.

      Returns void

    • Removes a type of Post Pipeline instances from this Game Object, based on the given name, and destroys them.

      If you wish to remove all Post Pipelines use the resetPostPipeline method instead.

      Parameters

      • pipeline: string | PostFXPipeline

        The string-based name of the pipeline, or a pipeline class.

      Returns this

    • Resets the WebGL Post Pipelines of this Game Object. It does this by calling the destroy method on each post pipeline and then clearing the local array.

      Parameters

      • OptionalresetData: boolean

        Reset the postPipelineData object to being an empty object? Default false.

      Returns void

    • Sets one, or more, Post Pipelines on this Game Object.

      Post Pipelines are invoked after this Game Object has rendered to its target and are commonly used for post-fx.

      The post pipelines are appended to the postPipelines array belonging to this Game Object. When the renderer processes this Game Object, it iterates through the post pipelines in the order in which they appear in the array. If you are stacking together multiple effects, be aware that the order is important.

      If you call this method multiple times, the new pipelines will be appended to any existing post pipelines already set. Use the resetPostPipeline method to clear them first, if required.

      You can optionally also set the postPipelineData property, if the parameter is given.

      Parameters

      • pipelines: string | Function | string[] | Function[] | PostFXPipeline | PostFXPipeline[]

        Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them.

      • OptionalpipelineData: object

        Optional pipeline data object that is set in to the postPipelineData property of this Game Object.

      • OptionalcopyData: boolean

        Should the pipeline data object be deep copied into the postPipelineData property of this Game Object? If false it will be set by reference instead. Default true.

      Returns this

    • Adds an entry to the postPipelineData object belonging to this Game Object.

      If the 'key' already exists, its value is updated. If it doesn't exist, it is created.

      If value is undefined, and key exists, key is removed from the data object.

      Parameters

      • key: string

        The key of the pipeline data to set, update, or delete.

      • Optionalvalue: any

        The value to be set with the key. If undefined then key will be deleted from the object.

      Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Methods