pixi.js
Version:
<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">
45 lines (44 loc) • 1.52 kB
TypeScript
import { ExtensionType } from '../extensions/Extensions';
import { PrepareUpload } from './PrepareUpload';
import type { System } from '../rendering/renderers/shared/system/System';
/**
* The prepare system provides renderer-specific plugins for pre-rendering DisplayObjects. This is useful for
* asynchronously preparing and uploading to the GPU assets, textures, graphics waiting to be displayed.
*
* Do not instantiate this plugin directly. It is available from the `renderer.prepare` property.
* @example
* import 'pixi.js/prepare';
* import { Application, Graphics } from 'pixi.js';
*
* // Create a new application (prepare will be auto-added to renderer)
* const app = new Application();
* await app.init();
* document.body.appendChild(app.view);
*
* // Don't start rendering right away
* app.stop();
*
* // Create a display object
* const rect = new Graphics()
* .beginFill(0x00ff00)
* .drawRect(40, 40, 200, 200);
*
* // Add to the stage
* app.stage.addChild(rect);
*
* // Don't start rendering until the graphic is uploaded to the GPU
* app.renderer.prepare.upload(app.stage, () => {
* app.start();
* });
* @category rendering
* @advanced
*/
export declare class PrepareSystem extends PrepareUpload implements System {
/** @ignore */
static extension: {
readonly type: readonly [ExtensionType.WebGLSystem, ExtensionType.WebGPUSystem];
readonly name: "prepare";
};
/** Destroys the plugin, don't use after this. */
destroy(): void;
}