Made the Render Events global, not WebGL specific and allowed Canvas Renderer to emit them too

Author: photonstorm

CHANGELOG-v3.50.md

@@ -214,11 +214,20 @@ All of the internal functions, such as `batchQuad` and `batchSprite` have been u
 * `WebGLRenderer.setFramebuffer` has a new optional boolean parameter `resetTextures` which will reset the WebGL Textures, if set to `true` (which is the default).
 * `WebGLRenderer.isBooted` is a new boolean property that lets you know if the rendere has fully finished booting.
 * The `WebGLRenderer` now extends the Event Emitter, allowing you to listen to renderer specific events.
-* `Phaser.Renderer.WebGL.Events` is a new WebGL Renderer namespace for events.
-* `WebGL.Events.PRE_RENDER` is a new event dispatched by the WebGL Renderer. This happens right at the start of the render process.
-* `WebGL.Events.RENDER` is a new event dispatched by the WebGL Renderer. This happens once for every camera, in every Scene at the start of its render process.
-* `WebGL.Events.POST_RENDER` is a new event dispatched by the WebGL Renderer. This happens right at the end of the render process.
-* `WebGL.Events.RESIZE` is a new event dispatched by the WebGL Renderer whenever it is resized.
+* `WebGLRenderer.defaultCamera` has been removed as it's not used anywhere internally any longer.
+
+### WebGL and Canvas Renderer Events
+
+* `Phaser.Renderer.Events` is a new namespace for events emited by the Canvas and WebGL Renderers.
+* `Renderer.Events.PRE_RENDER` is a new event dispatched by the Phaser Renderer. This happens right at the start of the render process.
+* `Renderer.Events.RENDER` is a new event dispatched by the Phaser Renderer. This happens once for every camera, in every Scene at the start of its render process.
+* `Renderer.Events.POST_RENDER` is a new event dispatched by the Phaser Renderer. This happens right at the end of the render process.
+* `Renderer.Events.RESIZE` is a new event dispatched by the Phaser Renderer whenever it is resized.
+
+### Canvas Renderer Updates
+
+* `CanvasRenderer.isBooted` is a new boolean property that lets you know if the rendere has fully finished booting.
+* The `CanvasRenderer` now extends the Event Emitter, allowing you to listen to renderer specific events.
 
 ### Camera - New Features, Updates and API Changes
 

src/display/mask/BitmapMask.js

@@ -6,7 +6,7 @@
 
 var Class = require('../../utils/Class');
 var GameEvents = require('../../core/events');
