Class AppElement

The AppElement interface provides properties and methods for manipulating <pc-app> elements. The AppElement interface also inherits the properties and methods of the HTMLElement interface.

Hierarchy (View Summary)

AsyncElement
- AppElement

Index

Properties

app

app: null | Application = null

The PlayCanvas application instance.

Accessors

alpha

get alpha(): boolean
Gets the alpha flag.

Returns boolean
The alpha flag.
- Defined in src/app.ts:343
set alpha(value: boolean): void
Sets the alpha flag.
Parameters
- value: boolean
  The alpha flag.
Returns void
- Defined in src/app.ts:335

antialias

get antialias(): boolean
Gets the antialias flag.

Returns boolean
The antialias flag.
- Defined in src/app.ts:359
set antialias(value: boolean): void
Sets the antialias flag.
Parameters
- value: boolean
  The antialias flag.
Returns void
- Defined in src/app.ts:351

depth

get depth(): boolean
Gets the depth flag.

Returns boolean
The depth flag.
- Defined in src/app.ts:375
set depth(value: boolean): void
Sets the depth flag.
Parameters
- value: boolean
  The depth flag.
Returns void
- Defined in src/app.ts:367

highResolution

get highResolution(): boolean
Gets the high resolution flag.

Returns boolean
The high resolution flag.
- Defined in src/app.ts:404
set highResolution(value: boolean): void
Sets the high resolution flag. When true, the application will render at the device's physical resolution. When false, the application will render at CSS resolution.
Parameters
- value: boolean
  The high resolution flag.
Returns void
- Defined in src/app.ts:393

stencil

get stencil(): boolean
Gets the stencil flag.

Returns boolean
The stencil flag.
- Defined in src/app.ts:420
set stencil(value: boolean): void
Sets the stencil flag.
Parameters
- value: boolean
  The stencil flag.
Returns void
- Defined in src/app.ts:412

Methods

`Protected`_onReady

_onReady(): void
Called when the element is fully initialized and ready. Subclasses should call this when they're ready.

Returns void
Inherited from AsyncElement._onReady
- Defined in src/async-element.ts:32

ready

ready(): Promise<AppElement>
Returns a promise that resolves with this element when it's ready.

Returns Promise<AppElement>
A promise that resolves with this element when it's ready.
Inherited from AsyncElement.ready
- Defined in src/async-element.ts:41

Class AppElement

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

app

Accessors

alpha

Returns boolean

Parameters

Returns void

antialias

Returns boolean

Parameters

Returns void

depth

Returns boolean

Parameters

Returns void

highResolution

Returns boolean

Parameters

Returns void

stencil

Returns boolean

Parameters

Returns void

Methods

`Protected`_onReady

Returns void

ready

Returns Promise<AppElement>

Settings

On This Page

Class AppElement

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

app

Accessors

alpha

Returns boolean

Parameters

Returns void

antialias

Returns boolean

Parameters

Returns void

depth

Returns boolean

Parameters

Returns void

highResolution

Returns boolean

Parameters

Returns void

stencil

Returns boolean

Parameters

Returns void

Methods

Protected_onReady

Returns void

ready

Returns Promise<AppElement>

Settings

On This Page

`Protected`_onReady