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

Example

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

const renderer = autoDetectRenderer();
const baseRenderTexture = new BaseRenderTexture({ width: 800, height: 600 });
const renderTexture = new RenderTexture(baseRenderTexture);
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 });

// 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 baseRenderTexture = new BaseRenderTexture({ width: 100, height: 100 });
const renderTexture = new RenderTexture(baseRenderTexture);

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

Memberof

PIXI

Hierarchy (View Summary)

Constructors

constructor

Properties

_batchEnabled _batchLocation _clear alphaMode anisotropicLevel cacheId destroyed dirtyId filterStack format framebuffer height isPowerOfTwo ktxKeyValueData maskStack parentTextureArray resolution resource target textureCacheIds type valid width _globalBatch defaultOptions prefixed

Accessors

clear clearColor mipmap multisample realHeight realWidth scaleMode wrapMode

Methods

addListener castToBaseTexture destroy dispose emit eventNames listenerCount listeners off on once removeAllListeners removeListener resize setRealSize setResolution setResource setSize setStyle update addToCache from fromBuffer removeFromCache

Constructors

constructor

Properties

_batchEnabled

_batchEnabled: number

Number of the texture batch, used by multi-texture renderers

Member

_batchLocation

_batchLocation: number

Location inside texture batch, used by multi-texture renderers

Member

_clear

_clear: Color

alphaMode

alphaMode: ALPHA_MODES

How to treat premultiplied alpha, see PIXI.ALPHA_MODES.

Member

Default

PIXI.ALPHA_MODES.UNPACK

anisotropicLevel

anisotropicLevel: number

Anisotropic filtering level of texture

Member

Default

0

cacheId

cacheId: string

Currently default cache ID.

Member

Readonlydestroyed

destroyed: boolean

Flag if BaseTexture has been destroyed.

Member

ReadonlydirtyId

dirtyId: number

Used by TextureSystem to only update texture to the GPU when needed. Please call update() to increment it.

filterStack

filterStack: any[]

The data structure for the filters.

format

format: FORMATS

The pixel format of the texture

Default

PIXI.FORMATS.RGBA

Readonlyframebuffer

framebuffer: Framebuffer

The framebuffer of this base texture.

Readonlyheight

height: number

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

ReadonlyisPowerOfTwo

isPowerOfTwo: boolean

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

Default

false

ktxKeyValueData

ktxKeyValueData: Map<string, DataView>

maskStack

maskStack: MaskData[]

The data structure for the stencil masks.

parentTextureArray

parentTextureArray: BaseTexture<Resource, IAutoDetectOptions>

Whether its a part of another texture, handled by ArrayResource or CubeResource

Member

Readonlyresolution

resolution: number

The resolution / device pixel ratio of the texture

Default

PIXI.settings.RESOLUTION

Readonlyresource

resource: Resource

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

Member

target

target: TARGETS

The target type

Default

PIXI.TARGETS.TEXTURE_2D

ReadonlytextureCacheIds

textureCacheIds: string[]

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

Member

type

type: TYPES

The type of resource data

Default

PIXI.TYPES.UNSIGNED_BYTE

Readonlyvalid

valid: boolean

Generally speaking means when resource is loaded.

Member

Readonlywidth

width: number

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

Static_globalBatch

_globalBatch: number

Global number of the texture batch, used by multi-texture renderers.

StaticdefaultOptions

defaultOptions: IBaseTextureOptions<any>

Default options used when creating BaseTexture objects.

Static

Memberof

PIXI.BaseTexture

Staticprefixed

prefixed: string | boolean

Accessors

clear

  • get clear(): Color

  • Color object when clearning the texture.

    Returns Color

    Since

    7.2.0

clearColor

  • get clearColor(): ColorSource

  • Returns ColorSource

  • set clearColor(value: ColorSource): void

  • Color when clearning the texture.

    Parameters

    Returns void

mipmap

  • get mipmap(): MIPMAP_MODES

  • Mipmap mode of the texture, affects downscaled images

    Returns MIPMAP_MODES

    Default

    PIXI.MIPMAP_MODES.POW2
  • set mipmap(value: MIPMAP_MODES): void

  • Parameters

    Returns void

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

    Returns void

realHeight

  • get realHeight(): number

  • Pixel height of the source of this texture

    Returns number

realWidth

  • get realWidth(): number

  • Pixel width of the source of this texture

    Returns number

scaleMode

  • get scaleMode(): SCALE_MODES

  • The scale mode to apply when scaling this texture

    Returns SCALE_MODES

    Default

    PIXI.SCALE_MODES.LINEAR
  • set scaleMode(value: SCALE_MODES): void

  • Parameters

    Returns void

wrapMode

  • get wrapMode(): WRAP_MODES

  • How the texture wraps

    Returns WRAP_MODES

    Default

    PIXI.WRAP_MODES.CLAMP
  • set wrapMode(value: WRAP_MODES): void

  • Parameters

    Returns void

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

castToBaseTexture

destroy

  • destroy(): void

  • Destroys this texture.

    Returns void

dispose

  • dispose(): void

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

    Returns void

    Fires

    PIXI.BaseTexture#dispose

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

eventNames

  • eventNames(): (string | symbol)[]

  • Return an array listing the events for which the emitter has registered listeners.

    Returns (string | symbol)[]

listenerCount

  • listenerCount(event: string | symbol): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

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[]

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

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

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

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optionalevent: string | symbol

    Returns this

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

resize

  • resize(desiredWidth: number, desiredHeight: number): void

  • Resizes the BaseRenderTexture.

    Parameters

    • desiredWidth: number

      The desired width to resize to.

    • desiredHeight: number

      The desired height to resize to.

    Returns void

setRealSize

  • setRealSize(realWidth: number, realHeight: number, resolution?: number): this

  • Sets real size of baseTexture, preserves current resolution.

    Parameters

    • realWidth: number

      Full rendered width

    • realHeight: number

      Full rendered height

    • Optionalresolution: number

      Optionally set resolution

    Returns this

    • this

setResolution

  • setResolution(resolution: number): this

  • Changes resolution

    Parameters

    • resolution: number

      res

    Returns this

    • this

setResource

  • setResource(resource: Resource): this

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

    Parameters

    • resource: Resource

      that is managing this BaseTexture

    Returns this

    • this

setSize

  • setSize(desiredWidth: number, desiredHeight: number, resolution?: number): this

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

    Parameters

    • desiredWidth: number

      Desired visual width

    • desiredHeight: number

      Desired visual height

    • Optionalresolution: number

      Optionally set resolution

    Returns this

    • this

setStyle

update

  • update(): void

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

    Returns void

StaticaddToCache

  • addToCache(
        baseTexture: BaseTexture<Resource, IAutoDetectOptions>,
        id: string,
    ): void

  • Adds a BaseTexture to the global BaseTextureCache. This cache is shared across the whole PIXI object.

    Parameters

    Returns void

Staticfrom

StaticfromBuffer

StaticremoveFromCache

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods