Phaser Class: RenderTexture

new RenderTexture(game, key, width, height)

A RenderTexture is a special texture that allows any displayObject to be rendered to it.

Parameters:

Name	Type	Description
`game`	Phaser.Game	Current game instance.
`key`	string	Asset key for the render texture.
`width`	number	the width of the render texture.
`height`	number	the height of the render texture.

Source:

gameobjects/RenderTexture.js, line 16

Members

frame

Properties:

Name	Type	Description
`frame`	PIXI.Rectangle	The frame for this texture.

Source:

gameobjects/RenderTexture.js, line 48

game

Properties:

Name	Type	Description
`game`	Phaser.Game	A reference to the currently running game.

Source:

gameobjects/RenderTexture.js, line 21

height

Properties:

Name	Type	Description
`height`	number	the height.

Source:

gameobjects/RenderTexture.js, line 38

indetityMatrix

Properties:

Name	Type	Description
`indetityMatrix`	PIXI.mat3	Matrix object.

Source:

gameobjects/RenderTexture.js, line 43

name

Properties:

Name	Type	Description
`name`	string	the name of the object.

Source:

gameobjects/RenderTexture.js, line 26

type

Properties:

Name	Type	Description
`type`	number	Base Phaser object type.

Source:

gameobjects/RenderTexture.js, line 53

width

Properties:

Name	Type	Description
`width`	number	the width.

Source:

gameobjects/RenderTexture.js, line 33

Methods

render(displayObject, position, clear, renderHidden)

This function will draw the display object to the texture. If the display object is a Group or has children it will draw all children as well.

Parameters:

Name	Type	Argument	Default	Description
`displayObject`	DisplayObject			The display object to render this texture on.
`position`	Phaser.Point	<optional>		Where to draw the display object.
`clear`	boolean	<optional>	false	If true the texture will be cleared before the displayObject is drawn.
`renderHidden`	boolean	<optional>	false	If true displayObjects that have their visible property set to false will still be rendered.

Source:

gameobjects/RenderTexture.js, line 71

renderXY(displayObject, x, y, clear, renderHidden)

This function will draw the display object to the texture at the given x/y coordinates. If the display object is a Group or has children it will draw all children as well.

Parameters:

Name	Type	Argument	Default	Description
`displayObject`	DisplayObject			The display object to render this texture on.
`x`	number			The x coordinate to draw the display object at.
`y`	number			The y coordinate to draw the display object at.
`clear`	boolean	<optional>	false	If true the texture will be cleared before the displayObject is drawn.
`renderHidden`	boolean	<optional>	false	If true displayObjects that have their visible property set to false will still be rendered.

Source:

gameobjects/RenderTexture.js, line 104

resize()

Resizes the RenderTexture.

Source:

gameobjects/RenderTexture.js, line 169