pixi.js/lib/scene/container/container-mixins/cacheAsTextureMixin.d.ts

<p align="center"> <a href="https://pixijs.com" target="_blank" rel="noopener noreferrer"> <img height="150" src="https://files.pixijs.download/branding/pixijs-logo-transparent-dark.svg?v=1" alt="PixiJS logo"> </a> </p> <br/> <p align="center">

import type { Container } from '../Container';
import type { CacheAsTextureOptions } from '../RenderGroup';
/** @ignore */
export interface CacheAsTextureMixinConstructor {
    cacheAsTexture?: (val: boolean | CacheAsTextureOptions) => void;
}
/**
 * The CacheAsTextureMixin interface provides methods and properties for caching a container as a texture.
 * This can improve rendering performance for complex static containers by allowing them to be rendered as a single texture.
 * It includes methods to enable or disable caching, update the cached texture, and check
 * 1if the container is currently cached.
 * @category scene
 * @advanced
 */
export interface CacheAsTextureMixin extends Required<CacheAsTextureMixinConstructor> {
    /**
     * Caches this container as a texture. This allows the container to be rendered as a single texture,
     * which can improve performance for complex static containers.
     * @example
     * ```ts
     * // Basic caching
     * container.cacheAsTexture(true);
     *
     * // With custom options
     * container.cacheAsTexture({
     *     resolution: 2,
     *     antialias: true,
     * });
     *
     * // Disable caching
     * container.cacheAsTexture(false);
     *
     * // Cache a complex UI
     * const ui = new Container();
     * // Add multiple children...
     * ui.cacheAsTexture(true);
     * ui.updateCacheTexture(); // Update if contents change
     * ```
     * @param val - If true, enables caching with default options.
     *             If false, disables caching.
     *             Can also pass options object to configure caching behavior.
     * @see {@link Container#updateCacheTexture} For updating cached content
     * @see {@link Container#isCachedAsTexture} For checking cache state
     */
    cacheAsTexture: (val: boolean | CacheAsTextureOptions) => void;
    /**
     * Updates the cached texture of this container. This will flag the container's cached texture
     * to be redrawn on the next render.
     * @example
     * ```ts
     * // Basic update after changes
     * container.updateCacheTexture();
     * ```
     */
    updateCacheTexture: () => void;
    /**
     * Legacy property for backwards compatibility with PixiJS v7 and below.
     * Use `cacheAsTexture` instead.
     * @deprecated since 8.0.0
     */
    cacheAsBitmap: boolean;
    /**
     * Whether this container is currently cached as a texture.
     * @example
     * ```ts
     * // Check cache state
     * if (container.isCachedAsTexture) {
     *     console.log('Container is cached');
     * }
     * ```
     * @readonly
     * @see {@link Container#cacheAsTexture} For enabling caching
     * @see {@link Container#updateCacheTexture} For updating cache
     */
    readonly isCachedAsTexture: boolean;
}
/** @internal */
export declare const cacheAsTextureMixin: Partial<Container>;