@rendley/sdk - v1.12.7
    Preparing search index...

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

    import { Application, Graphics } from 'pixi.js';

    // Create a new application (extract will be auto-added to renderer)
    const app = new Application();

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

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

    PIXI

    Implements

    Index

    Constructors

    constructor

    Methods

    base64 canvas destroy image pixels

    Constructors

    Methods

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

      Parameters

      • Optionaltarget: RenderTexture | DisplayObject

        A displayObject or renderTexture to convert. If left empty will use the main renderer

      • Optionalformat: string

        Image format, e.g. "image/jpeg" or "image/webp".

      • Optionalquality: number

        JPEG or Webp compression from 0 to 1. Default is 0.92.

      • Optionalframe: Rectangle

        The frame the extraction is restricted to.

      Returns Promise<string>

      • A base64 encoded string of the texture.

    • Destroys the extract.

      Returns void

    • Will return a HTML Image of the target

      Parameters

      • Optionaltarget: RenderTexture | DisplayObject

        A displayObject or renderTexture to convert. If left empty will use the main renderer

      • Optionalformat: string

        Image format, e.g. "image/jpeg" or "image/webp".

      • Optionalquality: number

        JPEG or Webp compression from 0 to 1. Default is 0.92.

      • Optionalframe: Rectangle

        The frame the extraction is restricted to.

      Returns Promise<HTMLImageElement>

      • HTML Image of the target

    • 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).

      Parameters

      • Optionaltarget: RenderTexture | DisplayObject

        A displayObject or renderTexture to convert. If left empty will use the main renderer

      • Optionalframe: Rectangle

        The frame the extraction is restricted to.

      Returns Uint8Array

      • One-dimensional array containing the pixel data of the entire texture

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods