Class 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.

Hint-2: The actual memory allocation will happen on first render. You shouldn't create renderTextures each frame just to delete them after, try to reuse them.

A RenderTexture takes a snapshot of any Display Object given to its render method. For example:

Example

import { autoDetectRenderer, RenderTexture, Sprite } from 'pixi.js';

const renderer = autoDetectRenderer();
const renderTexture = RenderTexture.create({ width: 800, height: 600 });
const sprite = Sprite.from('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 });

// Note that you should not create a new renderer, but reuse the same one as the rest of the application.
// 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();

const renderTexture = new RenderTexture.create({ width: 100, height: 100 });

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

Memberof

PIXI

Hierarchy (View Summary)

Texture
- RenderTexture

Constructors

constructor

new RenderTexture(
baseRenderTexture: BaseRenderTexture,
frame?: Rectangle,
): RenderTexture
Parameters
- baseRenderTexture: BaseRenderTexture
  The base texture object that this texture uses.
- Optionalframe: Rectangle
  The rectangle frame of the texture to show.
Returns RenderTexture
Overrides Texture.constructor

Properties

_frame

_frame: 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)

baseTexture

baseTexture: BaseRenderTexture

The base texture that this texture uses.

defaultAnchor

defaultAnchor: Point

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

{0,0}

`Optional`defaultBorders

defaultBorders?: ITextureBorders

Default width of the non-scalable border that is used if 9-slice plane is created with this texture.

Since

7.2.0

See

PIXI.NineSlicePlane

`Readonly`destroyed

destroyed: boolean

Has the texture been destroyed?

`Readonly`filterFrame

filterFrame: null | Rectangle

Stores sourceFrame when this texture is inside current filter stack.

You can read it inside filters.

filterPoolKey

filterPoolKey: null | string | number

The key for pooled texture of FilterSystem.

See

PIXI.RenderTexturePool

noFrame

noFrame: boolean

Does this Texture have any frame data assigned to it?

This mode is enabled automatically if no frame was passed inside constructor.

In this mode texture is subscribed to baseTexture events, and fires update on any change.

Beware, after loading or resize of baseTexture event can fired two times! If you want more control, subscribe on baseTexture itself.

Any assignment of frame switches off noFrame mode.

Example

texture.on('update', () => {});

orig

orig: Rectangle

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

textureCacheIds

textureCacheIds: string[]

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.

trim

trim: Rectangle

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

uvMatrix

uvMatrix: TextureMatrix

Default TextureMatrix instance for this texture. By default, that object is not created because its heavy.

valid

valid: boolean

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

`Static`prefixed

prefixed: string | boolean

Accessors

frame

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

Returns Rectangle
Inherited from Texture.frame
set frame(frame: Rectangle): void
Parameters
- frame: Rectangle
Returns void
Inherited from Texture.frame

framebuffer

get framebuffer(): Framebuffer
Shortcut to this.baseTexture.framebuffer, saves baseTexture cast.

Returns Framebuffer

height

get height(): number
The height of the Texture in pixels.

Returns number
Inherited from Texture.height

multisample

get multisample(): MSAA_QUALITY
Shortcut to this.framebuffer.multisample.

Returns MSAA_QUALITY
Default
```
PIXI.MSAA_QUALITY.NONE
```
set multisample(value: MSAA_QUALITY): void
Parameters
- value: MSAA_QUALITY
Returns void

resolution

get resolution(): number
Returns resolution of baseTexture

Returns number
Inherited from Texture.resolution

rotate

get rotate(): number
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

Returns number
Inherited from Texture.rotate
set rotate(rotate: number): void
Parameters
- rotate: number
Returns void
Inherited from Texture.rotate

width

get width(): number
The width of the Texture in pixels.

Returns number
Inherited from Texture.width

`Static`EMPTY

get EMPTY(): Texture<Resource>
An empty texture, used often to not have to create multiple empty textures. Can not be destroyed.

Returns Texture<Resource>
Inherited from Texture.EMPTY

`Static`WHITE

get WHITE(): Texture<CanvasResource>
A white texture of 16x16 size, used for graphics and other things Can not be destroyed.

Returns Texture<CanvasResource>
Inherited from Texture.WHITE

Methods

addListener

addListener<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from Texture.addListener

castToBaseTexture

castToBaseTexture(): BaseTexture
Utility function for BaseTexture|Texture cast.

Returns BaseTexture
Inherited from Texture.castToBaseTexture

clone

clone(): Texture
Creates a new texture object that acts the same as this one.

Returns Texture
- The new texture
Inherited from Texture.clone

destroy

destroy(destroyBase?: boolean): void
Destroys this texture
Parameters
- OptionaldestroyBase: boolean
  Whether to destroy the base texture as well
Returns void
Fires
PIXI.Texture#destroyed

Inherited from Texture.destroy

emit

