New Camera Pipeline, better boot handling, tidied up docs

Author: photonstorm

src/renderer/webgl/pipelines/BitmapMaskPipeline.js

@@ -51,7 +51,6 @@ var BitmapMaskPipeline = new Class({
     {
         config.fragShader = GetFastValue(config, 'fragShader', ShaderSourceFS),
         config.vertShader = GetFastValue(config, 'vertShader', ShaderSourceVS),
-        config.vertexSize = GetFastValue(config, 'vertexSize', 8),
         config.vertexCapacity = GetFastValue(config, 'vertexCapacity', 3),
         config.vertices = GetFastValue(config, 'vertices', new Float32Array([ -1, 1, -1, -7, 7, 1 ]).buffer),
         config.attributes = GetFastValue(config, 'attributes', [
@@ -71,29 +70,17 @@ var BitmapMaskPipeline = new Class({
         WebGLPipeline.call(this, config);
     },
 
-    /**
-     * Called every time the pipeline is bound by the renderer.
-     * Sets the shader program, vertex buffer and other resources.
-     * Should only be called when changing pipeline.
-     *
-     * @method Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline#bind
-     * @since 3.50.0
-     *
-     * @param {boolean} [reset=false] - Should the pipeline be fully re-bound after a renderer pipeline clear?
-     *
-     * @return {this} This WebGLPipeline instance.
-     */
-    bind: function (reset)
+    boot: function ()
     {
-        if (reset === undefined) { reset = false; }
-
-        WebGLPipeline.prototype.bind.call(this, reset);
+        WebGLPipeline.prototype.boot.call(this);
 
-        this.set2f('uResolution', this.width, this.height);
         this.set1i('uMainSampler', 0);
         this.set1i('uMaskSampler', 1);
+    },
 
-        return this;
+    onResize: function (width, height)
+    {
+        this.set2f('uResolution', width, height);
     },
 
     /**

src/renderer/webgl/pipelines/CameraPipeline.js

@@ -0,0 +1,68 @@
+/**
+ * @author       Richard Davey <rich@photonstorm.com>
+ * @copyright    2020 Photon Storm Ltd.
+ * @license      {@link https://opensource.org/licenses/MIT|MIT License}
+ */
+
+var Class = require('../../../utils/Class');
+var GetFastValue = require('../../../utils/object/GetFastValue');
+var MultiPipeline = require('./MultiPipeline');
+var ShaderSourceFS = require('../shaders/Single-frag.js');
+var ShaderSourceVS = require('../shaders/Single-vert.js');
+var WebGLPipeline = require('../WebGLPipeline');
+
+/**
+ * @classdesc
+ * The Camera Pipeline is a special version of the Multi Pipeline that only ever
+ * uses one texture, bound to texture unit zero and with a vertex capacity of 1.
+ *
+ * The fragment shader it uses can be found in `shaders/src/Single.frag`.
+ * The vertex shader it uses can be found in `shaders/src/Single.vert`.
+ *
+ * The default shader attributes for this pipeline are:
+ *
+ * `inPosition` (vec2, offset 0)
+ * `inTexCoord` (vec2, offset 8)
+ * `inTexId` (float, offset 16) - this value is always zero in the Camera Pipeline
+ * `inTintEffect` (float, offset 20)
+ * `inTint` (vec4, offset 24, normalized)
+ *
+ * The default shader uniforms for this pipeline are:
+ *
+ * `uProjectionMatrix` (mat4)
+ * `uMainSampler` (sampler2D)
+ *
+ * @class CameraPipeline
+ * @extends Phaser.Renderer.WebGL.Pipelines.MultiPipeline
+ * @memberof Phaser.Renderer.WebGL.Pipelines
+ * @constructor
+ * @since 3.50.0
+ *
+ * @param {Phaser.Types.Renderer.WebGL.WebGLPipelineConfig} config - The configuration options for this pipeline.
+ */
+var CameraPipeline = new Class({
+
+    Extends: MultiPipeline,
+
+    initialize:
+
+    function CameraPipeline (config)
+    {
+        config.fragShader = GetFastValue(config, 'fragShader', ShaderSourceFS),
+        config.vertShader = GetFastValue(config, 'vertShader', ShaderSourceVS),
+        config.vertexCapacity = 1;
+        config.forceZero = true;
+
+        MultiPipeline.call(this, config);
+    },
+
+    boot: function ()
+    {
+        WebGLPipeline.prototype.boot.call(this);
+
+        this.set1i('uMainSampler', 0);
+    }
+
+});
+
+module.exports = CameraPipeline;

src/renderer/webgl/pipelines/GraphicsPipeline.js

@@ -95,6 +95,7 @@ var GraphicsPipeline = new Class({
             'uProjectionMatrix',
             'uMainSampler'
         ]);
+        config.forceZero = true;
 
         WebGLPipeline.call(this, config);
 
@@ -227,8 +228,13 @@ var GraphicsPipeline = new Class({
          * @since 3.12.0
          */
         this.polygonCache = [];
+    },
+
+    boot: function ()
+    {
+        WebGLPipeline.prototype.boot.call(this);
 
-        this.forceZero = true;
+        this.set1i('uMainSampler', 0);
     },
 
     /**

src/renderer/webgl/pipelines/MultiPipeline.js

@@ -42,8 +42,6 @@ var WebGLPipeline = require('../WebGLPipeline');
  * The default shader uniforms for this pipeline are:
  *
  * `uProjectionMatrix` (mat4)
- * `uViewMatrix` (mat4)
- * `uModelMatrix` (mat4)
  * `uMainSampler` (sampler2D array)
  *
  * If you wish to create a custom pipeline extending from this one, you can use two string
@@ -156,13 +154,11 @@ var MultiPipeline = new Class({
      *
      * @return {this} This WebGLPipeline instance.
      */
-    bind: function ()
+    boot: function ()
     {
-        WebGLPipeline.prototype.bind.call(this);
+        WebGLPipeline.prototype.boot.call(this);
 
         this.currentShader.set1iv('uMainSampler', this.renderer.textureIndexes);
-
-        return this;
     },
 
     /**

src/renderer/webgl/pipelines/SinglePipeline.js

@@ -9,6 +9,7 @@ var GetFastValue = require('../../../utils/object/GetFastValue');
 var MultiPipeline = require('./MultiPipeline');
 var ShaderSourceFS = require('../shaders/Single-frag.js');
 var ShaderSourceVS = require('../shaders/Single-vert.js');
+var WebGLPipeline = require('../WebGLPipeline');
 
 /**
  * @classdesc
@@ -33,8 +34,6 @@ var ShaderSourceVS = require('../shaders/Single-vert.js');
  * The default shader uniforms for this pipeline are:
  *
  * `uProjectionMatrix` (mat4)
- * `uViewMatrix` (mat4)
- * `uModelMatrix` (mat4)
  * `uMainSampler` (sampler2D)
  *
  * @class SinglePipeline
@@ -55,10 +54,16 @@ var SinglePipeline = new Class({
     {
         config.fragShader = GetFastValue(config, 'fragShader', ShaderSourceFS),
         config.vertShader = GetFastValue(config, 'vertShader', ShaderSourceVS),
+        config.forceZero = true;
 
         MultiPipeline.call(this, config);
+    },
 
-        this.forceZero = true;
+    boot: function ()
+    {
+        WebGLPipeline.prototype.boot.call(this);
+
+        this.set1i('uMainSampler', 0);
     }
 
 });

src/renderer/webgl/pipelines/const.js

@@ -64,8 +64,17 @@ var PIPELINE_CONST = {
      * @const
      * @since 3.50.0
      */
-    GRAPHICS_PIPELINE: 'GraphicsPipeline'
+    GRAPHICS_PIPELINE: 'GraphicsPipeline',
 
+    /**
+     * The Camera Pipeline.
+     *
+     * @name Phaser.Renderer.WebGL.Pipelines.CAMERA_PIPELINE
+     * @type {string}
+     * @const
+     * @since 3.50.0
+     */
+    CAMERA_PIPELINE: 'CameraPipeline'
 };
 
 module.exports = PIPELINE_CONST;

src/renderer/webgl/pipelines/index.js

@@ -14,6 +14,7 @@ var Extend = require('../../../utils/object/Extend');
 var Pipelines = {
 
     BitmapMaskPipeline: require('./BitmapMaskPipeline'),
+    CameraPipeline: require('./CameraPipeline'),
     GraphicsPipeline: require('./GraphicsPipeline'),
     LightPipeline: require('./LightPipeline'),
     MultiPipeline: require('./MultiPipeline'),