booleanactive 

True if XR session is running.

Entity, nullcamera 

Active camera for which XR session is running or null.

XrHitTesthitTest 

Provides the ability to perform hit tests on the representation of real world geometry of the underlying AR system.

XrInputinput 

Provides access to Input Sources.

object, nullsession 

Provides access to XRSession of WebXR.

string, nullspaceType 

Returns reference space type of currently running XR session or null if no session is running. Can be any of XRSPACE_*.

booleansupported 

True if XR is supported.

string, nulltype 

Returns type of currently running XR session or null if no session is running. Can be any of XRTYPE_*.

end([callback]) 

Attempts to end XR session and optionally fires callback when session is ended or failed to end.

app.keyboard.on('keydown', function (evt) {
    if (evt.key === pc.KEY_ESCAPE && app.xr.active) {
        app.xr.end();
    }
});

Parameters

callback

XrErrorCallback

Optional callback function called once session is started. The callback has one argument Error - it is null if successfully started XR session.

isAvailable(type) 

Check if specific type of session is available.

if (app.xr.isAvailable(pc.XRTYPE_VR)) {
    // VR is available
}

Parameters

type

string

Session type. Can be one of the following: XRTYPE_INLINE: Inline - always available type of session. It has limited features availability and is rendered into HTML element. XRTYPE_VR: Immersive VR - session that provides exclusive access to VR device with best available tracking features. XRTYPE_AR: Immersive AR - session that provides exclusive access to VR/AR device that is intended to be blended with real-world environment.

Returns

boolean

True if specified session type is available.

start(camera, type, spaceType, [options]) 

Attempts to start XR session for provided CameraComponent and optionally fires callback when session is created or failed to create. Integrated XR APIs need to be enabled by providing relevant options.

button.on('click', function () {
    app.xr.start(camera, pc.XRTYPE_VR, pc.XRSPACE_LOCALFLOOR);
});

button.on('click', function () {
    app.xr.start(camera, pc.XRTYPE_AR, pc.XRSPACE_LOCALFLOOR, {
        depthSensing: { }
    });
});

Parameters

camera	CameraComponent	It will be used to render XR session and manipulated based on pose tracking.
type	string	Session type. Can be one of the following: XRTYPE_INLINE: Inline - always available type of session. It has limited features availability and is rendered into HTML element. XRTYPE_VR: Immersive VR - session that provides exclusive access to VR device with best available tracking features. XRTYPE_AR: Immersive AR - session that provides exclusive access to VR/AR device that is intended to be blended with real-world environment.
spaceType	string	Reference space type. Can be one of the following: XRSPACE_VIEWER: Viewer - always supported space with some basic tracking capabilities. XRSPACE_LOCAL: Local - represents a tracking space with a native origin near the viewer at the time of creation. It is meant for seated or basic local XR sessions. XRSPACE_LOCALFLOOR: Local Floor - represents a tracking space with a native origin at the floor in a safe position for the user to stand. The y axis equals 0 at floor level. Floor level value might be estimated by the underlying platform. It is meant for seated or basic local XR sessions. XRSPACE_BOUNDEDFLOOR: Bounded Floor - represents a tracking space with its native origin at the floor, where the user is expected to move within a pre-established boundary. XRSPACE_UNBOUNDED: Unbounded - represents a tracking space where the user is expected to move freely around their environment, potentially long distances from their starting point.
options	object	Object with additional options for XR session initialization.
options.optionalFeatures	string[]	Optional features for XRSession start. It is used for getting access to additional WebXR spec extensions.
options.imageTracking	boolean	Set to true to attempt to enable XrImageTracking.
options.planeDetection	boolean	Set to true to attempt to enable XrPlaneDetection.
options.callback	XrErrorCallback	Optional callback function called once session is started. The callback has one argument Error - it is null if successfully started XR session.
options.depthSensing	object	Optional object with depth sensing parameters to attempt to enable XrDepthSensing.
options.depthSensing.usagePreference	string	Optional usage preference for depth sensing, can be 'cpu-optimized' or 'gpu-optimized' (XRDEPTHSENSINGUSAGE_*), defaults to 'cpu-optimized'. Most preferred and supported will be chosen by the underlying depth sensing system.
options.depthSensing.dataFormatPreference	string	Optional data format preference for depth sensing, can be 'luminance-alpha' or 'float32' (XRDEPTHSENSINGFORMAT_*), defaults to 'luminance-alpha'. Most preferred and supported will be chosen by the underlying depth sensing system.

available:[type] 

Fired when availability of specific XR type is changed.

app.xr.on('available:' + pc.XRTYPE_VR, function (available) {
    console.log('Immersive VR session is now ' + (available ? 'available' : 'unavailable'));
});

Parameters

available

boolean

True if specified session type is now available.

available 

Fired when availability of specific XR type is changed.

app.xr.on('available', function (type, available) {
    console.log('"' + type + '" XR session is now ' + (available ? 'available' : 'unavailable'));
});

Parameters

type	string	The session type that has changed availability.
available	boolean	True if specified session type is now available.

end 

Fired when XR session is ended.

app.xr.on('end', function () {
    // XR session has ended
});

error 

Fired when XR session is failed to start or failed to check for session type support.

app.xr.on('error', function (ex) {
    // XR session has failed to start, or failed to check for session type support
});

Parameters

error

Error

Error object related to failure of session start or check of session type support.

start 

Fired when XR session is started.

app.xr.on('start', function () {
    // XR session has started
});

update 

Fired when XR session is updated, providing relevant XRFrame object.

app.xr.on('update', function (frame) {

});

Parameters

frame

object

XRFrame object that can be used for interfacing directly with WebXR APIs.

fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8]) 

Fire an event, all additional arguments are passed on to the event listener.

obj.fire('test', 'This is the message');

Parameters

name	string	Name of event to fire.
arg1	*	First argument that is passed to the event handler.
arg2	*	Second argument that is passed to the event handler.
arg3	*	Third argument that is passed to the event handler.
arg4	*	Fourth argument that is passed to the event handler.
arg5	*	Fifth argument that is passed to the event handler.
arg6	*	Sixth argument that is passed to the event handler.
arg7	*	Seventh argument that is passed to the event handler.
arg8	*	Eighth argument that is passed to the event handler.

Returns

EventHandler

Self for chaining.

hasEvent(name) 

Test if there are any handlers bound to an event name.

obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false

Parameters

name

string

The name of the event to test.

Returns

boolean

True if the object has handlers bound to the specified event name.

off([name], [callback], [scope]) 

Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

const handler = function () {
};
obj.on('test', handler);

obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

Parameters

name	string	Name of the event to unbind.
callback	HandleEventCallback	Function to be unbound.
scope	object	Scope that was used as the this when the event is fired.

Returns

EventHandler

Self for chaining.

on(name, callback, [scope]) 

Attach an event handler to an event.

obj.on('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console

Parameters

name	string	Name of the event to bind the callback to.
callback	HandleEventCallback	Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope	object	Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandler

Self for chaining.

once(name, callback, [scope]) 

Attach an event handler to an event. This handler will be removed after being fired once.

obj.once('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled

Parameters

name	string	Name of the event to bind the callback to.
callback	HandleEventCallback	Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope	object	Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandler

Self for chaining.