Add callbacks on Renderer

Author: orblazer

src/renderer/canvas/CanvasRenderer.js

@@ -132,7 +132,7 @@ var CanvasRenderer = new Class({
          * Map to the required function.
          *
          * @name Phaser.Renderer.Canvas.CanvasRenderer#drawImage
-         * @type {function}
+         * @type {Phaser.Renderer.Canvas.DrawImage}
          * @since 3.0.0
          */
         this.drawImage = DrawImage(this.config.roundPixels);
@@ -141,7 +141,7 @@ var CanvasRenderer = new Class({
          * [description]
          *
          * @name Phaser.Renderer.Canvas.CanvasRenderer#blitImage
-         * @type {function}
+         * @type {Phaser.Renderer.Canvas.BlitImage}
          * @since 3.0.0
          */
         this.blitImage = BlitImage(this.config.roundPixels);
@@ -189,7 +189,7 @@ var CanvasRenderer = new Class({
          * [description]
          *
          * @name Phaser.Renderer.Canvas.CanvasRenderer#snapshotCallback
-         * @type {?function}
+         * @type {?SnapshotCallback}
          * @default null
          * @since 3.0.0
          */
@@ -494,7 +494,7 @@ var CanvasRenderer = new Class({
      * @method Phaser.Renderer.Canvas.CanvasRenderer#snapshot
      * @since 3.0.0
      *
-     * @param {function} callback - [description]
+     * @param {SnapshotCallback} callback - [description]
      * @param {string} type - [description]
      * @param {number} encoderOptions - [description]
      */

src/renderer/snapshot/index.js

@@ -4,6 +4,12 @@
  * @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
  */
 
+/**
+ * @callback SnapshotCallback
+ *
+ * @param {HTMLImageElement} snapshot - [description]
+ */
+
 /**
  * @namespace Phaser.Renderer.Snapshot
  */

src/renderer/webgl/WebGLRenderer.js

@@ -16,6 +16,12 @@ var FlatTintPipeline = require('./pipelines/FlatTintPipeline');
 var ForwardDiffuseLightPipeline = require('./pipelines/ForwardDiffuseLightPipeline');
 var TextureTintPipeline = require('./pipelines/TextureTintPipeline');
 
+/**
+ * @callback WebGLContextCallback
+ *
+ * @param {Phaser.Renderer.WebGL.WebGLRenderer} renderer - [description]
+ */
+
 /**
  * @classdesc
  * [description]
@@ -115,7 +121,7 @@ var WebGLRenderer = new Class({
          * [description]
          *
          * @name Phaser.Renderer.WebGL.WebGLRenderer#lostContextCallbacks
-         * @type {function[]}
+         * @type {WebGLContextCallback[]}
          * @since 3.0.0
          */
         this.lostContextCallbacks = [];
@@ -124,7 +130,7 @@ var WebGLRenderer = new Class({
          * [description]
          *
          * @name Phaser.Renderer.WebGL.WebGLRenderer#restoredContextCallbacks
-         * @type {function[]}
+         * @type {WebGLContextCallback[]}
          * @since 3.0.0
          */
         this.restoredContextCallbacks = [];
@@ -384,7 +390,7 @@ var WebGLRenderer = new Class({
         var canvas = this.canvas;
         var clearColor = config.backgroundColor;
         var gl = canvas.getContext('webgl', config.contextCreation) || canvas.getContext('experimental-webgl', config.contextCreation);
-    
+
         if (!gl)
         {
             this.contextLost = true;
@@ -431,10 +437,10 @@ var WebGLRenderer = new Class({
         this.addPipeline('FlatTintPipeline', new FlatTintPipeline({ game: this.game, renderer: this }));
         this.addPipeline('BitmapMaskPipeline', new BitmapMaskPipeline({ game: this.game, renderer: this }));
         this.addPipeline('Light2D', new ForwardDiffuseLightPipeline({ game: this.game, renderer: this }));
-        
+
         this.setBlendMode(CONST.BlendModes.NORMAL);
         this.resize(this.width, this.height);
-    
+
         return this;
     },
 
@@ -457,7 +463,7 @@ var WebGLRenderer = new Class({
 
         this.width = Math.floor(width * resolution);
         this.height = Math.floor(height * resolution);
-        
+
         this.canvas.width = this.width;
         this.canvas.height = this.height;
 
@@ -484,7 +490,7 @@ var WebGLRenderer = new Class({
      * @method Phaser.Renderer.WebGL.WebGLRenderer#onContextRestored
      * @since 3.0.0
      *
-     * @param {function} callback - [description]
+     * @param {WebGLContextCallback} callback - [description]
      * @param {object} target - [description]
      *
      * @return {Phaser.Renderer.WebGL.WebGLRenderer} [description]
@@ -502,7 +508,7 @@ var WebGLRenderer = new Class({
      * @method Phaser.Renderer.WebGL.WebGLRenderer#onContextLost
      * @since 3.0.0
      *
-     * @param {function} callback - [description]
+     * @param {WebGLContextCallback} callback - [description]
      * @param {object} target - [description]
      *
      * @return {Phaser.Renderer.WebGL.WebGLRenderer} [description]
@@ -713,7 +719,7 @@ var WebGLRenderer = new Class({
         scissorStack[stackIndex + 1] = currentScissor[1];
         scissorStack[stackIndex + 2] = currentScissor[2];
         scissorStack[stackIndex + 3] = currentScissor[3];
-        
+
         this.currentScissorIdx += 4;
         this.setScissor(x, y, w, h);
 
@@ -732,15 +738,15 @@ var WebGLRenderer = new Class({
     {
         var scissorStack = this.scissorStack;
         var stackIndex = this.currentScissorIdx - 4;
-        
+
         var x = scissorStack[stackIndex + 0];
         var y = scissorStack[stackIndex + 1];
         var w = scissorStack[stackIndex + 2];
         var h = scissorStack[stackIndex + 3];
 
         this.currentScissorIdx = stackIndex;
         this.setScissor(x, y, w, h);
-        
+
         return this;
     },
 
@@ -1002,7 +1008,7 @@ var WebGLRenderer = new Class({
         if (indexBuffer !== this.currentIndexBuffer)
         {
             this.flush();
-            
+
             gl.bindBuffer(gl.ELEMENT_ARRAY_BUFFER, indexBuffer);
 
             this.currentIndexBuffer = indexBuffer;
@@ -1089,7 +1095,7 @@ var WebGLRenderer = new Class({
         pma = (pma === undefined || pma === null) ? true : pma;
 
         this.setTexture2D(texture, 0);
-        
+
         gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MIN_FILTER, minFilter);
         gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MAG_FILTER, magFilter);
         gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_WRAP_S, wrapS);
@@ -1356,7 +1362,7 @@ var WebGLRenderer = new Class({
         var ch = Math.floor(camera.height * resolution);
 
         this.pushScissor(cx, cy, cw, ch);
-        
+
         if (camera.backgroundColor.alphaGL > 0)
         {
             var color = camera.backgroundColor;
@@ -1533,7 +1539,7 @@ var WebGLRenderer = new Class({
      * @method Phaser.Renderer.WebGL.WebGLRenderer#snapshot
      * @since 3.0.0
      *
-     * @param {function} callback - [description]
+     * @param {SnapshotCallback} callback - [description]
      * @param {string} type - [description]
      * @param {float} encoderOptions - [description]
      *
@@ -1894,7 +1900,7 @@ var WebGLRenderer = new Class({
         {
             this.getExtension('WEBGL_lose_context').loseContext();
         }
-        
+
         delete this.gl;
         delete this.game;