Extends

• PIXI.RenderTexture

Members

baseTexture :PIXI.BaseTexture

The base texture object that this texture uses

Inherited From:

• PIXI.RenderTexture#baseTexture

Source - pixi/textures/RenderTexture.js, line 78

crop :PIXI.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)

Inherited From:

• PIXI.RenderTexture#crop

Source - pixi/textures/RenderTexture.js, line 69

frame :PIXI.Rectangle

The framing rectangle of the render texture

Inherited From:

• PIXI.RenderTexture#frame

Source - pixi/textures/RenderTexture.js, line 61

game :Phaser.Game

A reference to the currently running game.

Source - gameobjects/RenderTexture.js, line 31

height :Number

The height of the render texture

Inherited From:

• PIXI.RenderTexture#height

Source - pixi/textures/RenderTexture.js, line 45

key :string

The key of the RenderTexture in the Cache, if stored there.

Source - gameobjects/RenderTexture.js, line 36

matrix :PIXI.Matrix

The matrix that is applied when display objects are rendered to this RenderTexture.

Source - gameobjects/RenderTexture.js, line 46

noFrame :Boolean

Does this Texture have any frame data assigned to it?

Inherited From:

• PIXI.Texture#noFrame

Source - pixi/textures/Texture.js, line 24

renderer :PIXI.CanvasRenderer|PIXI.WebGLRenderer

The renderer this RenderTexture uses. A RenderTexture can only belong to one renderer at the moment if its webGL.

Type:

• PIXI.CanvasRenderer | PIXI.WebGLRenderer

Inherited From:

• PIXI.RenderTexture#renderer

Source - pixi/textures/RenderTexture.js, line 99

requiresUpdate :Boolean

This will let a renderer know that a texture has been updated (used mainly for webGL uv updates)

Inherited From:

• PIXI.Texture#requiresUpdate

Source - pixi/textures/Texture.js, line 75

resolution :Number

The Resolution of the texture.

Inherited From:

• PIXI.RenderTexture#resolution

Source - pixi/textures/RenderTexture.js, line 53

trim :PIXI.Rectangle

The texture trim data.

Inherited From:

• PIXI.Texture#trim

Source - pixi/textures/Texture.js, line 59

type :number

Base Phaser object type.

Source - gameobjects/RenderTexture.js, line 41

valid :Boolean

Inherited From:

• PIXI.RenderTexture#valid

Source - pixi/textures/RenderTexture.js, line 125

width :Number

The with of the render texture

Inherited From:

• PIXI.RenderTexture#width

Source - pixi/textures/RenderTexture.js, line 37

Methods

clear()

Clears the RenderTexture.

Inherited From:

• PIXI.RenderTexture#clear

Source - pixi/textures/RenderTexture.js, line 171

destroy(destroyBase)

Destroys this texture

Parameters:

Name	Type	Description
destroyBase	Boolean	Whether to destroy the base texture as well

Inherited From:

• PIXI.Texture#destroy

Source - pixi/textures/Texture.js, line 149

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:

String -

A base64 encoded string of the texture.

Inherited From:

• PIXI.RenderTexture#getBase64

Source - pixi/textures/RenderTexture.js, line 291

getCanvas() → {HTMLCanvasElement}

Creates a Canvas element, renders this RenderTexture to it and then returns it.

Returns:

HTMLCanvasElement -

A Canvas element with the texture rendered on.

Inherited From:

• PIXI.RenderTexture#getCanvas

Source - pixi/textures/RenderTexture.js, line 302

getImage() → {Image}

Will return a HTML Image of the texture

Returns:

Image -

Inherited From:

• PIXI.RenderTexture#getImage

Source - pixi/textures/RenderTexture.js, line 278

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

resize(width, height, updateBase)

Resizes the RenderTexture.

Parameters:

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?

Inherited From:

• PIXI.RenderTexture#resize

Source - pixi/textures/RenderTexture.js, line 137

setFrame(frame)

Specifies the region of the baseTexture that this texture will use.

Parameters:

Name	Type	Description
frame	PIXI.Rectangle	The frame of the texture to set it to

Inherited From:

• PIXI.Texture#setFrame

Source - pixi/textures/Texture.js, line 162