Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-26 22:52:14 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added preFX and postFX and create them within init

Browse source
This commit is contained in:
Richard Davey 2023-02-17 01:10:23 +00:00
parent d3c32cdc27
commit a2231dddcd
1 changed files with 74 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

78
src/gameobjects/components/PostPipeline.js
View file

@ -5,6 +5,7 @@
*/
var DeepCopy = require('../../utils/object/DeepCopy');
var FX = require('../components/FX');
var SpliceOne = require('../../utils/array/SpliceOne');
/**
@ -53,16 +54,85 @@ var PostPipeline = {
postPipelineData: null,
/**
* This should only be called during the instantiation of the Game Object. After that, use `setPostPipeline`.
* The Pre FX component of this Game Object.
*
* Only the following Game Objects support Pre FX:
*
* * Image
* * Sprite
* * TileSprite
* * Text
* * RenderTexture
* * Video
*
* 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:
*
* ```js
* const player = this.add.sprite();
* player.preFX.addBloom();
* ```
*
* All FX are WebGL only and do not have Canvas counterparts.
*
* Please see the FX Class for more details and available methods.
*
* @name Phaser.GameObjects.Components.PostPipeline#preFX
* @type {Phaser.GameObjects.Components.FX}
* @webglOnly
* @since 3.60.0
*/
preFX: null,
/**
* 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:
*
* ```js
* 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.
*
* @name Phaser.GameObjects.Components.PostPipeline#postFX
* @type {Phaser.GameObjects.Components.FX}
* @webglOnly
* @since 3.60.0
*/
postFX: null,
/**
* 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`.
*
* @method Phaser.GameObjects.Components.PostPipeline#initPostPipeline
* @webglOnly
* @since 3.60.0
*
* @param {boolean} [preFX=false] - Does this Game Object support Pre FX?
*/
initPostPipeline: function ()
initPostPipeline: function (preFX)
{
this.postPipelines = [];
this.postPipelineData = {};
this.postFX = new FX(this, true);
if (preFX)
{
this.preFX = new FX(this, false);
}
},
/**
@ -171,11 +241,11 @@ var PostPipeline = {
*
* @param {(string|function|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline)} pipeline - The string-based name of the pipeline, or a pipeline class.
*
* @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} The Post Pipeline/s matching the name, or undefined if no match. If more than one match they are returned in an array.
* @return {(Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Phaser.Renderer.WebGL.Pipelines.PostFXPipeline[])} 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.
*/
getPostPipeline: function (pipeline)
{
var isString = (typeof pipeline === 'string');
var isString = (typeof pipeline === 'string' || typeof pipeline === 'number');
var pipelines = this.postPipelines;