-var RenderEvents = require('../../renderer/webgl/events');
+var RenderEvents = require('../../renderer/events');
 
 /**
  * @classdesc

src/gameobjects/rendertexture/RenderTexture.js

@@ -15,7 +15,7 @@ var GameObject = require('../GameObject');
 var NOOP = require('../../utils/NOOP');
 var PIPELINE_CONST = require('../../renderer/webgl/pipelines/const');
 var Render = require('./RenderTextureRender');
-var RenderEvents = require('../../renderer/webgl/events');
+var RenderEvents = require('../../renderer/events');
 var RenderTarget = require('../../renderer/webgl/RenderTarget');
 var Utils = require('../../renderer/webgl/Utils');
 var UUID = require('../../utils/string/UUID');

src/renderer/canvas/CanvasRenderer.js

@@ -9,15 +9,22 @@ var CameraEvents = require('../../cameras/2d/events');
 var CanvasSnapshot = require('../snapshot/CanvasSnapshot');
 var Class = require('../../utils/Class');
 var CONST = require('../../const');
+var EventEmitter = require('eventemitter3');
+var Events = require('../events');
 var GetBlendModes = require('./utils/GetBlendModes');
 var ScaleEvents = require('../../scale/events');
+var TextureEvents = require('../../textures/events');
 var TransformMatrix = require('../../gameobjects/components/TransformMatrix');
 
 /**
  * @classdesc
- * The Canvas Renderer is responsible for managing 2D canvas rendering contexts, including the one used by the Game's canvas. It tracks the internal state of a given context and can renderer textured Game Objects to it, taking into account alpha, blending, and scaling.
+ * The Canvas Renderer is responsible for managing 2D canvas rendering contexts,
+ * including the one used by the Games canvas. It tracks the internal state of a
+ * given context and can renderer textured Game Objects to it, taking into
+ * account alpha, blending, and scaling.
  *
  * @class CanvasRenderer
+ * @extends Phaser.Events.EventEmitter
  * @memberof Phaser.Renderer.Canvas
  * @constructor
  * @since 3.0.0
@@ -26,10 +33,30 @@ var TransformMatrix = require('../../gameobjects/components/TransformMatrix');
  */
 var CanvasRenderer = new Class({
 
+    Extends: EventEmitter,
+
     initialize:
 
     function CanvasRenderer (game)
     {
+        EventEmitter.call(this);
+
+        var gameConfig = game.config;
+
+        /**
+         * The local configuration settings of the CanvasRenderer.
+         *
+         * @name Phaser.Renderer.Canvas.CanvasRenderer#config
+         * @type {object}
+         * @since 3.0.0
+         */
+        this.config = {
+            clearBeforeRender: gameConfig.clearBeforeRender,
+            backgroundColor: gameConfig.backgroundColor,
+            antialias: gameConfig.antialias,
+            roundPixels: gameConfig.roundPixels
+        };
+
         /**
          * The Phaser Game instance that owns this renderer.
          *
@@ -76,20 +103,6 @@ var CanvasRenderer = new Class({
          */
         this.height = 0;
 
-        /**
-         * The local configuration settings of the CanvasRenderer.
-         *
-         * @name Phaser.Renderer.Canvas.CanvasRenderer#config
-         * @type {object}
-         * @since 3.0.0
-         */
-        this.config = {
-            clearBeforeRender: game.config.clearBeforeRender,
-            backgroundColor: game.config.backgroundColor,
-            antialias: game.config.antialias,
-            roundPixels: game.config.roundPixels
-        };
-
         /**
          * The canvas element which the Game uses.
          *
@@ -111,7 +124,7 @@ var CanvasRenderer = new Class({
          * @type {CanvasRenderingContext2D}
          * @since 3.0.0
          */
-        this.gameContext = (this.game.config.context) ? this.game.config.context : this.gameCanvas.getContext('2d', contextOptions);
+        this.gameContext = (gameConfig.context) ? gameConfig.context : this.gameCanvas.getContext('2d', contextOptions);
 
         /**
          * The canvas context currently used by the CanvasRenderer for all rendering operations.
@@ -192,6 +205,15 @@ var CanvasRenderer = new Class({
          */
         this._tempMatrix3 = new TransformMatrix();
 
+        /**
+         * Has this renderer fully booted yet?
+         *
+         * @name Phaser.Renderer.Canvas.CanvasRenderer#isBooted
+         * @type {boolean}
+         * @since 3.50.0
+         */
+        this.isBooted = false;
+
         this.init();
     },
 
@@ -203,9 +225,28 @@ var CanvasRenderer = new Class({
      */
     init: function ()
     {
-        this.game.scale.on(ScaleEvents.RESIZE, this.onResize, this);
+        this.game.textures.once(TextureEvents.READY, this.boot, this);
+    },
+
+    /**
+     * Internal boot handler.
+     *
+     * @method Phaser.Renderer.Canvas.CanvasRenderer#boot
+     * @private
+     * @since 3.50.0
+     */
+    boot: function ()
+    {
+        var game = this.game;
 
-        var baseSize = this.game.scale.baseSize;
+        var baseSize = game.scale.baseSize;
+
+        this.width = baseSize.width;
+        this.height = baseSize.height;
+
+        this.isBooted = true;
+
+        game.scale.on(ScaleEvents.RESIZE, this.onResize, this);
 
         this.resize(baseSize.width, baseSize.height);
     },
@@ -232,6 +273,7 @@ var CanvasRenderer = new Class({
      * Resize the main game canvas.
      *
      * @method Phaser.Renderer.Canvas.CanvasRenderer#resize
+     * @fires Phaser.Renderer.Events#RESIZE
      * @since 3.0.0
      *
      * @param {number} [width] - The new width of the renderer.
@@ -241,6 +283,8 @@ var CanvasRenderer = new Class({
     {
         this.width = width;
         this.height = height;
+
+        this.emit(Events.RESIZE, width, height);
     },
 
     /**
@@ -309,6 +353,7 @@ var CanvasRenderer = new Class({
      * Called at the start of the render loop.
      *
      * @method Phaser.Renderer.Canvas.CanvasRenderer#preRender
+     * @fires Phaser.Renderer.Events#PRE_RENDER
      * @since 3.0.0
      */
     preRender: function ()
@@ -337,6 +382,8 @@ var CanvasRenderer = new Class({
         ctx.save();
 
         this.drawCount = 0;
+
+        this.emit(Events.PRE_RENDER);
     },
 
     /**
@@ -350,6 +397,7 @@ var CanvasRenderer = new Class({
      * This method is not called if `Camera.visible` is `false`, or `Camera.alpha` is zero.
      *
      * @method Phaser.Renderer.Canvas.CanvasRenderer#render
+     * @fires Phaser.Renderer.Events#RENDER
      * @since 3.0.0
      *
      * @param {Phaser.Scene} scene - The Scene to render.
@@ -360,6 +408,8 @@ var CanvasRenderer = new Class({
     {
         var childCount = children.length;
 
+        this.emit(Events.RENDER, scene, camera);
+
         var cx = camera.x;
         var cy = camera.y;
         var cw = camera.width;
@@ -456,6 +506,7 @@ var CanvasRenderer = new Class({
      * The post-render step happens after all Cameras in all Scenes have been rendered.
      *
      * @method Phaser.Renderer.Canvas.CanvasRenderer#postRender
+     * @fires Phaser.Renderer.Events#POST_RENDER
      * @since 3.0.0
      */
     postRender: function ()
@@ -464,6 +515,8 @@ var CanvasRenderer = new Class({
 
         ctx.restore();
 
+        this.emit(Events.POST_RENDER);
+
         var state = this.snapshotState;
 
         if (state.callback)
@@ -773,10 +826,11 @@ var CanvasRenderer = new Class({
      */
     destroy: function ()
     {
-        this.gameCanvas = null;
-        this.gameContext = null;
+        this.removeAllListeners();
 
         this.game = null;
+        this.gameCanvas = null;
+        this.gameContext = null;
     }
 
 });

…nderer/webgl/events/POST_RENDER_EVENT.js src/renderer/events/POST_RENDER_EVENT.jssrc/renderer/webgl/events/POST_RENDER_EVENT.js renamed to src/renderer/events/POST_RENDER_EVENT.js src/renderer/webgl/events/POST_RENDER_EVENT.js renamed to src/renderer/events/POST_RENDER_EVENT.js

@@ -7,10 +7,10 @@
 /**
  * The Post-Render Event.
  *
- * This event is dispatched by the WebGL Renderer when all rendering, for all cameras in all Scenes,
- * has completed.
+ * This event is dispatched by the Renderer when all rendering, for all cameras in all Scenes,
+ * has completed, but before any pending snap shots have been taken.
  *
- * @event Phaser.Renderer.WebGL.Events#POST_RENDER
+ * @event Phaser.Renderer.Events#POST_RENDER
  * @since 3.50.0
  */
 module.exports = 'postrender';

…enderer/webgl/events/PRE_RENDER_EVENT.js src/renderer/events/PRE_RENDER_EVENT.jssrc/renderer/webgl/events/PRE_RENDER_EVENT.js renamed to src/renderer/events/PRE_RENDER_EVENT.js src/renderer/webgl/events/PRE_RENDER_EVENT.js renamed to src/renderer/events/PRE_RENDER_EVENT.js

@@ -7,11 +7,11 @@
 /**
  * The Pre-Render Event.
  *
- * This event is dispatched by the WebGL Renderer. This happens right at the start of the render
- * process, after the context has been cleared, the scissors enabled and everything has been
+ * This event is dispatched by the Phaser Renderer. This happens right at the start of the render
+ * process, after the context has been cleared, the scissors enabled (WebGL only) and everything has been
  * reset ready for the render.
  *
- * @event Phaser.Renderer.WebGL.Events#PRE_RENDER
+ * @event Phaser.Renderer.Events#PRE_RENDER
  * @since 3.50.0
  */
 module.exports = 'prerender';

src/renderer/webgl/events/RENDER_EVENT.js src/renderer/events/RENDER_EVENT.jssrc/renderer/webgl/events/RENDER_EVENT.js renamed to src/renderer/events/RENDER_EVENT.js

@@ -7,11 +7,11 @@
 /**
  * The Render Event.
  *
- * This event is dispatched by the WebGL Renderer for every camera in every Scene.
+ * This event is dispatched by the Phaser Renderer for every camera in every Scene.
  *
  * It is dispatched before any of the children in the Scene have been rendered.
  *
- * @event Phaser.Renderer.WebGL.Events#RENDER
+ * @event Phaser.Renderer.Events#RENDER
  * @since 3.50.0
  *
  * @param {Phaser.Scene} scene - The Scene being rendered.

src/renderer/webgl/events/RESIZE_EVENT.js src/renderer/events/RESIZE_EVENT.jssrc/renderer/webgl/events/RESIZE_EVENT.js renamed to src/renderer/events/RESIZE_EVENT.js

@@ -7,10 +7,10 @@
 /**
  * The Renderer Resize Event.
  *
- * This event is dispatched by the WebGL Renderer when it is resized, usually as a result
+ * This event is dispatched by the Phaser Renderer when it is resized, usually as a result
  * of the Scale Manager resizing.
  *
- * @event Phaser.Renderer.WebGL.Events#RESIZE
+ * @event Phaser.Renderer.Events#RESIZE
  * @since 3.50.0
  *
  * @param {number} width - The new width of the renderer.

src/renderer/webgl/events/index.js src/renderer/events/index.jssrc/renderer/webgl/events/index.js renamed to src/renderer/events/index.js

@@ -5,7 +5,7 @@
  */
 
 /**
- * @namespace Phaser.Renderer.WebGL.Events
+ * @namespace Phaser.Renderer.Events
  */
 
 module.exports = {

src/renderer/webgl/RenderTarget.js

@@ -5,7 +5,7 @@
  */
 
 var Class = require('../../utils/Class');
-var Events = require('./events');
+var Events = require('../events');
 
 /**
  * @classdesc