@safe-engine/pixi 8.10.2 → 8.10.4

package/dist/packages/pixijs/src/rendering/renderers/shared/system/AbstractRenderer.d.ts

@@ -1,328 +0,0 @@
-import { Container } from '../../../../scene/container/Container';
-import { EventEmitter } from '../../../../utils/utils';
-import { SystemRunner } from './SystemRunner';
-import type { ColorSource } from '../../../../color/Color';
-import type { ICanvas } from '../../../../environment/canvas/ICanvas';
-import type { Matrix } from '../../../../maths/matrix/Matrix';
-import type { Rectangle } from '../../../../maths/shapes/Rectangle';
-import type { TypeOrBool } from '../../../../scene/container/destroyTypes';
-import type { CLEAR_OR_BOOL } from '../../gl/const';
-import type { BackgroundSystem } from '../background/BackgroundSystem';
-import type { GenerateTextureOptions, GenerateTextureSystem } from '../extract/GenerateTextureSystem';
-import type { PipeConstructor } from '../instructions/RenderPipe';
-import type { RenderSurface } from '../renderTarget/RenderTargetSystem';
-import type { Texture } from '../texture/Texture';
-import type { ViewSystem, ViewSystemDestroyOptions } from '../view/ViewSystem';
-import type { SharedRendererOptions } from './SharedSystems';
-import type { SystemConstructor } from './System';
-/**
- * The configuration for the renderer.
- * This is used to define the systems and render pipes that will be used by the renderer.
- * @category rendering
- * @advanced
- */
-export interface RendererConfig {
-    type: number;
-    name: string;
-    runners?: string[];
-    systems: {
-        name: string;
-        value: SystemConstructor;
-    }[];
-    renderPipes: {
-        name: string;
-        value: PipeConstructor;
-    }[];
-    renderPipeAdaptors: {
-        name: string;
-        value: any;
-    }[];
-}
-/**
- * The options for rendering a view.
- * @category rendering
- * @standard
- */
-export interface RenderOptions extends ClearOptions {
-    /** The container to render. */
-    container: Container;
-    /** the transform to apply to the container. */
-    transform?: Matrix;
-}
-/**
- * The options for clearing the render target.
- * @category rendering
- * @advanced
- */
-export interface ClearOptions {
-    /**
-     * The render target to render. if this target is a canvas and  you are using the WebGL renderer,
-     * please ensure you have set `multiView` to `true` on renderer.
-     */
-    target?: RenderSurface;
-    /** The color to clear with. */
-    clearColor?: ColorSource;
-    /** The clear mode to use. */
-    clear?: CLEAR_OR_BOOL;
-}
-/**
- * Options for destroying the renderer.
- * This can be a boolean or an object.
- * @category rendering
- * @standard
- */
-export type RendererDestroyOptions = TypeOrBool<ViewSystemDestroyOptions & {
-    /** Whether to clean up global resource pools/caches */
-    releaseGlobalResources?: boolean;
-}>;
-declare const defaultRunners: readonly ["init", "destroy", "contextChange", "resolutionChange", "resetState", "renderEnd", "renderStart", "render", "update", "postrender", "prerender"];
-type DefaultRunners = typeof defaultRunners[number];
-type Runners = {
-    [key in DefaultRunners]: SystemRunner;
-} & {
-    [K: ({} & string) | ({} & symbol)]: SystemRunner;
-};
-/**
- * The base class for a PixiJS Renderer. It contains the shared logic for all renderers.
- *
- * You should not use this class directly, but instead use {@link WebGLRenderer}
- * or {@link WebGPURenderer}.
- * Alternatively, you can also use {@link autoDetectRenderer} if you want us to
- * determine the best renderer for you.
- *
- * The renderer is composed of systems that manage specific tasks. The following systems are added by default
- * whenever you create a renderer:
- *
- *
- * | Generic Systems                      | Systems that manage functionality that all renderer types share               |
- * | ------------------------------------ | ----------------------------------------------------------------------------- |
- * | {@link ViewSystem}              | This manages the main view of the renderer usually a Canvas              |
- * | {@link BackgroundSystem}        | This manages the main views background color and alpha                   |
- * | {@link EventSystem}           | This manages UI events.                                                       |
- * | {@link AccessibilitySystem} | This manages accessibility features. Requires `import 'pixi.js/accessibility'`|
- *
- * | Core Systems                   | Provide an optimised, easy to use API to work with WebGL/WebGPU               |
- * | ------------------------------------ | ----------------------------------------------------------------------------- |
- * | {@link GlobalUniformSystem} | This manages shaders, programs that run on the GPU to calculate 'em pixels.   |
- * | {@link TextureGCSystem}     | This will automatically remove textures from the GPU if they are not used.    |
- *
- * | PixiJS High-Level Systems            | Set of specific systems designed to work with PixiJS objects                  |
- * | ------------------------------------ | ----------------------------------------------------------------------------- |
- * | {@link HelloSystem}               | Says hello, buy printing out the pixi version into the console log (along with the renderer type)       |
- * | {@link GenerateTextureSystem} | This adds the ability to generate textures from any Container       |
- * | {@link FilterSystem}          | This manages the filtering pipeline for post-processing effects.             |
- * | {@link PrepareSystem}               | This manages uploading assets to the GPU. Requires `import 'pixi.js/prepare'`|
- * | {@link ExtractSystem}               | This extracts image data from display objects.                               |
- *
- * The breadth of the API surface provided by the renderer is contained within these systems.
- * @abstract
- * @category rendering
- * @advanced
- * @property {HelloSystem} hello - HelloSystem instance.
- * @property {TextureGCSystem} textureGC - TextureGCSystem instance.
- * @property {FilterSystem} filter - FilterSystem instance.
- * @property {GlobalUniformSystem} globalUniforms - GlobalUniformSystem instance.
- * @property {TextureSystem} texture - TextureSystem instance.
- * @property {EventSystem} events - EventSystem instance.
- * @property {ExtractSystem} extract - ExtractSystem instance. Requires `import 'pixi.js/extract'`.
- * @property {PrepareSystem} prepare - PrepareSystem instance. Requires `import 'pixi.js/prepare'`.
- * @property {AccessibilitySystem} accessibility - AccessibilitySystem instance. Requires `import 'pixi.js/accessibility'`.
- */
-export declare class AbstractRenderer<PIPES, OPTIONS extends SharedRendererOptions, CANVAS extends ICanvas = HTMLCanvasElement> extends EventEmitter<{
-    resize: [screenWidth: number, screenHeight: number, resolution: number];
-}> {
-    /** The default options for the renderer. */
-    static defaultOptions: {
-        /**
-         * Default resolution / device pixel ratio of the renderer.
-         * @default 1
-         */
-        resolution: number;
-        /**
-         * Should the `failIfMajorPerformanceCaveat` flag be enabled as a context option used in the `isWebGLSupported`
-         * function. If set to true, a WebGL renderer can fail to be created if the browser thinks there could be
-         * performance issues when using WebGL.
-         *
-         * In PixiJS v6 this has changed from true to false by default, to allow WebGL to work in as many
-         * scenarios as possible. However, some users may have a poor experience, for example, if a user has a gpu or
-         * driver version blacklisted by the
-         * browser.
-         *
-         * If your application requires high performance rendering, you may wish to set this to false.
-         * We recommend one of two options if you decide to set this flag to false:
-         *
-         * 1: Use the Canvas renderer as a fallback in case high performance WebGL is
-         *    not supported.
-         *
-         * 2: Call `isWebGLSupported` (which if found in the utils package) in your code before attempting to create a
-         *    PixiJS renderer, and show an error message to the user if the function returns false, explaining that their
-         *    device & browser combination does not support high performance WebGL.
-         *    This is a much better strategy than trying to create a PixiJS renderer and finding it then fails.
-         * @default false
-         */
-        failIfMajorPerformanceCaveat: boolean;
-        /**
-         * Should round pixels be forced when rendering?
-         * @default false
-         */
-        roundPixels: boolean;
-    };
-    /** @internal */
-    readonly type: number;
-    /** The name of the renderer. */
-    readonly name: string;
-    /** @internal */
-    readonly uid: number;
-    /** @internal */
-    _roundPixels: 0 | 1;
-    /** @internal */
-    readonly runners: Runners;
-    /** @internal */
-    readonly renderPipes: PIPES;
-    /** The view system manages the main canvas that is attached to the DOM */
-    view: ViewSystem;
-    /** The background system manages the background color and alpha of the main view. */
-    background: BackgroundSystem;
-    /** System that manages the generation of textures from the renderer */
-    textureGenerator: GenerateTextureSystem;
-    protected _initOptions: OPTIONS;
-    protected config: RendererConfig;
-    private _systemsHash;
-    private _lastObjectRendered;
-    /**
-     * Set up a system with a collection of SystemClasses and runners.
-     * Systems are attached dynamically to this class when added.
-     * @param config - the config for the system manager
-     */
-    constructor(config: RendererConfig);
-    /**
-     * Initialize the renderer.
-     * @param options - The options to use to create the renderer.
-     */
-    init(options?: Partial<OPTIONS>): Promise<void>;
-    /**
-     * Renders the object to its view.
-     * @param options - The options to render with.
-     * @param options.container - The container to render.
-     * @param [options.target] - The target to render to.
-     */
-    render(options: RenderOptions | Container): void;
-    /** @deprecated since 8.0.0 */
-    render(container: Container, options: {
-        renderTexture: any;
-    }): void;
-    /**
-     * Resizes the WebGL view to the specified width and height.
-     * @param desiredScreenWidth - The desired width of the screen.
-     * @param desiredScreenHeight - The desired height of the screen.
-     * @param resolution - The resolution / device pixel ratio of the renderer.
-     */
-    resize(desiredScreenWidth: number, desiredScreenHeight: number, resolution?: number): void;
-    /**
-     * Clears the render target.
-     * @param options - The options to use when clearing the render target.
-     * @param options.target - The render target to clear.
-     * @param options.clearColor - The color to clear with.
-     * @param options.clear - The clear mode to use.
-     * @advanced
-     */
-    clear(options?: ClearOptions): void;
-    /** The resolution / device pixel ratio of the renderer. */
-    get resolution(): number;
-    set resolution(value: number);
-    /**
-     * Same as view.width, actual number of pixels in the canvas by horizontal.
-     * @type {number}
-     * @readonly
-     * @default 800
-     */
-    get width(): number;
-    /**
-     * Same as view.height, actual number of pixels in the canvas by vertical.
-     * @default 600
-     */
-    get height(): number;
-    /**
-     * The canvas element that everything is drawn to.
-     * @type {environment.ICanvas}
-     */
-    get canvas(): CANVAS;
-    /**
-     * the last object rendered by the renderer. Useful for other plugins like interaction managers
-     * @readonly
-     */
-    get lastObjectRendered(): Container;
-    /**
-     * Flag if we are rendering to the screen vs renderTexture
-     * @readonly
-     * @default true
-     */
-    get renderingToScreen(): boolean;
-    /**
-     * Measurements of the screen. (0, 0, screenWidth, screenHeight).
-     *
-     * Its safe to use as filterArea or hitArea for the whole stage.
-     */
-    get screen(): Rectangle;
-    /**
-     * Create a bunch of runners based of a collection of ids
-     * @param runnerIds - the runner ids to add
-     */
-    private _addRunners;
-    private _addSystems;
-    /**
-     * Add a new system to the renderer.
-     * @param ClassRef - Class reference
-     * @param name - Property name for system, if not specified
-     *        will use a static `name` property on the class itself. This
-     *        name will be assigned as s property on the Renderer so make
-     *        sure it doesn't collide with properties on Renderer.
-     * @returns Return instance of renderer
-     */
-    private _addSystem;
-    private _addPipes;
-    destroy(options?: RendererDestroyOptions): void;
-    /**
-     * Generate a texture from a container.
-     * @param options - options or container target to use when generating the texture
-     * @returns a texture
-     */
-    generateTexture(options: GenerateTextureOptions | Container): Texture;
-    /**
-     * Whether the renderer will round coordinates to whole pixels when rendering.
-     * Can be overridden on a per scene item basis.
-     */
-    get roundPixels(): boolean;
-    /**
-     * Overridable function by `pixi.js/unsafe-eval` to silence
-     * throwing an error if platform doesn't support unsafe-evals.
-     * @private
-     * @ignore
-     */
-    _unsafeEvalCheck(): void;
-    /**
-     * Resets the rendering state of the renderer.
-     * This is useful when you want to use the WebGL context directly and need to ensure PixiJS's internal state
-     * stays synchronized. When modifying the WebGL context state externally, calling this method before the next Pixi
-     * render will reset all internal caches and ensure it executes correctly.
-     *
-     * This is particularly useful when combining PixiJS with other rendering engines like Three.js:
-     * ```js
-     * // Reset Three.js state
-     * threeRenderer.resetState();
-     *
-     * // Render a Three.js scene
-     * threeRenderer.render(threeScene, threeCamera);
-     *
-     * // Reset PixiJS state since Three.js modified the WebGL context
-     * pixiRenderer.resetState();
-     *
-     * // Now render Pixi content
-     * pixiRenderer.render(pixiScene);
-     * ```
-     * @advanced
-     */
-    resetState(): void;
-}
-export {};
-//# sourceMappingURL=AbstractRenderer.d.ts.map

