Phaser Class: RenderTexture

new RenderTexture(game, key, width, height, key, scaleMode, resolution)

A RenderTexture is a special texture that allows any displayObject to be rendered to it. It allows you to take many complex objects and render them down into a single quad (on WebGL) which can then be used to texture other display objects with. A way of generating textures at run-time.

Parameters:

Name	Type	Argument	Default	Description
`game`	Phaser.Game			Current game instance.
`key`	string			Internal Phaser reference key for the render texture.
`width`	number	<optional>	100	The width of the render texture.
`height`	number	<optional>	100	The height of the render texture.
`key`	string	<optional>	''	The key of the RenderTexture in the Cache, if stored there.
`scaleMode`	number	<optional>	Phaser.scaleModes.DEFAULT	One of the Phaser.scaleModes consts.
`resolution`	number	<optional>	1	The resolution of the texture being generated.

Source:

gameobjects/RenderTexture.js, line 22

Extends

PIXI.RenderTexture

Members

game

Properties:

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

Source:

gameobjects/RenderTexture.js, line 31

key

Properties:

Name	Type	Description
`key`	string	The key of the RenderTexture in the Cache, if stored there.

Source:

gameobjects/RenderTexture.js, line 36

matrix

Properties:

Name	Type	Description
`matrix`	PIXI.Matrix	The matrix that is applied when display objects are rendered to this RenderTexture.

Source:

gameobjects/RenderTexture.js, line 46

type

Properties:

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

Source:

gameobjects/RenderTexture.js, line 41

Methods

render(displayObject, position, clear)

This function will draw the display object to the texture.

Parameters:

Name	Type	Description
`displayObject`	Phaser.Sprite \| Phaser.Image \| Phaser.Text \| Phaser.BitmapText \| Phaser.Group	The display object to render to this texture.
`position`	Phaser.Point	A Point object containing the position to render the display object at.
`clear`	boolean	If true the texture will be cleared before the display object is drawn.

Source:

gameobjects/RenderTexture.js, line 82

renderXY(displayObject, x, y, clear)

This function will draw the display object to the texture.

Parameters:

Name	Type	Description
`displayObject`	Phaser.Sprite \| Phaser.Image \| Phaser.Text \| Phaser.BitmapText \| Phaser.Group	The display object to render to this texture.
`x`	number	The x position to render the object at.
`y`	number	The y position to render the object at.
`clear`	boolean	If true the texture will be cleared before the display object is drawn.

Source:

gameobjects/RenderTexture.js, line 57