Skip to content

Commit 0410c9f

Browse files
committed
Updated JSDocs
1 parent 7d5adab commit 0410c9f

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

src/renderer/webgl/PipelineManager.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,23 @@ var SinglePipeline = require('./pipelines/SinglePipeline');
1818

1919
/**
2020
* @classdesc
21+
* The Pipeline Manager is responsible for the creation, activation, running and destruction
22+
* of WebGL Pipelines in Phaser 3.
2123
*
24+
* The `WebGLRenderer` owns a single instance of the Pipeline Manager, which you can access
25+
* via the `WebGLRenderer.pipelines` property.
26+
*
27+
* By default, there are 6 pipelines installed into the Pipeline Manager when Phaser boots:
28+
*
29+
* 1. The Multi Pipeline. Responsible for all multi-texture rendering, i.e. Sprites, Shapes.
30+
* 2. The Single Pipeline. Responsible for rendering Game Objects that explicitly require one bound texture.
31+
* 3. The Rope Pipeline. Responsible for rendering the Rope Game Object.
32+
* 4. The Mesh Pipeline. Responsible for rendering the Layer3D Game Object.
33+
* 5. The Light Pipeline. Responsible for rendering the Light Game Object.
34+
* 6. The Bitmap Mask Pipeline. Responsible for Bitmap Mask rendering.
35+
*
36+
* You can add your own custom pipeline via the `PipelineManager.add` method. Pipelines are
37+
* identified by unique string-based keys.
2238
*
2339
* @class PipelineManager
2440
* @memberof Phaser.Renderer.WebGL

0 commit comments

Comments
 (0)