package/dist/packages/pixijs/src/rendering/renderers/shared/system/AbstractRenderer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AbstractRenderer.d.ts","sourceRoot":"","sources":["../../../../../../../../packages/pixijs/src/rendering/renderers/shared/system/AbstractRenderer.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AAKlE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,KAAK,EAAE,WAAW,EAAa,MAAM,yBAAyB,CAAC;AACtE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wCAAwC,CAAC;AACtE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0CAA0C,CAAC;AAC3E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AACvE,OAAO,KAAK,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AACtG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC/E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,KAAK,EAAU,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE1D;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAE3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,iBAAiB,CAAA;KAAC,EAAE,CAAC;IACpD,WAAW,EAAE;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,eAAe,CAAA;KAAC,EAAE,CAAC;IACtD,kBAAkB,EAAE;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,GAAG,CAAA;KAAC,EAAE,CAAC;CACpD;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY;IAE/C,+BAA+B;IAC/B,SAAS,EAAE,SAAS,CAAC;IACrB,+CAA+C;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAEzB;;;OAGG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,+BAA+B;IAC/B,UAAU,CAAC,EAAE,WAAW,CAAC;IACzB,6BAA6B;IAC7B,KAAK,CAAC,EAAE,aAAa,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC,wBAAwB,GAAG;IACvE,uDAAuD;IACvD,sBAAsB,CAAC,EAAE,OAAO,CAAC;CACpC,CAAC,CAAC;AAEH,QAAA,MAAM,cAAc,4JAYV,CAAC;AAEX,KAAK,cAAc,GAAG,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC;AACpD,KAAK,OAAO,GAAG;KAAE,GAAG,IAAI,cAAc,GAAG,YAAY;CAAC,GAAG;IACrD,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,GAAG,YAAY,CAAC;CACpD,CAAC;AAGF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,qBAAa,gBAAgB,CACzB,KAAK,EAAE,OAAO,SAAS,qBAAqB,EAAE,MAAM,SAAS,OAAO,GAAG,iBAAiB,CAC1F,SAAQ,YAAY,CAAC;IAAC,MAAM,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,CAAA;CAAC,CAAC;IAE7F,4CAA4C;IAC5C,OAAc,cAAc;QACxB;;;WAGG;;QAEH;;;;;;;;;;;;;;;;;;;;;WAqBG;;QAEH;;;WAGG;;MAEL;IAEF,gBAAgB;IAChB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,gCAAgC;IAChC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B,gBAAgB;IAChB,SAAgB,GAAG,SAAmB;IAEtC,gBAAgB;IACT,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC;IAE3B,gBAAgB;IAChB,SAAgB,OAAO,EAAE,OAAO,CAAkC;IAClE,gBAAgB;IAChB,SAAgB,WAAW,EAA0B,KAAK,CAAC;IAC3D,0EAA0E;IACnE,IAAI,EAAG,UAAU,CAAC;IACzB,qFAAqF;IAC9E,UAAU,EAAE,gBAAgB,CAAC;IACpC,uEAAuE;IAChE,gBAAgB,EAAE,qBAAqB,CAAC;IAE/C,SAAS,CAAC,YAAY,EAAE,OAAO,CAAiB;IAChD,SAAS,CAAC,MAAM,EAAE,cAAc,CAAC;IAEjC,OAAO,CAAC,YAAY,CAA+C;IACnE,OAAO,CAAC,mBAAmB,CAAY;IAEvC;;;;OAIG;gBACS,MAAM,EAAE,cAAc;IAclC;;;OAGG;IACU,IAAI,CAAC,OAAO,GAAE,OAAO,CAAC,OAAO,CAAM;IAgChD;;;;;OAKG;IACI,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,SAAS,GAAG,IAAI;IACvD,8BAA8B;IACvB,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE;QAAC,aAAa,EAAE,GAAG,CAAA;KAAC,GAAG,IAAI;IA6DxE;;;;;OAKG;IACI,MAAM,CAAC,kBAAkB,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI;IAYjG;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO,GAAE,YAAiB,GAAG,IAAI;IAgB9C,2DAA2D;IAC3D,IAAI,UAAU,IAAI,MAAM,CAGvB;IAED,IAAI,UAAU,CAAC,KAAK,EAAE,MAAM,EAI3B;IAED;;;;;OAKG;IACH,IAAI,KAAK,IAAI,MAAM,CAGlB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,CAGnB;IAGD;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,CAGnB;IAED;;;OAGG;IACH,IAAI,kBAAkB,IAAI,SAAS,CAGlC;IAED;;;;OAIG;IACH,IAAI,iBAAiB,IAAI,OAAO,CAK/B;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,SAAS,CAGtB;IAED;;;OAGG;IACH,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,WAAW;IAYnB;;;;;;;;OAQG;IACH,OAAO,CAAC,UAAU;IAqBlB,OAAO,CAAC,SAAS;IA0BV,OAAO,CAAC,OAAO,GAAE,sBAA8B,GAAG,IAAI;IAsB7D;;;;OAIG;IACI,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,SAAS,GAAG,OAAO;IAK5E;;;OAGG;IACH,IAAI,WAAW,IAAI,OAAO,CAGzB;IAED;;;;;OAKG;IACI,gBAAgB,IAAI,IAAI;IAQ/B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,UAAU,IAAI,IAAI;CAI5B"}