PIXI

Class: CanvasExtract

PIXI. CanvasExtract

The extract manager provides functionality to export content from the renderers.

new PIXI.CanvasExtract(renderer)

extract/canvas/CanvasExtract.js, line 13
Name Type Description
renderer PIXI.CanvasRenderer

A reference to the current renderer

Methods

base64(target){string}

extract/canvas/CanvasExtract.js, line 48

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

Name Type Description
target PIXI.DisplayObject | PIXI.RenderTexture

A displayObject or renderTexture
to convert. If left empty will use use the main renderer
Returns:
Type Description
string A base64 encoded string of the texture.

canvas(target){HTMLCanvasElement}

extract/canvas/CanvasExtract.js, line 60

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

Name Type Description
target PIXI.DisplayObject | PIXI.RenderTexture

A displayObject or renderTexture
to convert. If left empty will use use the main renderer
Returns:
Type Description
HTMLCanvasElement A Canvas element with the texture rendered on.

destroy()

extract/canvas/CanvasExtract.js, line 157

Destroys the extract

image(target){HTMLImageElement}

extract/canvas/CanvasExtract.js, line 31

Will return a HTML Image of the target

Name Type Description
target PIXI.DisplayObject | PIXI.RenderTexture

A displayObject or renderTexture
to convert. If left empty will use use the main renderer
Returns:
Type Description
HTMLImageElement HTML Image of the target

pixels(target){Uint8ClampedArray}

extract/canvas/CanvasExtract.js, line 115

Will return a one-dimensional array containing the pixel data of the entire texture in RGBA
order, with integer values between 0 and 255 (included).

Name Type Description
target PIXI.DisplayObject | PIXI.RenderTexture

A displayObject or renderTexture
to convert. If left empty will use use the main renderer
Returns:
Type Description
Uint8ClampedArray One-dimensional array containing the pixel data of the entire texture