import { Container } from '@pixi/display';
import { autoDetectRenderer } from '@pixi/core';
import type { Rectangle } from '@pixi/math';
import type { Renderer, IRendererOptionsAuto, AbstractRenderer } from '@pixi/core';
import type { IDestroyOptions } from '@pixi/display';
export interface IApplicationPlugin {
init: (...params: any[]) => any;
destroy: (...params: any[]) => any;
}
export interface IApplicationOptions extends IRendererOptionsAuto {
autoStart?: boolean;
sharedTicker?: boolean;
sharedLoader?: boolean;
resizeTo?: Window | HTMLElement;
}
/**
* Convenience class to create a new PIXI application.
*
* This class automatically creates the renderer, ticker and root container.
*
* @example
* // Create the application
* const app = new PIXI.Application();
*
* // Add the view to the DOM
* document.body.appendChild(app.view);
*
* // ex, add display objects
* app.stage.addChild(PIXI.Sprite.from('something.png'));
*
* @class
* @memberof PIXI
*/
export class Application
{
public static _plugins: IApplicationPlugin[];
public stage: Container;
public renderer: Renderer|AbstractRenderer;
/**
* @param {object} [options] - The optional renderer parameters.
* @param {boolean} [options.autoStart=true] - Automatically starts the rendering after the construction.
* **Note**: Setting this parameter to false does NOT stop the shared ticker even if you set
* options.sharedTicker to true in case that it is already started. Stop it by your own.
* @param {number} [options.width=800] - The width of the renderers view.
* @param {number} [options.height=600] - The height of the renderers view.
* @param {HTMLCanvasElement} [options.view] - The canvas to use as a view, optional.
* @param {boolean} [options.transparent=false] - If the render view is transparent.
* @param {boolean} [options.autoDensity=false] - Resizes renderer view in CSS pixels to allow for
* resolutions other than 1.
* @param {boolean} [options.antialias=false] - Sets antialias
* @param {boolean} [options.preserveDrawingBuffer=false] - Enables drawing buffer preservation, enable this if you
* need to call toDataUrl on the WebGL context.
* @param {number} [options.resolution=1] - The resolution / device pixel ratio of the renderer, retina would be 2.
* @param {boolean} [options.forceCanvas=false] - prevents selection of WebGL renderer, even if such is present, this
* option only is available when using **pixi.js-legacy** or **@pixi/canvas-renderer** modules, otherwise
* it is ignored.
* @param {number} [options.backgroundColor=0x000000] - The background color of the rendered area
* (shown if not transparent).
* @param {boolean} [options.clearBeforeRender=true] - This sets if the renderer will clear the canvas or
* not before the new render pass.
* @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance"
* for devices with dual graphics card. **(WebGL only)**.
* @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker.
* If set to false, you cannot register a handler to occur before anything that runs on the shared ticker.
* The system ticker will always run before both the shared ticker and the app ticker.
* @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader.
* @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to.
*/
constructor(options?: IApplicationOptions)
{
// The default options
options = Object.assign({
forceCanvas: false,
}, options);
/**
* WebGL renderer if available, otherwise CanvasRenderer.
* @member {PIXI.Renderer|PIXI.CanvasRenderer}
*/
this.renderer = autoDetectRenderer(options);
/**
* The root display container that's rendered.
* @member {PIXI.Container}
*/
this.stage = new Container();
// install plugins here
Application._plugins.forEach((plugin) =>
{
plugin.init.call(this, options);
});
}
/**
* Register a middleware plugin for the application
* @static
* @param {PIXI.Application.Plugin} plugin - Plugin being installed
*/
static registerPlugin(plugin: IApplicationPlugin): void
{
Application._plugins.push(plugin);
}
/**
* Render the current stage.
*/
public render(): void
{
// TODO: Since CanvasRenderer has not been converted this function thinks it takes DisplayObject & PIXI.DisplayObject
// This can be fixed when CanvasRenderer is converted.
this.renderer.render(this.stage as any);
}
/**
* Reference to the renderer's canvas element.
* @member {HTMLCanvasElement}
* @readonly
*/
get view(): HTMLCanvasElement
{
return this.renderer.view;
}
/**
* Reference to the renderer's screen rectangle. Its safe to use as `filterArea` or `hitArea` for the whole screen.
* @member {PIXI.Rectangle}
* @readonly
*/
get screen(): Rectangle
{
return this.renderer.screen;
}
/**
* Destroy and don't use after this.
* @param {Boolean} [removeView=false] - Automatically remove canvas from DOM.
* @param {object|boolean} [stageOptions] - Options parameter. A boolean will act as if all options
* have been set to that value
* @param {boolean} [stageOptions.children=false] - if set to true, all the children will have their destroy
* method called as well. 'stageOptions' will be passed on to those calls.
* @param {boolean} [stageOptions.texture=false] - Only used for child Sprites if stageOptions.children is set
* to true. Should it destroy the texture of the child sprite
* @param {boolean} [stageOptions.baseTexture=false] - Only used for child Sprites if stageOptions.children is set
* to true. Should it destroy the base texture of the child sprite
*/
public destroy(removeView?: boolean, stageOptions?: IDestroyOptions|boolean): void
{
// Destroy plugins in the opposite order
// which they were constructed
const plugins = Application._plugins.slice(0);
plugins.reverse();
plugins.forEach((plugin) =>
{
plugin.destroy.call(this);
});
this.stage.destroy(stageOptions);
this.stage = null;
this.renderer.destroy(removeView);
this.renderer = null;
}
}
/**
* @memberof PIXI.Application
* @typedef {object} Plugin
* @property {function} init - Called when Application is constructed, scoped to Application instance.
* Passes in `options` as the only argument, which are Application constructor options.
* @property {function} destroy - Called when destroying Application, scoped to Application instance
*/
/**
* Collection of installed plugins.
* @static
* @private
* @type {PIXI.Application.Plugin[]}
*/
Application._plugins = [];