Pixi’VN
indexClasses

Class: CanvasManagerStatic

pixi-vn on GitHub

Defined in: src/canvas/CanvasManagerStatic.ts:12

This class is responsible for managing the canvas, the tickers, the events, and the window size and the children of the window.

Properties

_isInitialized

> static _isInitialized: boolean = false

Defined in: src/canvas/CanvasManagerStatic.ts:44


canvasHeight

> static canvasHeight: number = 300

Defined in: src/canvas/CanvasManagerStatic.ts:43


canvasWidth

> static canvasWidth: number = 300

Defined in: src/canvas/CanvasManagerStatic.ts:42


htmlLayers

> static htmlLayers: HTMLElement[] = []

Defined in: src/canvas/CanvasManagerStatic.ts:41

This is the div that have same size of the canvas. This is useful to put interface elements. You can use React or other framework to put elements in this div.

Accessors

app

Get Signature

> get static app(): Application<Renderer>

Defined in: src/canvas/CanvasManagerStatic.ts:20

The Pixi.js application instance.

Throws

when the canvas has not been initialized yet (i.e. before calling Game.init()).

Returns

Application<Renderer>


childrenAliasesOrder

Get Signature

> get static childrenAliasesOrder(): string[]

Defined in: src/canvas/CanvasManagerStatic.ts:213

The order of the elements in the canvas, is determined by the zIndex.

Returns

string[]


gameLayer

Get Signature

> get static gameLayer(): Container<ContainerChild>

Defined in: src/canvas/CanvasManagerStatic.ts:27

Returns

Container<ContainerChild>

Methods

addHtmlLayer()

> static addHtmlLayer(id, element, style?): HTMLDivElement

Defined in: src/canvas/CanvasManagerStatic.ts:130

Parameters

id

string

element

HTMLElement

style?

Partial<Pick<CSSStyleDeclaration, "position" | "pointerEvents" | "userSelect">> = {}

Returns

HTMLDivElement


getHtmlLayer()

> static getHtmlLayer(id): HTMLElement | undefined

Defined in: src/canvas/CanvasManagerStatic.ts:155

Parameters

id

string

Returns

HTMLElement | undefined


init()

> static init(element, options?, devtoolsOptions?): Promise<void>

Defined in: src/canvas/CanvasManagerStatic.ts:46

Parameters

element

HTMLElement

options?

Partial<ApplicationOptions> & object

devtoolsOptions?

Devtools

Returns

Promise<void>


removeHtmlLayer()

> static removeHtmlLayer(id): void

Defined in: src/canvas/CanvasManagerStatic.ts:146

Parameters

id

string

Returns

void

On this page