src/rendering/renderers/shared/texture/RenderTexture.ts - dev - githubmirror/pixijs

src/rendering/renderers/shared/texture/RenderTexture.ts

59 строк2 KB

ksv

feat: adding a default anchor to texture generation (#12011)

13 апр 2026, 15:08

13 апр 2026, 15:08dc7ecd8

import { TextureSource } from './sources/TextureSource';
import { Texture, type TextureOptions } from './Texture';

import type { TextureSourceOptions } from './sources/TextureSource';

/**
 * The options that can be passed to a new RenderTexture
 * @category rendering
 * @advanced
 */
export interface RenderTextureOptions extends TextureSourceOptions
{
    /** texture options {@link TextureOptions} */
    textureOptions?: Omit<TextureOptions, 'source' | 'dynamic'>
}

/**
 * A render texture, extends `Texture`.
 * @see {@link Texture}
 * @category rendering
 * @advanced
 */
export class RenderTexture extends Texture
{
    /**
     * Creates a RenderTexture. Pass `dynamic: true` in options to allow resizing after creation.
     * @param options - Options for the RenderTexture, including width, height, textureOptions, and dynamic.
     * @returns A new RenderTexture instance.
     * @example
     * const textureOptions = { defaultAnchor: { x: 0.5, y: 0.5 } };
     * const rt = RenderTexture.create({ width: 100, height: 100, dynamic: true, textureOptions });
     * rt.resize(500, 500);
     */
    public static create(options: RenderTextureOptions): RenderTexture
    {
        // Pass dynamic to the RenderTexture constructor if present in options
        const { dynamic, textureOptions, ...rest } = options;

        return new RenderTexture({
            ...textureOptions,
            source: new TextureSource(rest),
            dynamic: dynamic ?? false,
        });
    }

    /**
     * Resizes the render texture.
     * @param width - The new width of the render texture.
     * @param height - The new height of the render texture.
     * @param resolution - The new resolution of the render texture.
     * @returns This texture.
     */
    public resize(width: number, height: number, resolution?: number): this
    {
        this.source.resize(width, height, resolution);

        return this;
    }
}