Namespace: Pipeline

Phaser.GameObjects.Components. Pipeline

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

Since: 3.0.0
Source: src/gameobjects/components/Pipeline.js (Line 7)

Members


defaultPipeline :Phaser.Renderer.WebGL.WebGLPipeline

The initial WebGL pipeline of this Game Object.

Type:
Since: 3.0.0
Default Value:
  • null
Source: src/gameobjects/components/Pipeline.js (Line 17)

pipeline :Phaser.Renderer.WebGL.WebGLPipeline

The current WebGL pipeline of this Game Object.

Type:
Since: 3.0.0
Default Value:
  • null
Source: src/gameobjects/components/Pipeline.js (Line 28)

Methods


getPipelineName()

Gets the name of the WebGL Pipeline this Game Object is currently using.

Since: 3.0.0
Source: src/gameobjects/components/Pipeline.js (Line 107)
Returns:

The string-based name of the pipeline being used by this Game Object.

Type
string

initPipeline( [pipelineName])

Sets the initial WebGL Pipeline of this Game Object. This should only be called during the instantiation of the Game Object.

Parameters:
Name Type Argument Default Description
pipelineName string <optional>
TextureTintPipeline

The name of the pipeline to set on this Game Object. Defaults to the Texture Tint Pipeline.

Since: 3.0.0
Source: src/gameobjects/components/Pipeline.js (Line 39)
Returns:

true if the pipeline was set successfully, otherwise false.

Type
boolean

resetPipeline()

Resets the WebGL Pipeline of this Game Object back to the default it was created with.

Since: 3.0.0
Source: src/gameobjects/components/Pipeline.js (Line 91)
Returns:

true if the pipeline was set successfully, otherwise false.

Type
boolean

setPipeline(pipelineName)

Sets the active WebGL Pipeline of this Game Object.

Parameters:
Name Type Description
pipelineName string

The name of the pipeline to set on this Game Object.

Since: 3.0.0
Source: src/gameobjects/components/Pipeline.js (Line 68)
Returns:

This Game Object instance.

Type
Phaser.GameObjects.Components.Pipeline