Class Application

Hierarchy

  • Application
    • Application

Constructors

constructor

Properties

cancelResize isInitialized queueResize renderer resizeTo stage ticker _plugins

Accessors

canvas screen view

Methods

destroy init render resize start stop

Constructors

constructor

  • new Application(): Application

  • Create new Application instance

    Returns Application

  • new Application(options?): Application

  • Parameters

    • Optional options: Partial<ApplicationOptions>

    Returns Application

    Deprecated

    since 8.0.0

Properties

cancelResize

cancelResize: (() => void)

Type declaration

    • (): void

    • Returns void

Private isInitialized

isInitialized: boolean = false

queueResize

queueResize: (() => void)

Type declaration

    • (): void

    • Returns void

renderer

renderer: Renderer<HTMLCanvasElement>

WebGL renderer if available, otherwise CanvasRenderer.

Member

resizeTo

resizeTo: HTMLElement | Window

stage

stage: Container<ContainerChild>

The root display container that's rendered.

ticker

ticker: Ticker

Static _plugins

_plugins: ApplicationPlugin[]

Collection of installed plugins.

Alias

_plugins

Accessors

canvas

  • get canvas(): R["canvas"]

  • Reference to the renderer's canvas element.

    Returns R["canvas"]

    Member

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

view

  • get view(): R["canvas"]

  • Reference to the renderer's canvas element.

    Returns R["canvas"]

    Member

    Deprecated

    since 8.0.0

Methods

destroy

  • destroy(rendererDestroyOptions?, options?): void

  • Destroys the application and all of its resources.

    Parameters

    • Optional rendererDestroyOptions: RendererDestroyOptions

      The options for destroying the renderer.

    • Optional options: DestroyOptions

      The options for destroying the stage.

    Returns void

init

  • init(options?): Promise<void>

  • Parameters

    • Optional options: Partial<ApplicationOptions>

    Returns Promise<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

constructor cancelResize isInitialized queueResize renderer resizeTo stage ticker _plugins canvas screen view destroy init render resize start stop