Phaser Class: CanvasPool

The CanvasPool is a global static object that allows Pixi and Phaser to pool canvas DOM elements.

<static> pool :Array

The pool into which the canvas dom elements are placed.

<static> create(parent, width, height) → {HTMLCanvasElement}

Creates a new Canvas DOM element, or pulls one from the pool if free.

Name	Type	Description
`parent`		The parent of the canvas element.
`width`	Number	The width of the canvas element.
`height`	Number	The height of the canvas element.

HTMLCanvasElement -

The canvas element.

<static> getFirst() → {Number}

Gets the first free canvas index from the pool.

Number -

<static> getFree() → {Number}

Gets the total number of free canvas elements in the pool.

Number -

The number of free (un-parented) canvas elements in the pool.

<static> getTotal() → {Number}

Gets the total number of used canvas elements in the pool.

Number -

The number of in-use (parented) canvas elements in the pool.

<static> remove(parent)

Removes the parent from a canvas element from the pool, freeing it up for re-use.

Name	Type	Description
`parent`		The parent of the canvas element.

<static> removeByCanvas(canvas)

Removes the parent from a canvas element from the pool, freeing it up for re-use.

Name	Type	Description
`canvas`	HTMLCanvasElement	The canvas element to remove