mirror of
https://github.com/photonstorm/phaser
synced 2025-01-12 13:18:49 +00:00
124 lines
3.3 KiB
JavaScript
124 lines
3.3 KiB
JavaScript
/**
|
|
* @author Richard Davey <rich@photonstorm.com>
|
|
* @copyright 2020 Photon Storm Ltd.
|
|
* @license {@link https://opensource.org/licenses/MIT|MIT License}
|
|
*/
|
|
|
|
/**
|
|
* Provides methods used for setting the WebGL rendering pipeline of a Game Object.
|
|
*
|
|
* @namespace Phaser.GameObjects.Components.Pipeline
|
|
* @webglOnly
|
|
* @since 3.0.0
|
|
*/
|
|
|
|
var Pipeline = {
|
|
|
|
/**
|
|
* The initial WebGL pipeline of this Game Object.
|
|
*
|
|
* @name Phaser.GameObjects.Components.Pipeline#defaultPipeline
|
|
* @type {Phaser.Renderer.WebGL.WebGLPipeline}
|
|
* @default null
|
|
* @webglOnly
|
|
* @since 3.0.0
|
|
*/
|
|
defaultPipeline: null,
|
|
|
|
/**
|
|
* The current WebGL pipeline of this Game Object.
|
|
*
|
|
* @name Phaser.GameObjects.Components.Pipeline#pipeline
|
|
* @type {Phaser.Renderer.WebGL.WebGLPipeline}
|
|
* @default null
|
|
* @webglOnly
|
|
* @since 3.0.0
|
|
*/
|
|
pipeline: null,
|
|
|
|
/**
|
|
* Sets the initial WebGL Pipeline of this Game Object.
|
|
*
|
|
* This should only be called during the instantiation of the Game Object.
|
|
*
|
|
* @method Phaser.GameObjects.Components.Pipeline#initPipeline
|
|
* @webglOnly
|
|
* @since 3.0.0
|
|
*
|
|
* @param {string} [pipelineName=MultiPipeline] - The name of the pipeline to set on this Game Object. Defaults to the Multi Pipeline.
|
|
*
|
|
* @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.
|
|
*/
|
|
initPipeline: function (pipelineName)
|
|
{
|
|
if (pipelineName === undefined) { pipelineName = 'MultiPipeline'; }
|
|
|
|
var renderer = this.scene.sys.game.renderer;
|
|
|
|
if (renderer && renderer.gl && renderer.hasPipeline(pipelineName))
|
|
{
|
|
this.defaultPipeline = renderer.getPipeline(pipelineName);
|
|
this.pipeline = this.defaultPipeline;
|
|
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
},
|
|
|
|
/**
|
|
* Sets the active WebGL Pipeline of this Game Object.
|
|
*
|
|
* @method Phaser.GameObjects.Components.Pipeline#setPipeline
|
|
* @webglOnly
|
|
* @since 3.0.0
|
|
*
|
|
* @param {string} pipelineName - The name of the pipeline to set on this Game Object.
|
|
*
|
|
* @return {this} This Game Object instance.
|
|
*/
|
|
setPipeline: function (pipelineName)
|
|
{
|
|
var renderer = this.scene.sys.game.renderer;
|
|
|
|
if (renderer && renderer.gl && renderer.hasPipeline(pipelineName))
|
|
{
|
|
this.pipeline = renderer.getPipeline(pipelineName);
|
|
}
|
|
|
|
return this;
|
|
},
|
|
|
|
/**
|
|
* Resets the WebGL Pipeline of this Game Object back to the default it was created with.
|
|
*
|
|
* @method Phaser.GameObjects.Components.Pipeline#resetPipeline
|
|
* @webglOnly
|
|
* @since 3.0.0
|
|
*
|
|
* @return {boolean} `true` if the pipeline was set successfully, otherwise `false`.
|
|
*/
|
|
resetPipeline: function ()
|
|
{
|
|
this.pipeline = this.defaultPipeline;
|
|
|
|
return (this.pipeline !== null);
|
|
},
|
|
|
|
/**
|
|
* Gets the name of the WebGL Pipeline this Game Object is currently using.
|
|
*
|
|
* @method Phaser.GameObjects.Components.Pipeline#getPipelineName
|
|
* @webglOnly
|
|
* @since 3.0.0
|
|
*
|
|
* @return {string} The string-based name of the pipeline being used by this Game Object.
|
|
*/
|
|
getPipelineName: function ()
|
|
{
|
|
return this.pipeline.name;
|
|
}
|
|
|
|
};
|
|
|
|
module.exports = Pipeline;
|