Class: Extract

PIXI.Extract

This class provides renderer-specific plugins for exporting content from a renderer. For instance, these plugins can be used for saving an Image, Canvas element or for exporting the raw image data (pixels).

Do not instantiate these plugins directly. It is available from the renderer.plugins property. See PIXI.Renderer#plugins.

new PIXI.Extract (renderer)

Name Type Description
renderer PIXI.Renderer

A reference to the current renderer

Example


 // Create a new app (will auto-add extract plugin to renderer)
 const app = new PIXI.Application();

 // Draw a red circle
 const graphics = new PIXI.Graphics()
     .beginFill(0xFF0000)
     .drawCircle(0, 0, 50);

 // Render the graphics as an HTMLImageElement
 const image = app.renderer.plugins.extract.image(graphics);
 document.body.appendChild(image);

Implements

  • IRendererPlugin

Methods

base64 (target, format, quality) string

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

Name Type Attributes Description
target PIXI.DisplayObject | PIXI.RenderTexture

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

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 the main renderer

Returns:
Type Description
HTMLCanvasElement A Canvas element with the texture rendered on.

destroy () void

Destroys the extract

image (target, format, quality) HTMLImageElement

Will return a HTML Image of the target

Name Type Attributes Description
target PIXI.DisplayObject | PIXI.RenderTexture

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) Uint8Array

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 the main renderer

Returns:
Type Description
Uint8Array One-dimensional array containing the pixel data of the entire texture