PixiJS

Namespace: app

app

The app module provides a set of classes to use as a starting point when building applications.

import { Application } from 'pixi.js';

const app = new Application();

await app.init();

// don't forget to add the canvas to the DOM
document.body.appendChild(app.canvas);

Classes

Application
ApplicationInitHook
CullerPlugin
ResizePlugin
TickerPlugin

Interface Definitions

ApplicationOptions

Application options supplied to the init method.

Properties:
Name Type Default Description
autoStart boolean 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.
resizeTo Window | HTMLElement

Element to automatically resize the renderer to.
sharedTicker boolean false

Settrue to use 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.
Example
 import { Application } from 'pixi.js';

 const app = new Application();

 await app.init({
    autoStart: false,
    resizeTo: window,
    sharedTicker: true,
 });

ResizePluginOptions

Application options for the ResizePlugin.

Properties:
Name Type Attributes Default Description
resizeTo Window | HTMLElement <optional>
 window

Element to automatically resize the renderer to.

TickerPluginOptions

Application options for the TickerPluginOptions.

Properties:
Name Type Attributes Default Description
autoStart boolean <optional>
 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.
sharedTicker boolean <optional>
 false

Settrue to use 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.