improve documentation. closes #141 and #142

This commit is contained in:
Vsevolod Strukchinsky 2013-05-25 18:35:55 +06:00
parent 7dc77bdbbc
commit 650951c000

View file

@ -3,13 +3,33 @@
*/ */
/** /**
* A RenderTexture is a special texture that allows any pixi displayObject to be rendered to it. A RenderTexture is a special texture that allows any pixi displayObject to be rendered to it.
* @class RenderTexture
* @extends Texture __Hint__: All DisplayObjects (exmpl. Sprites) that renders on RenderTexture should be preloaded.
* @constructor Otherwise black rectangles will be drawn instead.
* @param width {Number}
* @param height {Number} RenderTexture takes snapshot of DisplayObject passed to render method. If DisplayObject is passed to render method, position and rotation of it will be ignored. For example:
*/
var renderTexture = new PIXI.RenderTexture(800, 600);
var sprite = PIXI.Sprite.fromImage("spinObj_01.png");
sprite.position.x = 800/2;
sprite.position.y = 600/2;
sprite.anchor.x = 0.5;
sprite.anchor.y = 0.5;
renderTexture.render(sprite);
Sprite in this case will be rendered to 0,0 position. To render this sprite at center DisplayObjectContainer should be used:
var doc = new PIXI.DisplayObjectContainer();
doc.addChild(sprite);
renderTexture.render(doc); // Renders to center of renderTexture
@class RenderTexture
@extends Texture
@constructor
@param width {Number}
@param height {Number}
**/
PIXI.RenderTexture = function(width, height) PIXI.RenderTexture = function(width, height)
{ {
PIXI.EventTarget.call( this ); PIXI.EventTarget.call( this );