Phaser API Documentation

  Version: 
setDefaultPipeline(pipeline)

Description:

Sets the default pipeline being used by Game Objects.

If no instance, or matching name, exists in this manager, it returns undefined.

You can use this to override the default pipeline, for example by forcing the Mobile or Multi Tint Pipelines, which is especially useful for development testing.

Make sure you call this method before creating any Game Objects, as it will only impact Game Objects created after you call it.

Parameters:

name type description
pipeline string | Phaser.Renderer.WebGL.WebGLPipeline

Either the string-based name of the pipeline to get, or a pipeline instance to look-up.

Returns:
Description:

The pipeline instance that was set as default, or undefined if not found.

Since: 3.60.0