Does this Game Object have any Post Pipelines set?
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.
An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.
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.
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:
All FX are WebGL only and do not have Canvas counterparts.
Please see the FX Class for more details and available methods.
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
.
name | type | arguments | Default | description |
---|---|---|---|---|
preFX | boolean | <optional> | false |
Does this Game Object support Pre FX? |
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.
name | type | arguments | Default | description |
---|---|---|---|---|
pipelines | string | Array.<string> | function | Array.<function()> | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline | Array.<Phaser.Renderer.WebGL.Pipelines.PostFXPipeline> |
Either the string-based name of the pipeline, or a pipeline instance, or class, or an array of them. |
||
pipelineData | object | <optional> |
Optional pipeline data object that is set in to the |
|
copyData | boolean | <optional> | true |
Should the pipeline data object be deep copied into the |
This Game Object instance.
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.
name | type | arguments | description |
---|---|---|---|
key | string |
The key of the pipeline data to set, update, or delete. |
|
value | any | <optional> |
The value to be set with the key. If |
This Game Object instance.
Gets a Post Pipeline instance from this Game Object, based on the given name, and returns it.
name | type | description |
---|---|---|
pipeline | string | function | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline |
The string-based name of the pipeline, or a pipeline class. |
An array of all the Post Pipelines matching the name. This array will be empty if there was no match. If there was only one single match, that pipeline is returned directly, not in an array.
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.
name | type | arguments | Default | description |
---|---|---|---|---|
resetData | boolean | <optional> | false |
Reset the |
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.
name | type | description |
---|---|---|
pipeline | string | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline |
The string-based name of the pipeline, or a pipeline class. |
This Game Object.
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.
This Game Object.