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

new PIXI.CanvasExtract (renderer)

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

A reference to the current renderer

Implements

Members

renderer PIXI.CanvasRenderer | null

A reference to the current renderer

Methods

base64 (target, format, quality) Promise<string>

CanvasExtract.ts:53

Will return 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
Promise<string> A base64 encoded string of the texture.

canvas (target, frame) PIXI.ICanvas

CanvasExtract.ts:86

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
frame PIXI.Rectangle <optional>

The frame the extraction is restricted to.
Returns:
Type Description
PIXI.ICanvas A Canvas element with the texture rendered on.

destroy () void

CanvasExtract.ts:211

Destroys the extract

image (target, format, quality) Promise<HTMLImageElement>

CanvasExtract.ts:36

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
Promise<HTMLImageElement> HTML Image of the target

pixels (target, frame) Uint8ClampedArray

CanvasExtract.ts:151

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
frame PIXI.Rectangle <optional>

The frame the extraction is restricted to.
Returns:
Type Description
Uint8ClampedArray One-dimensional array containing the pixel data of the entire texture