PIXI.CanvasPool has been moved into the Phaser utils folder, and renamed to Phaser.CanvasPool. All references to PIXI.CanvasPool have been updated to match the new namespace.

photonstorm · photonstorm · commit 1e15012a918a · 2016-09-28T12:53:04.000+01:00
diff --git a/README.md b/README.md
@@ -336,6 +336,7 @@ You can read all about the philosophy behind Lazer [here](http://phaser.io/news/
 * Phaser.SpriteBatch was incorrectly applying the prototypes, causing the Sprite Batch render methods to be replaced by the normal DisplayObjectContainer ones, meaning nothing was really batched at all. This has now been fixed, and PIXI.SpriteBatch removed, as it's no longer required.
 * PIXI.RenderTexture has been removed, and all functionality merged in to Phaser.RenderTexture, to cut down on the number of internal classes and inheritance going on.
 * PIXI.TilingSprite has been removed, and all functionality merged in to Phaser.TileSprite, to cut down on the number of internal classes and inheritance going on.
+* PIXI.CanvasPool has been moved into the Phaser `utils` folder, and renamed to `Phaser.CanvasPool`. All references to PIXI.CanvasPool have been updated to match the new namespace.
 
 ### Bug Fixes
 
diff --git a/src/gameobjects/BitmapData.js b/src/gameobjects/BitmapData.js
@@ -280,7 +280,7 @@ Phaser.BitmapData.prototype = {
 
         if (this._swapCanvas === undefined)
         {
-            this._swapCanvas = PIXI.CanvasPool.create(this, this.width, this.height);
+            this._swapCanvas = Phaser.CanvasPool.create(this, this.width, this.height);
         }
 
         var c = this._swapCanvas;
@@ -343,7 +343,7 @@ Phaser.BitmapData.prototype = {
 
         if (this._swapCanvas === undefined)
         {
-            this._swapCanvas = PIXI.CanvasPool.create(this, this.width, this.height);
+            this._swapCanvas = Phaser.CanvasPool.create(this, this.width, this.height);
         }
 
         var c = this._swapCanvas;
@@ -2032,7 +2032,7 @@ Phaser.BitmapData.prototype = {
 
         this.texture.destroy(true);
 
-        PIXI.CanvasPool.remove(this);
+        Phaser.CanvasPool.remove(this);
 
     },
 
diff --git a/src/gameobjects/Text.js b/src/gameobjects/Text.js
@@ -83,7 +83,7 @@ Phaser.Text = function (game, x, y, text, style) {
     /**
      * @property {HTMLCanvasElement} canvas - The canvas element that the text is rendered.
      */
-    this.canvas = PIXI.CanvasPool.create(this);
+    this.canvas = Phaser.CanvasPool.create(this);
 
     /**
      * @property {HTMLCanvasElement} context - The context of the canvas element that the text is rendered to.
diff --git a/src/input/Input.js b/src/input/Input.js
@@ -418,7 +418,7 @@ Phaser.Input.prototype = {
 
         this.activePointer = this.mousePointer;
 
-        this.hitCanvas = PIXI.CanvasPool.create(this, 1, 1);
+        this.hitCanvas = Phaser.CanvasPool.create(this, 1, 1);
         this.hitContext = this.hitCanvas.getContext('2d');
 
         this.mouse.start();
@@ -464,7 +464,7 @@ Phaser.Input.prototype = {
 
         this.moveCallbacks = [];
 
-        PIXI.CanvasPool.remove(this);
+        Phaser.CanvasPool.remove(this);
 
         this.game.canvas.removeEventListener('click', this._onClickTrampoline);
 
diff --git a/src/pixi/renderers/canvas/utils/CanvasBuffer.js b/src/pixi/renderers/canvas/utils/CanvasBuffer.js
@@ -34,7 +34,7 @@ PIXI.CanvasBuffer = function(width, height)
      * @property canvas
      * @type HTMLCanvasElement
      */
-    this.canvas = PIXI.CanvasPool.create(this, this.width, this.height);
+    this.canvas = Phaser.CanvasPool.create(this, this.width, this.height);
 
     /**
      * A CanvasRenderingContext2D object representing a two-dimensional rendering context.
@@ -82,5 +82,5 @@ PIXI.CanvasBuffer.prototype.resize = function(width, height)
  */
 PIXI.CanvasBuffer.prototype.destroy = function()
 {
-    PIXI.CanvasPool.remove(this);
+    Phaser.CanvasPool.remove(this);
 };
diff --git a/src/pixi/renderers/canvas/utils/CanvasTinter.js b/src/pixi/renderers/canvas/utils/CanvasTinter.js
@@ -21,7 +21,7 @@ PIXI.CanvasTinter = function() {};
  */
 PIXI.CanvasTinter.getTintedTexture = function(sprite, color)
 {
-    var canvas = sprite.tintedTexture || PIXI.CanvasPool.create(this);
+    var canvas = sprite.tintedTexture || Phaser.CanvasPool.create(this);
     
     PIXI.CanvasTinter.tintMethod(sprite.texture, color, canvas);
 
diff --git a/src/pixi/renderers/webgl/WebGLRenderer.js b/src/pixi/renderers/webgl/WebGLRenderer.js
@@ -584,7 +584,7 @@ PIXI.WebGLRenderer.prototype.destroy = function()
     this.gl = null;
     this.renderSession = null;
 
-    PIXI.CanvasPool.remove(this);
+    Phaser.CanvasPool.remove(this);
 
     PIXI.instances[this.glContextId] = null;
 
diff --git a/src/pixi/textures/BaseTexture.js b/src/pixi/textures/BaseTexture.js
@@ -167,7 +167,7 @@ PIXI.BaseTexture.prototype.destroy = function()
 {
     if (this.source)
     {
-        PIXI.CanvasPool.removeByCanvas(this.source);
+        Phaser.CanvasPool.removeByCanvas(this.source);
     }
 
     this.source = null;
diff --git a/src/pixi/utils/Utils.js b/src/pixi/utils/Utils.js
@@ -41,7 +41,7 @@ PIXI.canUseNewCanvasBlendModes = function()
     var yellow = new Image();
     yellow.src = pngHead + '/wCKxvRF' + pngEnd;
 
-    var canvas = PIXI.CanvasPool.create(this, 6, 1);
+    var canvas = Phaser.CanvasPool.create(this, 6, 1);
     var context = canvas.getContext('2d');
     context.globalCompositeOperation = 'multiply';
     context.drawImage(magenta, 0, 0);
@@ -54,7 +54,7 @@ PIXI.canUseNewCanvasBlendModes = function()
 
     var data = context.getImageData(2,0,1,1).data;
 
-    PIXI.CanvasPool.remove(this);
+    Phaser.CanvasPool.remove(this);
 
     return (data[0] === 255 && data[1] === 0 && data[2] === 0);
 
diff --git a/src/tilemap/TilemapLayer.js b/src/tilemap/TilemapLayer.js
@@ -56,7 +56,7 @@ Phaser.TilemapLayer = function (game, tilemap, index, width, height) {
     * @property {HTMLCanvasElement} canvas
     * @protected
     */
-    this.canvas = PIXI.CanvasPool.create(this, width, height);
+    this.canvas = Phaser.CanvasPool.create(this, width, height);
 
     /**
     * The 2d context of the canvas.
@@ -263,7 +263,7 @@ Phaser.TilemapLayer.ensureSharedCopyCanvas = function () {
 
     if (!this.sharedCopyCanvas)
     {
-        this.sharedCopyCanvas = PIXI.CanvasPool.create(this, 2, 2);
+        this.sharedCopyCanvas = Phaser.CanvasPool.create(this, 2, 2);
     }
 
     return this.sharedCopyCanvas;
@@ -355,7 +355,7 @@ Phaser.TilemapLayer.prototype._renderWebGL = function (renderSession) {
 */
 Phaser.TilemapLayer.prototype.destroy = function() {
 
-    PIXI.CanvasPool.remove(this);
+    Phaser.CanvasPool.remove(this);
 
     Phaser.Component.Destroy.prototype.destroy.call(this);
 
diff --git a/src/utils/Canvas.js b/src/utils/Canvas.js
@@ -29,7 +29,7 @@ Phaser.Canvas = {
         width = width || 256;
         height = height || 256;
 
-        var canvas = (skipPool) ? document.createElement('canvas') : PIXI.CanvasPool.create(parent, width, height);
+        var canvas = (skipPool) ? document.createElement('canvas') : Phaser.CanvasPool.create(parent, width, height);
 
         if (typeof id === 'string' && id !== '')
         {
diff --git a/src/utils/CanvasPool.js b/src/utils/CanvasPool.js
@@ -0,0 +1,184 @@
+/**
+* @author       Richard Davey <rich@photonstorm.com>
+* @copyright    2016 Photon Storm Ltd.
+* @license      {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
+*/
+
+/**
+* The CanvasPool is a global static object, that allows Phaser to recycle and pool Canvas DOM elements.
+*
+* @class Phaser.CanvasPool
+* @static
+*/
+Phaser.CanvasPool = {
+
+    /**
+    * Creates a new Canvas DOM element, or pulls one from the pool if free.
+    * 
+    * @method Phaser.CanvasPool.create
+    * @static
+    * @param {any} parent - The parent of the canvas element.
+    * @param {number} width - The width of the canvas element.
+    * @param {number} height - The height of the canvas element.
+    * @return {HTMLCanvasElement} The canvas element.
+    */
+    create: function (parent, width, height) {
+
+        var idx = Phaser.CanvasPool.getFirst();
+        var canvas;
+
+        if (idx === -1)
+        {
+            var container = {
+                parent: parent,
+                canvas: document.createElement('canvas')
+            };
+
+            Phaser.CanvasPool.pool.push(container);
+
+            canvas = container.canvas;
+        }
+        else
+        {
+            Phaser.CanvasPool.pool[idx].parent = parent;
+
+            canvas = Phaser.CanvasPool.pool[idx].canvas;
+        }
+
+        if (width !== undefined)
+        {
+            canvas.width = width;
+            canvas.height = height;
+        }
+
+        return canvas;
+
+    },
+
+    /**
+    * Gets the first free canvas index from the pool.
+    * 
+    * @static
+    * @method Phaser.CanvasPool.getFirst
+    * @return {number}
+    */
+    getFirst: function () {
+
+        var pool = Phaser.CanvasPool.pool;
+
+        for (var i = 0; i < pool.length; i++)
+        {
+            if (!pool[i].parent)
+            {
+                return i;
+            }
+        }
+
+        return -1;
+
+    },
+
+    /**
+    * Removes the parent from a canvas element from the pool, freeing it up for re-use.
+    * 
+    * @static
+    * @method Phaser.CanvasPool.remove
+    * @param {any} parent - The parent of the canvas element.
+    */
+    remove: function (parent) {
+
+        var pool = Phaser.CanvasPool.pool;
+
+        for (var i = 0; i < pool.length; i++)
+        {
+            if (pool[i].parent === parent)
+            {
+                pool[i].parent = null;
+                pool[i].canvas.width = 1;
+                pool[i].canvas.height = 1;
+            }
+        }
+
+    },
+
+    /**
+    * Removes the parent from a canvas element from the pool, freeing it up for re-use.
+    * 
+    * @static
+    * @method Phaser.CanvasPool.removeByCanvas
+    * @param {HTMLCanvasElement} canvas - The canvas element to remove.
+    */
+    removeByCanvas: function (canvas) {
+
+        var pool = Phaser.CanvasPool.pool;
+
+        for (var i = 0; i < pool.length; i++)
+        {
+            if (pool[i].canvas === canvas)
+            {
+                pool[i].parent = null;
+                pool[i].canvas.width = 1;
+                pool[i].canvas.height = 1;
+            }
+        }
+
+    },
+
+    /**
+    * Gets the total number of used canvas elements in the pool.
+    * 
+    * @static
+    * @method Phaser.CanvasPool.getTotal
+    * @return {number} The number of in-use (parented) canvas elements in the pool.
+    */
+    getTotal: function () {
+
+        var pool = Phaser.CanvasPool.pool;
+        var c = 0;
+
+        for (var i = 0; i < pool.length; i++)
+        {
+            if (pool[i].parent)
+            {
+                c++;
+            }
+        }
+
+        return c;
+
+    },
+
+    /**
+    * Gets the total number of free canvas elements in the pool.
+    * 
+    * @static
+    * @method Phaser.CanvasPool.getFree
+    * @return {number} The number of free (un-parented) canvas elements in the pool.
+    */
+    getFree: function () {
+
+        var pool = Phaser.CanvasPool.pool;
+        var c = 0;
+
+        for (var i = 0; i < pool.length; i++)
+        {
+            if (!pool[i].parent)
+            {
+                c++;
+            }
+        }
+
+        return c;
+
+    }
+
+};
+
+/**
+ * The pool into which the canvas elements are placed.
+ *
+ * @property pool
+ * @type Array
+ * @static
+ */
+Phaser.CanvasPool.pool = [];
diff --git a/src/utils/Debug.js b/src/utils/Debug.js
@@ -115,7 +115,7 @@ Phaser.Utils.Debug.prototype = {
 
             this.game.scale.onSizeChange.add(this.resize, this);
 
-            this.canvas = PIXI.CanvasPool.create(this, this.game.width, this.game.height);
+            this.canvas = Phaser.CanvasPool.create(this, this.game.width, this.game.height);
             this.context = this.canvas.getContext('2d');
         }
 
@@ -881,7 +881,7 @@ Phaser.Utils.Debug.prototype = {
     */
     destroy: function () {
     
-        PIXI.CanvasPool.remove(this);
+        Phaser.CanvasPool.remove(this);
 
     }
 
diff --git a/src/utils/Device.js b/src/utils/Device.js
@@ -1150,7 +1150,7 @@ Phaser.Device._initialize = function () {
             return false;
         }
 
-        var elem = PIXI.CanvasPool.create(this, 1, 1);
+        var elem = Phaser.CanvasPool.create(this, 1, 1);
         var ctx = elem.getContext('2d');
 
         if (!ctx)
@@ -1160,7 +1160,7 @@ Phaser.Device._initialize = function () {
 
         var image = ctx.createImageData(1, 1);
 
-        PIXI.CanvasPool.remove(this);
+        Phaser.CanvasPool.remove(this);
 
         return image.data instanceof Uint8ClampedArray;
 

Original file line number	Diff line number	Diff line change
`@@ -280,7 +280,7 @@ Phaser.BitmapData.prototype = {`
`280`	`280`
`281`	`281`	`if (this._swapCanvas === undefined)`
`282`	`282`	`{`
`283`		`- this._swapCanvas = PIXI.CanvasPool.create(this, this.width, this.height);`
	`283`	`+ this._swapCanvas = Phaser.CanvasPool.create(this, this.width, this.height);`
`284`	`284`	`}`
`285`	`285`
`286`	`286`	`var c = this._swapCanvas;`
`@@ -343,7 +343,7 @@ Phaser.BitmapData.prototype = {`
`343`	`343`
`344`	`344`	`if (this._swapCanvas === undefined)`
`345`	`345`	`{`
`346`		`- this._swapCanvas = PIXI.CanvasPool.create(this, this.width, this.height);`
	`346`	`+ this._swapCanvas = Phaser.CanvasPool.create(this, this.width, this.height);`
`347`	`347`	`}`
`348`	`348`
`349`	`349`	`var c = this._swapCanvas;`
`@@ -2032,7 +2032,7 @@ Phaser.BitmapData.prototype = {`
`2032`	`2032`
`2033`	`2033`	`this.texture.destroy(true);`
`2034`	`2034`
`2035`		`- PIXI.CanvasPool.remove(this);`
	`2035`	`+ Phaser.CanvasPool.remove(this);`
`2036`	`2036`
`2037`	`2037`	`},`
`2038`	`2038`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ PIXI.CanvasTinter = function() {};`
`21`	`21`	`*/`
`22`	`22`	`PIXI.CanvasTinter.getTintedTexture = function(sprite, color)`
`23`	`23`	`{`
`24`		`- var canvas = sprite.tintedTexture \|\| PIXI.CanvasPool.create(this);`
	`24`	`+ var canvas = sprite.tintedTexture \|\| Phaser.CanvasPool.create(this);`
`25`	`25`
`26`	`26`	`PIXI.CanvasTinter.tintMethod(sprite.texture, color, canvas);`
`27`	`27`
Original file line number	Diff line number	Diff line change
`@@ -167,7 +167,7 @@ PIXI.BaseTexture.prototype.destroy = function()`
`167`	`167`	`{`
`168`	`168`	`if (this.source)`
`169`	`169`	`{`
`170`		`- PIXI.CanvasPool.removeByCanvas(this.source);`
	`170`	`+ Phaser.CanvasPool.removeByCanvas(this.source);`
`171`	`171`	`}`
`172`	`172`
`173`	`173`	`this.source = null;`