A RenderTexture is a special texture that allows any Pixi display object to be rendered to it.
Hint: All DisplayObjects (i.e. Sprites) that render to a RenderTexture should be preloaded otherwise black rectangles will be drawn instead.
A RenderTexture takes a snapshot of any Display Object given to its render method. The position and rotation of the given Display Objects is 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);
The Sprite in this case will be rendered to a position of 0,0. To render this sprite at its actual position a DisplayObjectContainer should be used:
var doc = new PIXI.DisplayObjectContainer();
doc.addChild(sprite);
renderTexture.render(doc); // Renders to center of renderTexture
| Name | Type | Description |
|---|---|---|
width | Number | The width of the render texture |
height | Number | The height of the render texture |
renderer | PIXI.CanvasRenderer | PIXI.WebGLRenderer | The renderer used for this RenderTexture |
scaleMode | Number | See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values |
resolution | Number | The resolution of the texture being generated |
The base texture object that this texture uses
This is the area of the BaseTexture image to actually copy to the Canvas / WebGL when rendering,
irrespective of the actual frame size or placement (which can be influenced by trimmed texture atlases)
The framing rectangle of the render texture
The height of the render texture
Is this a tiling texture? As used by the likes of a TilingSprite.
Does this Texture have any frame data assigned to it?
The renderer this RenderTexture uses. A RenderTexture can only belong to one renderer at the moment if its webGL.
This will let a renderer know that a tinted parent has updated its texture.
This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)
The Resolution of the texture.
The texture trim data.
The with of the render texture
Clears the RenderTexture.
Destroys this texture
| Name | Type | Description |
|---|---|---|
destroyBase | Boolean | Whether to destroy the base texture as well |
Will return a base64 encoded string of this texture. It works by calling RenderTexture.getCanvas and then running toDataURL on that.
A base64 encoded string of the texture.
Creates a Canvas element, renders this RenderTexture to it and then returns it.
A Canvas element with the texture rendered on.
Will return a HTML Image of the texture
Resizes the RenderTexture.
| Name | Type | Description |
|---|---|---|
width | Number | The width to resize to. |
height | Number | The height to resize to. |
updateBase | Boolean | Should the baseTexture.width and height values be resized as well? |
Specifies the region of the baseTexture that this texture will use.
| Name | Type | Description |
|---|---|---|
frame | Rectangle | The frame of the texture to set it to |
© 2016 Richard Davey, Photon Storm Ltd.
Licensed under the MIT License.
http://phaser.io/docs/2.6.2/PIXI.RenderTexture.html