The initial WebGL pipeline of this Game Object.
If you call resetPipeline
on this Game Object, the pipeline is reset to this default.
The current WebGL pipeline of this Game Object.
An object to store pipeline specific data in, to be read by the pipelines this Game Object uses.
Sets the initial WebGL Pipeline of this Game Object.
This should only be called during the instantiation of the Game Object. After that, use setPipeline
.
name | type | arguments | description |
---|---|---|---|
pipeline | string | Phaser.Renderer.WebGL.WebGLPipeline | <optional> |
Either the string-based name of the pipeline, or a pipeline instance to set. |
true
if the pipeline was set successfully, otherwise false
.
Sets the main WebGL Pipeline of this Game Object.
Also sets the pipelineData
property, if the parameter is given.
name | type | arguments | Default | description |
---|---|---|---|---|
pipeline | string | Phaser.Renderer.WebGL.WebGLPipeline |
Either the string-based name of the pipeline, or a pipeline instance to set. |
||
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 pipelineData
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.
Resets the WebGL Pipeline of this Game Object back to the default it was created with.
name | type | arguments | Default | description |
---|---|---|---|---|
resetData | boolean | <optional> | false |
Reset the |
true
if the pipeline was reset successfully, otherwise false
.
Gets the name of the WebGL Pipeline this Game Object is currently using.
The string-based name of the pipeline being used by this Game Object, or null.