Winter Cardinal UI - v0.442.0 / DApplicationLayer

Class: DApplicationLayer

Hierarchy

Implements

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• new DApplicationLayer(application, options): DApplicationLayer

Parameters

Name Type
application DApplicationLike
options DApplicationLayerOptions

Returns

DApplicationLayer

Overrides

Application.constructor

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:49

Properties

_dynamicFontAtlases

• Protected _dynamicFontAtlases: null | DynamicFontAtlases = null

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:44

_elementContainer

• Protected _elementContainer: HTMLElement

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:42

_isLocked

• Protected _isLocked: boolean

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:38

_isOverlay

• Protected _isOverlay: boolean

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:39

_isVisible

• Protected _isVisible: boolean

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:45

_options

• Protected _options: DApplicationLayerOptions

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:35

_padding

• Protected _padding: DPadding

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:43

_reflowLimit

• Protected _reflowLimit: number

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:40

_renderBound

• Protected _renderBound: () => void

Type declaration

▸ (): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:37

_renderId

• Protected _renderId: null | number = null

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:36

_rootElement

• Protected _rootElement: HTMLElement

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:41

application

• Readonly application: DApplicationLike

Implementation of

DApplicationLayerLike.application

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:47

loader

• Readonly loader: Loader

Loader instance to help with asset loading.

Name

PIXI.Application#loader

Implementation of

DApplicationLayerLike.loader

Inherited from

Application.loader

Defined in

node_modules/pixi.js/pixi.js.d.ts:1064

renderer

• renderer: Renderer

WebGL renderer if available, otherwise CanvasRenderer.

Member

PIXI.Application#renderer

Implementation of

DApplicationLayerLike.renderer

Inherited from

Application.renderer

Defined in

node_modules/pixi.js/pixi.js.d.ts:991

resizeTo

• resizeTo: HTMLElement | Window

The HTML element or window to automatically resize the renderer’s view element to match width and height.

Name

resizeTo

Memberof

PIXI.Application#

Implementation of

DApplicationLayerLike.resizeTo

Inherited from

Application.resizeTo

Defined in

node_modules/pixi.js/pixi.js.d.ts:1043

screen

• Readonly screen: Rectangle

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

Member

Implementation of

DApplicationLayerLike.screen

Inherited from

Application.screen

Defined in

node_modules/pixi.js/pixi.js.d.ts:1018

stage

• stage: Container

The root display container that’s rendered.

Member

PIXI.Application#stage

Implementation of

DApplicationLayerLike.stage

Inherited from

Application.stage

Defined in

node_modules/pixi.js/pixi.js.d.ts:996

ticker

• ticker: Ticker

Ticker for doing render updates.

Name

ticker

Memberof

PIXI.Application#

Default

PIXI.Ticker.shared

Implementation of

DApplicationLayerLike.ticker

Inherited from

Application.ticker

Defined in

node_modules/pixi.js/pixi.js.d.ts:1085

view

• Readonly view: HTMLCanvasElement

Reference to the renderer’s canvas element.

Member

Implementation of

DApplicationLayerLike.view

Inherited from

Application.view

Defined in

node_modules/pixi.js/pixi.js.d.ts:1012

Accessors

height

• get height(): number

Returns

number

Implementation of

DApplicationLayerLike.height

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:317

padding

• get padding(): DPadding

Returns

DPadding

Implementation of

DApplicationLayerLike.padding

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:321

width

• get width(): number

Returns

number

Implementation of

DApplicationLayerLike.width

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:313

Methods

destroy

▸ destroy(removeView?, stageOptions?): void

Destroy and don’t use after this.

Parameters

