API Docs for: 2.2.1
Show:

RenderTexture Class

Extends Texture
Defined in: pixi/textures/RenderTexture.hx:12

A RenderTexture 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 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. The position and rotation of the given Display Objects is ignored. For example:

var renderTexture = new PIXI.RenderTexture(800, 600); var 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; renderTexture.render(sprite);

The Sprite in this case will be rendered to a position of 0,0. To render this sprite at its actual position a DisplayObjectContainer should be used:

var doc = new PIXI.DisplayObjectContainer(); doc.addChild(sprite); renderTexture.render(doc); // Renders to center of renderTexture

Constructor

RenderTexture

(
  • [width]
  • [height]
  • [renderer]
  • [scaleMode]
  • [resolution]
)

Defined in pixi/textures/RenderTexture.hx:12

Parameters:

  • [width] Float optional

    The width of the render texture

  • [height] Float optional

    The height of the render texture

  • [renderer] CanvasRenderer | WebGLRenderer optional

    The renderer used for this RenderTexture

  • [scaleMode] Int optional

    Should be one of the PIXI.scaleMode consts

  • [resolution] Float optional

    The resolution of the texture being generated

Methods

clear

()

Defined in pixi/textures/RenderTexture.hx:65

Clears the RenderTexture.

destroy

(
  • destroyBase
)

Inherited from Texture: pixi/textures/Texture.hx:69

Destroys this texture

Parameters:

  • destroyBase Bool

    Whether to destroy the base texture as well

emit

(
  • eventName
  • data
)
Bool

Inherited from EventTarget: pixi/utils/EventTarget.hx:29

Emit an event to all registered event listeners.

Parameters:

  • eventName String

    The name of the event.

  • data Dynamic

Returns:

Bool:

Indication if we've emitted an event.

getBase64

() String

Defined in pixi/textures/RenderTexture.hx:72

Will return a a base64 encoded string of this texture. It works by calling RenderTexture.getCanvas and then running toDataURL on that.

Returns:

String:

A base64 encoded string of the texture.

getCanvas

() CanvasElement

Defined in pixi/textures/RenderTexture.hx:80

Creates a Canvas element, renders this RenderTexture to it and then returns it.

Returns:

CanvasElement:

A Canvas element with the texture rendered on.

getImage

() HTMLImage

Defined in pixi/textures/RenderTexture.hx:88

Will return a HTML Image of the texture

Returns:

HTMLImage:

listeners

(
  • eventName
)
Array

Inherited from EventTarget: pixi/utils/EventTarget.hx:20

Return a list of assigned event listeners.

Parameters:

  • eventName String

    The events that should be listed.

Returns:

Array:

An array of listener functions

off

(
  • eventName
  • callback
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:61

Remove event listeners.

Parameters:

  • eventName String

    The event we want to remove.

  • callback Function

    The listener that we need to find.

on

(
  • eventName
  • callback
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:41

Register a new EventListener for the given event.

Parameters:

  • eventName String

    Name of the event.

  • callback Functon

    Callback function.

once

(
  • eventName
  • callback
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:52

Add an EventListener that's only called once.

Parameters:

  • eventName String

    Name of the event.

  • callback Function

    Callback function.

removeAllListeners

(
  • eventName
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:72

Remove all listeners or only the listeners for the specified event.

Parameters:

  • eventName String

    The event you want to remove all listeners for.

renderWebGL/renderCanvas

(
  • displayObject
  • [matrix]
  • [clear]
)

Defined in pixi/textures/RenderTexture.hx:45

This function will draw the display object to the texture.

Parameters:

  • displayObject DisplayObject

    The display object to render this texture on

  • [matrix] Matrix optional

    Optional matrix to apply to the display object before rendering.

  • [clear] Bool optional

    If true the texture will be cleared before the displayObject is drawn

resize

(
  • width
  • height
  • [updateBase]
)

Defined in pixi/textures/RenderTexture.hx:55

Resize the RenderTexture.

Parameters:

  • width Float

    The width to resize to.

  • height Float

    The height to resize to.

  • [updateBase] Bool optional

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

setFrame

(
  • frame
)

Inherited from Texture: pixi/textures/Texture.hx:77

Specifies the region of the baseTexture that this texture will use.

Parameters:

  • frame Rectangle

    The frame of the texture to set it to

Properties

renderer

CanvasRenderer | WebGLRenderer

Defined in pixi/textures/RenderTexture.hx:96

The renderer this RenderTexture uses. A RenderTexture can only belong to one renderer at the moment if its webGL.

resolution

Number

Defined in pixi/textures/RenderTexture.hx:104

The Resolution of the texture.