pixi.js
    Preparing search index...

    Interface ImageOptionsAdvanced

    Options for creating an image from a renderer. Controls the output format and quality of extracted images.

    // Extract as PNG (default)
    const pngImage = await renderer.extract.image({
    target: sprite,
    format: 'png'
    });

    // Extract as JPEG with quality setting
    const jpgImage = await renderer.extract.image({
    target: sprite,
    format: 'jpg',
    quality: 0.8
    });

    // Extract as WebP for better compression
    const webpImage = await renderer.extract.image({
    target: sprite,
    format: 'webp',
    quality: 0.9
    });
    interface ImageOptions {
        format?: "png" | "jpg" | "webp";
        quality?: number;
    }
    Index

    Properties

    Properties

    format?: "png" | "jpg" | "webp"

    The format of the extracted image.

    • 'png': Lossless format, best for images with text or sharp edges
    • 'jpg': Lossy format, smaller file size, good for photos
    • 'webp': Modern format with better compression
    // Extract as PNG
    const pngImage = await renderer.extract.image({
    target: sprite,
    format: 'png'
    });
    // Extract as JPEG
    const jpgImage = await renderer.extract.image({
    target: sprite,
    format: 'jpg',
    });
    'png'
    
    quality?: number

    The quality of the extracted image, between 0 and 1. Only applies to lossy formats (jpg, webp).

    • 1: Maximum quality
    • 0: Maximum compression
    // Extract as JPEG with 80% quality
    const jpgImage = await renderer.extract.image({
    target: sprite,
    format: 'jpg',
    quality: 0.8
    });
    // Extract as WebP with 90% quality
    const webpImage = await renderer.extract.image({
    target: sprite,
    format: 'webp',
    quality: 0.9
    });
    1