XRSystem | Babylon.js API documentation

Class XRSystem`Abstract`

Hierarchy

EventTarget
- XRSystem

Implements

XRSystem

Implemented by

XRSystem

Index

Constructors

constructor

new XRSystem(): XRSystem
Returns XRSystem
Inherited from EventTarget.constructor

Properties

ondevicechange

ondevicechange: null | XRSystemDeviceChangeEventHandler

onsessiongranted

onsessiongranted: null | XRSystemSessionGrantedEventHandler

Methods

addEventListener

addEventListener<K extends keyof XRSystemEventMap>(
    type: K,
    listener: (this: XRSystem, ev: XRSystemEventMap[K]) => any,
    options?: boolean | AddEventListenerOptions,
): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference
Type Parameters
- K extends keyof XRSystemEventMap
Parameters
- type: K
- listener: (this: XRSystem, ev: XRSystemEventMap[K]) => any
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141458
addEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141459

isSessionSupported

isSessionSupported(mode: XRSessionMode): Promise<boolean>
Queries if a given mode may be supported by the user agent and device capabilities.
Parameters
- mode: XRSessionMode
Returns Promise<boolean>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141454

removeEventListener

removeEventListener<K extends keyof XRSystemEventMap>(
    type: K,
    listener: (this: XRSystem, ev: XRSystemEventMap[K]) => any,
    options?: boolean | EventListenerOptions,
): void
Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference
Type Parameters
- K extends keyof XRSystemEventMap
Parameters
- type: K
- listener: (this: XRSystem, ev: XRSystemEventMap[K]) => any
- Optionaloptions: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141460
removeEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
Removes the event listener in target's event listener list with the same type, callback, and options.

MDN Reference
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141461

requestSession

requestSession(mode: XRSessionMode, options?: XRSessionInit): Promise<XRSession>
Attempts to initialize an XRSession for the given mode if possible, entering immersive mode if necessary.
Parameters
- mode: XRSessionMode
- Optionaloptions: XRSessionInit
Returns Promise<XRSession>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:141448

Class XRSystem`Abstract`

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Returns XRSystem

Properties

ondevicechange

onsessiongranted

Methods

addEventListener

Type Parameters

Parameters

Returns void

Parameters

Returns void

isSessionSupported

Parameters

Returns Promise<boolean>

removeEventListener

Type Parameters

Parameters

Returns void

Parameters

Returns void

requestSession

Parameters

Returns Promise<XRSession>

Settings

On This Page

Class XRSystemAbstract

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Returns XRSystem

Properties

ondevicechange

onsessiongranted

Methods

addEventListener

Type Parameters

Parameters

Returns void

Parameters

Returns void

isSessionSupported

Parameters

Returns Promise<boolean>

removeEventListener

Type Parameters

Parameters

Returns void

Parameters

Returns void

requestSession

Parameters

Returns Promise<XRSession>

Settings

On This Page

Class XRSystem`Abstract`