akasha.xr

Class XRSystem

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.xr.XRSystem

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="XRSystem")
public class XRSystem
extends EventTarget

The WebXR Device API interface XRSystem provides methods which let you get access to an XRSession object representing a WebXR session. With that XRSession in hand, you can use it to interact with the Augmented Reality (AR) or Virtual Reality (VR) device.

See Also:

XRSystem - MDN, # xrsystem-interface

Field Summary

Fields

Modifier and Type	Field and Description
@JsNullable EventHandler	ondevicechange The ondevicechange property of the XRSystem interface is passed a devicechange event whenever availability of an immersive device changes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XRSystem()

Method Summary

Modifier and Type	Method and Description
void	addDevicechangeListener(EventListener callback)
void	addDevicechangeListener(EventListener callback, AddEventListenerOptions options)
void	addDevicechangeListener(EventListener callback, boolean useCapture)
@JsNonNull Promise<java.lang.Boolean>	isSessionSupported(java.lang.String mode) The XRSystem method isSessionSupported() returns a promise which resolves to true if the specified WebXR session mode is supported by the user's WebXR device.
void	removeDevicechangeListener(EventListener callback)
void	removeDevicechangeListener(EventListener callback, boolean useCapture)
void	removeDevicechangeListener(EventListener callback, EventListenerOptions options)
@JsNonNull Promise<XRSession>	requestSession(java.lang.String mode) The XRSystem interface's requestSession() method returns a promise which resolves to an XRSession object through which you can manage the requested type of WebXR session.
@JsNonNull Promise<XRSession>	requestSession(java.lang.String mode, XRSessionInit options) The XRSystem interface's requestSession() method returns a promise which resolves to an XRSession object through which you can manage the requested type of WebXR session.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ondevicechange

public @JsNullable EventHandler ondevicechange

The ondevicechange property of the XRSystem interface is passed a devicechange event whenever availability of an immersive device changes. The event that is fired is a "simple event" that implements the Event interface.

See Also:

XRSystem.ondevicechange - MDN, ondevicechange - WebXR Device API

Constructor Detail

XRSystem

protected XRSystem()

Method Detail

isSessionSupported

public @JsNonNull Promise<java.lang.Boolean> isSessionSupported(@XRSessionMode @Nonnull
                                                                java.lang.String mode)

The XRSystem method isSessionSupported() returns a promise which resolves to true if the specified WebXR session mode is supported by the user's WebXR device. Otherwise, the promise resolves with false.

See Also:

XRSystem.isSessionSupported - MDN, isSessionSupported() - WebXR Device API

requestSession

public @JsNonNull Promise<XRSession> requestSession(@XRSessionMode @Nonnull
                                                    java.lang.String mode,
                                                    @Nonnull
                                                    XRSessionInit options)

The XRSystem interface's requestSession() method returns a promise which resolves to an XRSession object through which you can manage the requested type of WebXR session.

See Also:

XRSystem.requestSession - MDN, requestSession() - WebXR Device API

requestSession

public @JsNonNull Promise<XRSession> requestSession(@XRSessionMode @Nonnull
                                                    java.lang.String mode)

The XRSystem interface's requestSession() method returns a promise which resolves to an XRSession object through which you can manage the requested type of WebXR session.

See Also:

XRSystem.requestSession - MDN, requestSession() - WebXR Device API

addDevicechangeListener

@JsOverlay
public final void addDevicechangeListener(@Nonnull
                                                     EventListener callback,
                                                     @Nonnull
                                                     AddEventListenerOptions options)

addDevicechangeListener

@JsOverlay
public final void addDevicechangeListener(@Nonnull
                                                     EventListener callback,
                                                     boolean useCapture)

addDevicechangeListener

@JsOverlay
public final void addDevicechangeListener(@Nonnull
                                                     EventListener callback)

removeDevicechangeListener

@JsOverlay
public final void removeDevicechangeListener(@Nonnull
                                                        EventListener callback,
                                                        @Nonnull
                                                        EventListenerOptions options)

removeDevicechangeListener

@JsOverlay
public final void removeDevicechangeListener(@Nonnull
                                                        EventListener callback,
                                                        boolean useCapture)

removeDevicechangeListener

@JsOverlay
public final void removeDevicechangeListener(@Nonnull
                                                        EventListener callback)