diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 9909cf5..d5b9d4d 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -33,15 +33,17 @@ * * doc.addChild(sprite); * - * BaserenderTexture.render(doc); // Renders to center of BaserenderTexture + * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); + * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); + * + * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * * @class - * @extends PIXI.Texture + * @extends PIXI.BaseTexture * @memberof PIXI - * @param renderer {PIXI.CanvasRenderer|PIXI.WebGLRenderer} The renderer used for this BaseRenderTexture - * @param [width=100] {number} The width of the render texture - * @param [height=100] {number} The height of the render texture + * @param [width=100] {number} The width of the base render texture + * @param [height=100] {number} The height of the base render texture * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @param [resolution=1] {number} The resolution of the texture being generated */ @@ -56,15 +58,21 @@ this.scaleMode = scaleMode || CONST.SCALE_MODES.DEFAULT; this.hasLoaded = true; + /** + * A map of renderer IDs to webgl renderTargets + * + * @member {object} + * @private + */ this._glRenderTargets = []; - this._canvasRenderTarget = null; - /** - * The renderer this BaseRenderTexture uses. A BaseRenderTexture can only belong to one renderer at the moment if its webGL. + * A reference to the canvas render target (we only need one as this can be shared accross renderers) * - * @member {PIXI.CanvasRenderer|PIXI.WebGLRenderer} + * @member {object} + * @private */ + this._canvasRenderTarget = null; /** * @member {boolean} diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 9909cf5..d5b9d4d 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -33,15 +33,17 @@ * * doc.addChild(sprite); * - * BaserenderTexture.render(doc); // Renders to center of BaserenderTexture + * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); + * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); + * + * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * * @class - * @extends PIXI.Texture + * @extends PIXI.BaseTexture * @memberof PIXI - * @param renderer {PIXI.CanvasRenderer|PIXI.WebGLRenderer} The renderer used for this BaseRenderTexture - * @param [width=100] {number} The width of the render texture - * @param [height=100] {number} The height of the render texture + * @param [width=100] {number} The width of the base render texture + * @param [height=100] {number} The height of the base render texture * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @param [resolution=1] {number} The resolution of the texture being generated */ @@ -56,15 +58,21 @@ this.scaleMode = scaleMode || CONST.SCALE_MODES.DEFAULT; this.hasLoaded = true; + /** + * A map of renderer IDs to webgl renderTargets + * + * @member {object} + * @private + */ this._glRenderTargets = []; - this._canvasRenderTarget = null; - /** - * The renderer this BaseRenderTexture uses. A BaseRenderTexture can only belong to one renderer at the moment if its webGL. + * A reference to the canvas render target (we only need one as this can be shared accross renderers) * - * @member {PIXI.CanvasRenderer|PIXI.WebGLRenderer} + * @member {object} + * @private */ + this._canvasRenderTarget = null; /** * @member {boolean} diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index dfd3391..b401d99 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -12,7 +12,7 @@ * * ```js * var renderer = PIXI.autoDetectRenderer(1024, 1024, { view: canvas, ratio: 1 }); - * var renderTexture = new PIXI.RenderTexture(renderer, 800, 600); + * var renderTexture = PIXI.RenderTexture.create(800, 600); * var sprite = PIXI.Sprite.fromImage("spinObj_01.png"); * * sprite.position.x = 800/2; @@ -20,7 +20,7 @@ * sprite.anchor.x = 0.5; * sprite.anchor.y = 0.5; * - * renderTexture.render(sprite); + * renderer.render(sprite, renderTexture); * ``` * * The Sprite in this case will be rendered to a position of 0,0. To render this sprite at its actual @@ -31,17 +31,13 @@ * * doc.addChild(sprite); * - * renderTexture.render(doc); // Renders to center of renderTexture + * renderer.render(doc, renderTexture); // Renders to center of renderTexture * ``` * * @class * @extends PIXI.Texture * @memberof PIXI - * @param renderer {PIXI.CanvasRenderer|PIXI.WebGLRenderer} The renderer used for this RenderTexture - * @param [width=100] {number} The width of the render texture - * @param [height=100] {number} The height of the render texture - * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values - * @param [resolution=1] {number} The resolution of the texture being generated + * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture */ function RenderTexture(baseRenderTexture, frame) { @@ -109,7 +105,13 @@ this._updateUvs(); }; - +/** + * A short hand way of creating a render texture.. + * @param [width=100] {number} The width of the render texture + * @param [height=100] {number} The height of the render texture + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [resolution=1] {number} The resolution of the texture being generated + */ RenderTexture.create = function(width, height, scaleMode, resolution) { return new RenderTexture(new BaseRenderTexture(width, height, scaleMode, resolution));