PixiJS

Class: CanvasExtract

PIXI.CanvasExtract

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

An instance of this class is automatically created by default, and can be found at renderer.plugins.extract

new PIXI.CanvasExtract (renderer)

CanvasExtract.ts:23
Name Type Description
renderer PIXI.CanvasRenderer

A reference to the current renderer

Members

renderer CanvasRenderer

A reference to the current renderer

Methods

base64 (target, format, quality) string

CanvasExtract.ts:49

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

Name Type Attributes Description
target PIXI.DisplayObject | PIXI.RenderTexture <optional>

A displayObject or renderTexture to convert. If left empty will use the main renderer
format string <optional>

Image format, e.g. "image/jpeg" or "image/webp".
quality number <optional>

JPEG or Webp compression from 0 to 1. Default is 0.92.
Returns:
Type Description
string A base64 encoded string of the texture.

canvas (target) HTMLCanvasElement

CanvasExtract.ts:64

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

Name Type Attributes Description
target PIXI.DisplayObject | PIXI.RenderTexture <optional>

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

destroy () void

CanvasExtract.ts:169

Destroys the extract

image (target, format, quality) HTMLImageElement

CanvasExtract.ts:31

Will return a HTML Image of the target

Name Type Attributes Description
target PIXI.DisplayObject | PIXI.RenderTexture <optional>

A displayObject or renderTexture to convert. If left empty will use the main renderer
format string <optional>

Image format, e.g. "image/jpeg" or "image/webp".
quality number <optional>

JPEG or Webp compression from 0 to 1. Default is 0.92.
Returns:
Type Description
HTMLImageElement HTML Image of the target

pixels (target) Uint8ClampedArray

CanvasExtract.ts:118

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 Attributes Description
target PIXI.DisplayObject | PIXI.RenderTexture <optional>

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