pixi.js
    Preparing search index...

    Type Alias GenerateTextureOptionsAdvanced

    Options for generating a texture from a container. Used to create reusable textures from display objects, which can improve performance when the same content needs to be rendered multiple times.

    // Basic texture generation
    const sprite = new Sprite(texture);
    const generatedTexture = renderer.generateTexture({
        target: sprite
    });

    // Generate with custom region and resolution
    const texture = renderer.generateTexture({
        target: container,
        frame: new Rectangle(0, 0, 100, 100),
        resolution: 2
    });

    // Generate with background color and anti-aliasing
    const highQualityTexture = renderer.generateTexture({
        target: graphics,
        clearColor: '#ff0000',
        antialias: true,
        textureSourceOptions: {
            scaleMode: 'linear'
        }
    });
    type GenerateTextureOptions = {
        antialias?: boolean;
        clearColor?: ColorSource;
        frame?: Rectangle;
        resolution?: number;
        target: Container;
        textureSourceOptions?: GenerateTextureSourceOptions;
    }
    Index

    Properties

    antialias? clearColor? frame? resolution? target textureSourceOptions?

    Properties

    antialias?: boolean

    Whether to enable anti-aliasing. This may affect performance.

    false

    // Generate a smooth texture
    const texture = renderer.generateTexture({
        target: graphics,
        antialias: true
    });
    clearColor?: ColorSource

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

    // Clear with red background
    const texture = renderer.generateTexture({
        target: sprite,
        clearColor: '#ff0000'
    });

    // Clear with semi-transparent black
    const texture = renderer.generateTexture({
        target: sprite,
        clearColor: [0, 0, 0, 0.5]
    });
    frame?: Rectangle

    The region of the container that should be rendered. If not specified, defaults to the local bounds of the container.

    // Extract only a portion of the container
    const texture = renderer.generateTexture({
        target: container,
        frame: new Rectangle(10, 10, 100, 100)
    });
    resolution?: number

    The resolution of the texture being generated. Higher values create sharper textures at the cost of memory.

    renderer.resolution

    // Generate a high-resolution texture
    const hiResTexture = renderer.generateTexture({
        target: sprite,
        resolution: 2 // 2x resolution
    });
    target: Container

    The container to generate the texture from. This can be any display object like Sprite, Container, or Graphics.

    const graphics = new Graphics()
        .circle(0, 0, 50)
        .fill('red');

    const texture = renderer.generateTexture({
        target: graphics
    });
    textureSourceOptions?: GenerateTextureSourceOptions

    Advanced options for configuring the texture source. Controls texture properties like scale mode and filtering.

    const texture = renderer.generateTexture({
        target: sprite,
        textureSourceOptions: {
            scaleMode: 'linear',
            multisample: 4
        }
    });

    Settings

    Member Visibility

    On This Page

    Properties