Name Type Description
removeView? boolean Automatically remove canvas from DOM.
stageOptions? Object Options parameter. A boolean will act as if all options have been set to that value
stageOptions.baseTexture? boolean Only used for child Sprites if stageOptions.children is set to true. Should it destroy the base texture of the child sprite
stageOptions.children? boolean if set to true, all the children will have their destroy method called as well. ‘stageOptions’ will be passed on to those calls.
stageOptions.texture? boolean Only used for child Sprites if stageOptions.children is set to true. Should it destroy the texture of the child sprite

Returns

void

Implementation of

DApplicationLayerLike.destroy

Inherited from

Application.destroy

Defined in

node_modules/pixi.js/pixi.js.d.ts:1031

getDynamicFontAtlases

▸ getDynamicFontAtlases(): DynamicFontAtlases

Returns

DynamicFontAtlases

Implementation of

DApplicationLayerLike.getDynamicFontAtlases

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:357

getElementContainer

▸ getElementContainer(): HTMLElement

Returns

HTMLElement

Implementation of

DApplicationLayerLike.getElementContainer

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:353

getFocusController

▸ getFocusController(): DControllerFocus

Returns

DControllerFocus

Implementation of

DApplicationLayerLike.getFocusController

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:345

getRootElement

▸ getRootElement(): HTMLElement

Returns

HTMLElement

Implementation of

DApplicationLayerLike.getRootElement

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:349

initDoubleClickHandling

▸ initDoubleClickHandling(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:241

initFocusHandling

▸ initFocusHandling(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:153

initResizeHandling

▸ initResizeHandling(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:170

initRootElement

▸ initRootElement(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:113

initStage

▸ initStage(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:88

initView

▸ initView(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:95

initWheelHandling

▸ initWheelHandling(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:218

lock

▸ lock(): void

Returns

void

Implementation of

DApplicationLayerLike.lock

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:260

newElementContainer

▸ newElementContainer(): HTMLElement

Returns

HTMLElement

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:78

onResize

▸ onResize(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:187

onStageDirty

▸ onStageDirty(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:274

queueResize

▸ queueResize(): void

Resize is throttled, so it’s safe to call this multiple times per frame and it’ll only be called once.

Returns

void

Method

PIXI.Application#queueResize

Implementation of

DApplicationLayerLike.queueResize

Inherited from

Application.queueResize

Defined in

node_modules/pixi.js/pixi.js.d.ts:1050

reflow

▸ reflow(): void

Returns

void

Implementation of

DApplicationLayerLike.reflow

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:325

render

▸ render(): void

Returns

void

Implementation of

DApplicationLayerLike.render

Overrides

Application.render

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:295

resize

▸ resize(): void

Execute an immediate resize on the renderer, this is not throttled and can be expensive to call many times in a row. Will resize only if resizeTo property is set.

Returns

void

Method

PIXI.Application#resize

Implementation of

DApplicationLayerLike.resize

Inherited from

Application.resize

Defined in

node_modules/pixi.js/pixi.js.d.ts:1057

start

▸ start(): void

Convenience method for starting the render.

Returns

void

Method

PIXI.Application#start

Implementation of

DApplicationLayerLike.start

Inherited from

Application.start

Defined in

node_modules/pixi.js/pixi.js.d.ts:1076

stop

▸ stop(): void

Convenience method for stopping the render.

Returns

void

Method

PIXI.Application#stop

Implementation of

DApplicationLayerLike.stop

Inherited from

Application.stop

Defined in

node_modules/pixi.js/pixi.js.d.ts:1070

unlock

▸ unlock(): void

Returns

void

Implementation of

DApplicationLayerLike.unlock

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:264

update

▸ update(): void

Returns

void

Implementation of

DApplicationLayerLike.update

Defined in

src/main/typescript/wcardinal/ui/d-application-layer.ts:268

registerPlugin

▸ registerPlugin(plugin): void

Register a middleware plugin for the application

Parameters

Name Type Description
plugin Plugin Plugin being installed

Returns

void

Static

Inherited from

Application.registerPlugin

Defined in

node_modules/pixi.js/pixi.js.d.ts:1002

Edit this page.