RenderTexture Class
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
Constructor
RenderTexture
-
width -
height -
renderer -
scaleMode -
resolution
Parameters:
-
widthNumberThe width of the render texture
-
heightNumberThe height of the render texture
-
rendererCanvasRenderer | WebGLRendererThe renderer used for this RenderTexture
-
scaleModeNumberShould be one of the PIXI.scaleMode consts
-
resolutionNumberThe resolution of the texture being generated
Item Index
Methods
Properties
Methods
_updateUvs
()
private
Updates the internal WebGL UV cache.
clear
()
Clears the RenderTexture.
destroy
-
destroyBase
Destroys this texture
Parameters:
-
destroyBaseBooleanWhether to destroy the base texture as well
emit
-
eventName
Emit an event to all registered event listeners.
Parameters:
-
eventNameStringThe name of the event.
Returns:
Indication if we've emitted an event.
getBase64
()
String
Will return a a base64 encoded string of this texture. It works by calling RenderTexture.getCanvas and then running toDataURL on that.
Returns:
A base64 encoded string of the texture.
getCanvas
()
HTMLCanvasElement
Creates a Canvas element, renders this RenderTexture to it and then returns it.
Returns:
A Canvas element with the texture rendered on.
getImage
()
HTMLImage
Will return a HTML Image of the texture
Returns:
listeners
-
eventName
Return a list of assigned event listeners.
Parameters:
-
eventNameStringThe events that should be listed.
Returns:
An array of listener functions
mixin
-
object
Mixes in the properties of the EventTarget prototype onto another object
Parameters:
-
objectObjectThe obj to mix into
off
-
eventName -
callback
Remove event listeners.
Parameters:
-
eventNameStringThe event we want to remove.
-
callbackFunctionThe listener that we need to find.
on
-
eventName -
callback
Register a new EventListener for the given event.
Parameters:
-
eventNameStringName of the event.
-
callbackFunctonfn Callback function.
onBaseTextureLoaded
()
private
Called when the base texture is loaded
once
-
eventName -
callback
Add an EventListener that's only called once.
Parameters:
-
eventNameStringName of the event.
-
callbackFunctionCallback function.
removeAllListeners
-
eventName
Remove all listeners or only the listeners for the specified event.
Parameters:
-
eventNameStringThe event you want to remove all listeners for.
renderCanvas
-
displayObject -
[matrix] -
[clear]
This function will draw the display object to the texture.
Parameters:
-
displayObjectDisplayObjectThe display object to render this texture on
-
[matrix]Matrix optionalOptional matrix to apply to the display object before rendering.
-
[clear]Boolean optionalIf true the texture will be cleared before the displayObject is drawn
renderWebGL
-
displayObject -
[matrix] -
[clear]
This function will draw the display object to the texture.
Parameters:
-
displayObjectDisplayObjectThe display object to render this texture on
-
[matrix]Matrix optionalOptional matrix to apply to the display object before rendering.
-
[clear]Boolean optionalIf true the texture will be cleared before the displayObject is drawn
resize
-
width -
height -
updateBase
Resizes the RenderTexture.
Parameters:
-
widthNumberThe width to resize to.
-
heightNumberThe height to resize to.
-
updateBaseBooleanShould the baseTexture.width and height values be resized as well?
setFrame
-
frame
Specifies the region of the baseTexture that this texture will use.
Parameters:
-
frameRectangleThe frame of the texture to set it to
Properties
_uvs
Object
private
The WebGL UV data cache.
crop
Rectangle
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)
height
Number
The height of the render texture
noFrame
Boolean
Does this Texture have any frame data assigned to it?
renderer
CanvasRenderer | WebGLRenderer
The renderer this RenderTexture uses. A RenderTexture can only belong to one renderer at the moment if its webGL.
requiresUpdate
Boolean
This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)
resolution
Number
The Resolution of the texture.
valid
Boolean
width
Number
The with of the render texture