PixiJS

Class: RenderTexture

PIXI.RenderTexture

A RenderTexture is a special texture that allows any PixiJS 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. For example:

let renderer = PIXI.autoDetectRenderer(1024, 1024);
let renderTexture = PIXI.RenderTexture.create(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;

renderer.render(sprite, renderTexture);

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 renderTexture = new PIXI.RenderTexture.create(100, 100);

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

new PIXI.RenderTexture (baseRenderTexture, frame)

RenderTexture.js:43
Name Type Description
baseRenderTexture PIXI.BaseRenderTexture

The renderer used for this RenderTexture
frame PIXI.Rectangle optional

The rectangle frame of the texture to show

Extends

Members

_frame PIXI.Rectangle inherited

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)

baseTexture PIXI.BaseTexture inherited

The base texture that this texture uses.

defaultAnchor PIXI.Point inherited

Anchor point that is used as default if sprite is created with this texture. Changing the defaultAnchor at a later point of time will not update Sprite's anchor point.

Default Value:
  • {0,0}

frame PIXI.Rectangle inherited

The frame specifies the region of the base texture that this texture uses. Please call _updateUvs() after you change coordinates of frame manually.

height number inherited

The height of the Texture in pixels.

noFrame boolean inherited

Does this Texture have any frame data assigned to it?

orig PIXI.Rectangle inherited

This is the area of original texture, before it was put in atlas

requiresUpdate boolean inherited

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

rotate number inherited

Indicates whether the texture is rotated inside the atlas set to 2 to compensate for texture packer rotation set to 6 to compensate for spine packer rotation can be used to rotate or mirror sprites See PIXI.GroupD8 for explanation

textureCacheIds inherited

The ids under which this Texture has been added to the texture cache. This is automatically set as long as Texture.addToCache is used, but may not be set if a Texture is added directly to the TextureCache array.

transform PIXI.TextureMatrix inherited

Contains data for uvs. May contain clamp settings and some matrices. Its a bit heavy, so by default that object is not created.

Default Value:
  • null

trim PIXI.Rectangle inherited

This is the trimmed area of original texture, before it was put in atlas Please call _updateUvs() after you change coordinates of trim manually.

valid boolean overrides

This will let the renderer know if the texture is valid. If it's not then it cannot be rendered.

width number inherited

The width of the Texture in pixels.

Methods

PIXI.RenderTexture.create (width, height, scaleMode, resolution)PIXI.RenderTexture static

RenderTexture.js:128

A short hand way of creating a render texture.

Name Type Default Description
width number 100 optional

The width of the render texture
height number 100 optional

The height of the 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
Returns:
Type Description
PIXI.RenderTexture The new render texture

_updateUvs () inherited

Texture.js:287

Updates the internal WebGL UV cache. Use it after you change frame or trim of the texture.

clone ()PIXI.Texture inherited

Texture.js:279

Creates a new texture object that acts the same as this one.

Returns:
Type Description
PIXI.Texture The new texture

destroy (destroyBase) inherited

Texture.js:241

Destroys this texture

Name Type Default Description
destroyBase boolean false optional

Whether to destroy the base texture as well

resize (width, height, doNotResizeBaseTexture)

RenderTexture.js:100

Resizes the RenderTexture.

Name Type Description
width number

The width to resize to.
height number

The height to resize to.
doNotResizeBaseTexture boolean

Should the baseTexture.width and height values be resized as well?

setFrame (frame) Deprecated : since version 3.0.0 inherited

deprecation.js:918
Name Type Description
frame PIXI.Rectangle

The frame to set.
See:

update () inherited

Texture.js:191

Updates this texture on the gpu.

Events

update inherited

Texture.js:159

Fired when the texture is updated. This happens if the frame or the baseTexture is updated.

Name Type Description
texture PIXI.Texture

Instance of texture being updated.