PixiJS

Class: BaseRenderTexture

PIXI.BaseRenderTexture

A BaseRenderTexture 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 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();
let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600);
let renderTexture = new PIXI.RenderTexture(baseRenderTexture);
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 baseRenderTexture = new PIXI.BaseRenderTexture(100, 100);
let renderTexture = new PIXI.RenderTexture(baseRenderTexture);

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

new PIXI.BaseRenderTexture (options)

BaseRenderTexture.js:46
Name Type Description
options object optional
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 PIXI.SCALE_MODES optional

See PIXI.SCALE_MODES for possible values.
resolution number 1 optional

The resolution / device pixel ratio of the texture being generated.

Extends

Members

_canvasRenderTarget object protected

A reference to the canvas render target (we only need one as this can be shared across renderers)

cacheId string inherited

Currently default cache ID.

destroyed boolean readonly inherited

Flag if BaseTexture has been destroyed.

dirtyId number protected inherited

Used by TextureSystem to only update texture to the GPU when needed.

dirtyStyleId number protected inherited

Used by TextureSystem to only update texture style when needed.

filterStack Array.<PIXI.Graphics>

The data structure for the filters.

format PIXI.FORMATS inherited

The pixel format of the texture

Default Value:
  • PIXI.FORMATS.RGBA

height number readonly inherited overrides

The height of the base texture set when the image has loaded

isPowerOfTwo boolean readonly inherited

Whether or not the texture is a power of two, try to use power of two textures as much as you can

Default Value:
  • false

mipmap PIXI.MIPMAP_MODES inherited overrides

Mipmap mode of the texture, affects downscaled images

Default Value:
  • PIXI.settings.MIPMAP_TEXTURES

premultiplyAlpha boolean inherited

Set to true to enable pre-multiplied alpha

Default Value:
  • true

realHeight number readonly inherited

Pixel height of the source of this texture

realWidth number readonly inherited

Pixel width of the source of this texture

resolution number inherited

The resolution / device pixel ratio of the texture

Default Value:
  • PIXI.settings.RESOLUTION

resource PIXI.resources.Resource readonly inherited

The resource used by this BaseTexture, there can only be one resource per BaseTexture, but textures can share resources.

scaleMode PIXI.SCALE_MODES inherited

The scale mode to apply when scaling this texture

Default Value:
  • PIXI.settings.SCALE_MODE

stencilMaskStack Array.<PIXI.Graphics>

The data structure for the stencil masks.

target PIXI.TARGETS inherited

The target type

Default Value:
  • PIXI.TARGETS.TEXTURE_2D

textureCacheIds Array.<string> readonly inherited

The collection of alternative cache ids, since some BaseTextures can have more than one ID, short name and longer full URL

touched number protected inherited

TODO: fill in description

type PIXI.TYPES inherited

The type of resource data

Default Value:
  • PIXI.TYPES.UNSIGNED_BYTE

uid string protected inherited

Global unique identifier for this BaseTexture

valid boolean readonly inherited overrides

Generally speaking means when resource is loaded.

width number readonly inherited overrides

The width of the base texture set when the image has loaded

wrapMode number inherited

How the texture wraps

Methods

destroy () overrides

BaseRenderTexture.js:142

Destroys this texture.

dispose () overrides

BaseRenderTexture.js:131

Frees the texture and framebuffer from WebGL memory without destroying this texture object. This means you can still use the texture later which will upload it to GPU memory again.

Fires:

getDrawableSource ()PIXI.ICanvasImageSource inherited

BaseTexture.js:3

Get the drawable source, such as HTMLCanvasElement or HTMLImageElement suitable for rendering with CanvasRenderer. Provided by @pixi/canvas-renderer package.

Returns:
Type Description
PIXI.ICanvasImageSource Source to render with CanvasRenderer

resize (width, height)

BaseRenderTexture.js:117

Resizes the BaseRenderTexture.

Name Type Description
width number

The width to resize to.
height number

The height to resize to.

setRealSize (realWidth, realHeight, resolution)BaseTexture inherited

BaseTexture.js:363

Sets real size of baseTexture, preserves current resolution.

Name Type Description
realWidth number

Full rendered width
realHeight number

Full rendered height
resolution number optional

Optionally set resolution
Returns:
Type Description
BaseTexture this

setResolution (resolution)BaseTexture inherited

BaseTexture.js:390

Changes resolution

Name Type Description
resolution number optional

res
Returns:
Type Description
BaseTexture this

setResource (resource)BaseTexture inherited

BaseTexture.js:419

Sets the resource if it wasn't set. Throws error if resource already present

Name Type Description
resource PIXI.resources.Resource

that is managing this BaseTexture
Returns:
Type Description
BaseTexture this

setSize (width, height, resolution)BaseTexture inherited

BaseTexture.js:344

Changes w/h/resolution. Texture becomes valid if width and height are greater than zero.

Name Type Description
width number

Visual width
height number

Visual height
resolution number optional

Optionally set resolution
Returns:
Type Description
BaseTexture this

setStyle (scaleMode, mipmap)BaseTexture inherited

BaseTexture.js:312

Changes style options of BaseTexture

Name Type Description
scaleMode PIXI.SCALE_MODES optional

Pixi scalemode
mipmap PIXI.MIPMAP_MODES optional

enable mipmaps
Returns:
Type Description
BaseTexture this

update () inherited

BaseTexture.js:441

Invalidates the object. Texture becomes valid if width and height are greater than zero.

Events

dispose inherited

BaseTexture.js:271

Fired when BaseTexture is destroyed.

Name Type Description
baseTexture PIXI.BaseTexture

Instance of texture being destroyed.

error inherited overrides

BaseTexture.js:239

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

Name Type Description
baseTexture PIXI.BaseTexture

Resource errored.

loaded inherited overrides

BaseTexture.js:231

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

Name Type Description
baseTexture PIXI.BaseTexture

Resource loaded.

update inherited

BaseTexture.js:263

Fired when BaseTexture is updated.

Name Type Description
baseTexture PIXI.BaseTexture

Instance of texture being updated.