From e1f8766a7152756f04679bf4e638c730b11c4c84 Mon Sep 17 00:00:00 2001 From: Jeena Paradies Date: Sat, 8 Mar 2014 01:15:14 +0100 Subject: [PATCH] Added doc for BaseTexture.fromCanvas --- src/pixi/textures/BaseTexture.js | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/pixi/textures/BaseTexture.js b/src/pixi/textures/BaseTexture.js index fd65bfd..0b7d873 100644 --- a/src/pixi/textures/BaseTexture.js +++ b/src/pixi/textures/BaseTexture.js @@ -167,6 +167,16 @@ PIXI.BaseTexture.fromImage = function(imageUrl, crossorigin, scaleMode) return baseTexture; }; +/** + * Helper function that returns a base texture based on a canvas element + * If the image is not in the base texture cache it will be created and loaded + * + * @static + * @method fromCanvas + * @param canvas {Canvas} The canvas element source of the texture + * @param scaleMode {Number} Should be one of the PIXI.scaleMode consts + * @return BaseTexture + */ PIXI.BaseTexture.fromCanvas = function(canvas, scaleMode) { if(!canvas._pixiId)