emit<T extends string | symbol>(event: T, ...args: any[]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- ...args: any[]
Returns boolean
Inherited from Texture.emit

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from Texture.eventNames

listenerCount

listenerCount(event: string | symbol): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from Texture.listenerCount

listeners

listeners<T extends string | symbol>(event: T): ((...args: any[]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args: any[]) => void)[]
Inherited from Texture.listeners

off

off<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from Texture.off

on

on<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from Texture.on

once

once<T extends string | symbol>(
    event: T,
    fn: (...args: any[]) => void,
    context?: any,
): this
Add a one-time listener for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: (...args: any[]) => void
- Optionalcontext: any
Returns this
Inherited from Texture.once

removeAllListeners

removeAllListeners(event?: string | symbol): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: string | symbol
Returns this
Inherited from Texture.removeAllListeners

removeListener

removeListener<T extends string | symbol>(
    event: T,
    fn?: (...args: any[]) => void,
    context?: any,
    once?: boolean,
): this
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optionalfn: (...args: any[]) => void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from Texture.removeListener

resize

resize(
    desiredWidth: number,
    desiredHeight: number,
    resizeBaseTexture?: boolean,
): void
Resizes the RenderTexture.
Parameters
- desiredWidth: number
  The desired width to resize to.
- desiredHeight: number
  The desired height to resize to.
- OptionalresizeBaseTexture: boolean
  Should the baseTexture.width and height values be resized as well?
Returns void

setResolution

setResolution(resolution: number): void
Changes the resolution of baseTexture, but does not change framebuffer size.
Parameters
- resolution: number
  The new resolution to apply to RenderTexture
Returns void

update

update(): void
Updates this texture on the gpu.

Calls the TextureResource update.

If you adjusted frame manually, please call updateUvs() instead.

Returns void
Inherited from Texture.update

updateUvs

updateUvs(): void
Updates the internal WebGL UV cache. Use it after you change frame or trim of the texture. Call it after changing the frame

Returns void
Inherited from Texture.updateUvs

`Static`addToCache

addToCache(texture: Texture, id: string): void
Adds a Texture to the global TextureCache. This cache is shared across the whole PIXI object.
Parameters
- texture: Texture
  The Texture to add to the cache.
- id: string
  The id that the Texture will be stored against.
Returns void
Inherited from Texture.addToCache

`Static`create

create(options?: IBaseTextureOptions<any>): RenderTexture
A short hand way of creating a render texture.
Parameters
- Optionaloptions: IBaseTextureOptions<any>
  Options
  - OptionalalphaMode?: ALPHA_MODES
  - OptionalanisotropicLevel?: number
  - Optionalformat?: FORMATS
  - Optionalheight?: number
  - Optionalmipmap?: MIPMAP_MODES
  - Optionalmultisample?: MSAA_QUALITY
  - OptionalpixiIdPrefix?: string
  - Optionalresolution?: number
  - OptionalresourceOptions?: RO
  - OptionalscaleMode?: SCALE_MODES
  - Optionaltarget?: TARGETS
  - Optionaltype?: TYPES
  - Optionalwidth?: number
  - OptionalwrapMode?: WRAP_MODES
Returns RenderTexture
The new render texture

`Static`from

from<R extends Resource = Resource, RO = any>(
    source: TextureSource | TextureSource[],
    options?: IBaseTextureOptions<RO>,
    strict?: boolean,
): Texture<R>
Helper function that creates a new Texture based on the source you provide. The source can be - frame id, image url, video url, canvas element, video element, base texture
Type Parameters
- R extends Resource = Resource
- RO = any
Parameters
- source: TextureSource | TextureSource[]
  Source or array of sources to create texture from
- Optionaloptions: IBaseTextureOptions<RO>
  See PIXI.BaseTexture's constructor for options.
  - OptionalalphaMode?: ALPHA_MODES
  - OptionalanisotropicLevel?: number
  - Optionalformat?: FORMATS
  - Optionalheight?: number
  - Optionalmipmap?: MIPMAP_MODES
  - Optionalmultisample?: MSAA_QUALITY
  - OptionalpixiIdPrefix?: string
  - Optionalresolution?: number
  - OptionalresourceOptions?: RO
  - OptionalscaleMode?: SCALE_MODES
  - Optionaltarget?: TARGETS
  - Optionaltype?: TYPES
  - Optionalwidth?: number
  - OptionalwrapMode?: WRAP_MODES
- Optionalstrict: boolean
  Enforce strict-mode, see PIXI.settings.STRICT_TEXTURE_CACHE.
Returns Texture<R>
The newly created texture

Inherited from Texture.from

`Static`fromBuffer

fromBuffer(
    buffer: BufferType,
    width: number,
    height: number,
    options?: IBaseTextureOptions<IBufferResourceOptions>,
): Texture<BufferResource>
Create a new Texture with a BufferResource from a typed array.
Parameters
- buffer: BufferType
  The optional array to use. If no data is provided, a new Float32Array is created.
- width: number
  Width of the resource
- height: number
  Height of the resource
- Optionaloptions: IBaseTextureOptions<IBufferResourceOptions>
  See PIXI.BaseTexture's constructor for options. Default properties are different from the constructor's defaults.
  - OptionalalphaMode?: ALPHA_MODES
  - OptionalanisotropicLevel?: number
  - Optionalformat?: FORMATS
  - Optionalheight?: number
  - Optionalmipmap?: MIPMAP_MODES
  - Optionalmultisample?: MSAA_QUALITY
  - OptionalpixiIdPrefix?: string
  - Optionalresolution?: number
  - OptionalresourceOptions?: RO
  - OptionalscaleMode?: SCALE_MODES
  - Optionaltarget?: TARGETS
  - Optionaltype?: TYPES
  - Optionalwidth?: number
  - OptionalwrapMode?: WRAP_MODES
Returns Texture<BufferResource>
- The resulting new BaseTexture
Inherited from Texture.fromBuffer

`Static`fromLoader

fromLoader<R extends Resource = Resource>(
    source: string | ImageSource,
    imageUrl: string,
    name?: string,
    options?: IBaseTextureOptions<any>,
): Promise<Texture<R>>
Create a texture from a source and add to the cache.
Type Parameters
- R extends Resource = Resource
Parameters
- source: string | ImageSource
  The input source.
- imageUrl: string
  File name of texture, for cache and resolving resolution.
- Optionalname: string
  Human readable name for the texture cache. If no name is specified, only imageUrl will be used as the cache ID.
- Optionaloptions: IBaseTextureOptions<any>
Returns Promise<Texture<R>>
- Output texture
Inherited from Texture.fromLoader

`Static`fromURL

fromURL<R extends Resource = Resource, RO = any>(
url: string | string[],
options?: IBaseTextureOptions<RO>,
): Promise<Texture<R>>
Useful for loading textures via URLs. Use instead of Texture.from because it does a better job of handling failed URLs more effectively. This also ignores PIXI.settings.STRICT_TEXTURE_CACHE. Works for Videos, SVGs, Images.
Type Parameters
- R extends Resource = Resource
- RO = any
Parameters
- url: string | string[]
  The remote URL or array of URLs to load.
- Optionaloptions: IBaseTextureOptions<RO>
  Optional options to include
Returns Promise<Texture<R>>
- A Promise that resolves to a Texture.
Inherited from Texture.fromURL

`Static`removeFromCache

removeFromCache(texture: string | Texture<Resource>): null | Texture<Resource>
Remove a Texture from the global TextureCache.
Parameters
- texture: string | Texture<Resource>
  id of a Texture to be removed, or a Texture instance itself
Returns null | Texture<Resource>
- The Texture that was removed
Inherited from Texture.removeFromCache

Class RenderTexture

Example

Memberof

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RenderTexture

Properties

_frame

baseTexture

defaultAnchor

Default

OptionaldefaultBorders

Since

See

Readonlydestroyed

ReadonlyfilterFrame

filterPoolKey

See

noFrame

Example

orig

textureCacheIds

trim

uvMatrix

valid

Staticprefixed

Accessors

frame

Returns Rectangle

Parameters

Returns void

framebuffer

Returns Framebuffer

height

Returns number

multisample

Returns MSAA_QUALITY

Default

Parameters

Returns void

resolution

Returns number

rotate

Returns number

Parameters

Returns void

width

Returns number

StaticEMPTY

Returns Texture<Resource>

StaticWHITE

Returns Texture<CanvasResource>

Methods

addListener

Type Parameters

Parameters

Returns this

castToBaseTexture

Returns BaseTexture

clone

Returns Texture

destroy

Parameters

Returns void

Fires

emit

Type Parameters

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

listenerCount

Parameters

`Optional`defaultBorders

`Readonly`destroyed

`Readonly`filterFrame

`Static`prefixed

`Static`EMPTY

`Static`WHITE

`Static`addToCache

`Static`create

`Optional`alphaMode?: ALPHA_MODES

`Optional`anisotropicLevel?: number

`Optional`format?: FORMATS

`Optional`height?: number

`Optional`mipmap?: MIPMAP_MODES

`Optional`multisample?: MSAA_QUALITY

`Optional`pixiIdPrefix?: string

`Optional`resolution?: number

`Optional`resourceOptions?: RO

`Optional`scaleMode?: SCALE_MODES

`Optional`target?: TARGETS

`Optional`type?: TYPES

`Optional`width?: number

`Optional`wrapMode?: WRAP_MODES

`Static`from

`Optional`alphaMode?: ALPHA_MODES

`Optional`anisotropicLevel?: number

`Optional`format?: FORMATS

`Optional`height?: number

`Optional`mipmap?: MIPMAP_MODES

`Optional`multisample?: MSAA_QUALITY

`Optional`pixiIdPrefix?: string

`Optional`resolution?: number

`Optional`resourceOptions?: RO

`Optional`scaleMode?: SCALE_MODES

`Optional`target?: TARGETS

`Optional`type?: TYPES

`Optional`width?: number