Class Application<VIEW>

Convenience class to create a new PixiJS application.

This class automatically creates the renderer, ticker and root container.

Example

import { Application, Sprite } from 'pixi.js';

// Create the application
const app = new Application();

// Add the view to the DOM
document.body.appendChild(app.view);

// ex, add display objects
app.stage.addChild(Sprite.from('something.png'));
@class

Memberof

PIXI

Type Parameters

Hierarchy

  • Application
    • Application

Constructors

constructor

Properties

cancelResize queueResize renderer resizeTo stage ticker _plugins

Accessors

screen view

Methods

destroy render resize start stop

Constructors

constructor

Properties

cancelResize

cancelResize: (() => void)

Type declaration

    • (): void

    • Returns void

queueResize

queueResize: (() => void)

Type declaration

    • (): void

    • Returns void

renderer

renderer: IRenderer<VIEW>

WebGL renderer if available, otherwise CanvasRenderer.

Member

resizeTo

resizeTo: HTMLElement | Window

stage

stage: Container<DisplayObject>

The root display container that's rendered.

Member

ticker

ticker: Ticker

Static _plugins

_plugins: IApplicationPlugin[]

Collection of installed plugins.

Accessors

screen

  • get screen(): Rectangle

  • Reference to the renderer's screen rectangle. Its safe to use as filterArea or hitArea for the whole screen.

    Returns Rectangle

    Member

view

  • get view(): VIEW

  • Reference to the renderer's canvas element.

    Returns VIEW

    Member

Methods

destroy

  • destroy(removeView?, stageOptions?): void

  • Destroy and don't use after this.

    Parameters

    • Optional removeView: boolean

      Automatically remove canvas from DOM.

    • Optional stageOptions: boolean | IDestroyOptions

      Options parameter. A boolean will act as if all options have been set to that value

    Returns void

render

  • render(): void

  • Render the current stage.

    Returns void

resize

  • resize(): void

  • Returns void

start

  • start(): void

  • Returns void

stop

  • stop(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

constructorcancelResizequeueResizerendererresizeTostageticker_pluginsscreenviewdestroyrenderresizestartstop

Generated using TypeDoc