Class: BaseRenderTexture

PIXI. BaseRenderTexture

A BaseRenderTexture 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 BaseRenderTexture should be preloaded otherwise black rectangles will be drawn instead.

A BaseRenderTexture 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:

let renderer = PIXI.autoDetectRenderer(1024, 1024, { view: canvas, ratio: 1 });
let baseRenderTexture = new PIXI.BaseRenderTexture(renderer, 800, 600);
let 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;

baseRenderTexture.render(sprite);

The Sprite in this case will be rendered using its local transform. To render this sprite at 0,0 you can clear the transform


sprite.setTransform()

let baseRenderTexture = new PIXI.BaseRenderTexture(100, 100);
let renderTexture = new PIXI.RenderTexture(baseRenderTexture);

renderer.render(sprite, renderTexture);  // Renders to center of RenderTexture

new PIXI.BaseRenderTexture(width, height, scaleMode, resolution)

core/textures/BaseRenderTexture.js, line 45

Name	Type	Default	Description
`width`	number	100	optional The width of the base render texture
`height`	number	100	optional The height of the base render texture
`scaleMode`	number	PIXI.settings.SCALE_MODE	optional See PIXI.SCALE_MODES for possible values
`resolution`	number	1	optional The resolution / device pixel ratio of the texture being generated

Extends

PIXI.BaseTexture

Members

filterStackArray.<PIXI.Graphics>

The data structure for the filters

stencilMaskStackArray.<PIXI.Graphics>

The data structure for the stencil masks

Methods

destroy() core/textures/BaseRenderTexture.js, line 113

Destroys this texture

resize(width, height) core/textures/BaseRenderTexture.js, line 103

Resizes the BaseRenderTexture.

Name	Type	Description
`width`	number	The width to resize to.
`height`	number	The height to resize to.

Events

inherited dispose core/textures/BaseTexture.js, line 165

Fired when BaseTexture is destroyed.

Name	Type	Description
`baseTexture`	PIXI.BaseTexture	Instance of texture being destroyed.

inherited error core/textures/BaseTexture.js, line 133

Fired when a not-immediately-available source fails to load.

Name	Type	Description
`baseTexture`	PIXI.BaseTexture	Resource errored.

inherited loaded core/textures/BaseTexture.js, line 125

Fired when a not-immediately-available source finishes loading.

Name	Type	Description
`baseTexture`	PIXI.BaseTexture	Resource loaded.

inherited update core/textures/BaseTexture.js, line 157

Fired when BaseTexture is updated.

Name	Type	Description
`baseTexture`	PIXI.BaseTexture	Instance of texture being updated.