pixi.js
    Preparing search index...

    Interface ExtractDownloadOptionsAdvanced

    Options for extracting and downloading content from a renderer. Combines base extraction options with download-specific settings.

    // Basic download with default filename
    renderer.extract.download({
        target: sprite
    });

    // Download with custom filename and region
    renderer.extract.download({
        target: container,
        filename: 'screenshot.png',
        frame: new Rectangle(0, 0, 100, 100)
    });

    // Download with high resolution and background
    renderer.extract.download({
        target: stage,
        filename: 'hd-capture.png',
        resolution: 2,
        clearColor: '#ff0000'
    });

    // Download with anti-aliasing
    renderer.extract.download({
        target: graphics,
        filename: 'smooth.png',
        antialias: true
    });

    Combines all options from:

    Common use cases:

    • Saving game screenshots
    • Exporting rendered content
    • Creating downloadable assets
    • Saving canvas state
    interface ExtractDownloadOptions {
        antialias?: boolean;
        clearColor?: ColorSource;
        filename: string;
        frame?: Rectangle;
        resolution?: number;
        target: Texture<TextureSource<any>> | Container<ContainerChild>;
    }
    Index

    Properties

    antialias? clearColor? filename frame? resolution? target

    Properties

    antialias?: boolean

    Whether to enable anti-aliasing during extraction. Improves quality but may affect performance.

    false

    // Enable anti-aliasing for smoother edges
    renderer.extract.image({
        target: graphics,
        antialias: true
    });
    clearColor?: ColorSource

    The color used to clear the extracted content before rendering. Can be a hex number, string, or array of numbers.

    // Clear with red background
    renderer.extract.canvas({
        target: sprite,
        clearColor: '#ff0000'
    });

    // Clear with semi-transparent black
    renderer.extract.canvas({
        target: sprite,
        clearColor: [0, 0, 0, 0.5]
    });
    filename: string

    The filename to use when downloading the content. Should include the desired file extension (e.g., .png).

    'image.png'

    renderer.extract.download({
        target: sprite,
        filename: 'my-screenshot.png'
    });
    frame?: Rectangle

    The region of the target to extract. If not specified, extracts the entire target.

    // Extract a specific region
    renderer.extract.canvas({
        target: sprite,
        frame: new Rectangle(10, 10, 100, 100)
    });
    resolution?: number

    The resolution of the extracted content. Higher values create sharper images.

    1

    // Extract at 2x resolution for retina displays
    renderer.extract.image({
        target: sprite,
        resolution: 2
    });
    target: Texture<TextureSource<any>> | Container<ContainerChild>

    The target to extract. Can be a Container or Texture.

    // Extract from a sprite
    const sprite = new Sprite(texture);
    renderer.extract.pixels({ target: sprite });

    // Extract from a texture directly
    renderer.extract.pixels({ target: texture });

    Settings

    Member Visibility

    On This Page

    Properties