akasha.xr

Class XRSession

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.xr.XRSession

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

The WebXR Device API's XRSession interface represents an ongoing XR session, providing methods and properties used to interact with and control the session. To open a WebXR session, use the XRSystem interface's requestSession() method.

See Also:

XRSession - MDN, XRSession - WebXR Device API

Field Summary

Fields

Modifier and Type	Field and Description
EventHandler	onend
EventHandler	oninputsourceschange
EventHandler	onselect
EventHandler	onselectend
EventHandler	onselectstart
EventHandler	onsqueeze
EventHandler	onsqueezeend
EventHandler	onsqueezestart
EventHandler	onvisibilitychange

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XRSession()

Method Summary

Modifier and Type	Method and Description
void	cancelAnimationFrame(int handle) The cancelAnimationFrame() method of the XRSession interface cancels an animation frame which was previously requested by calling requestAnimationFrame.
Promise<java.lang.Void>	end() The end() method shuts down the XRSession on which it's called, returning a promise which resolves once the session has fully shut down.
XRInputSourceArray	inputSources() The read-only inputSources property of the XRSession interface returns an XRInputSourceArray object which lists all controllers and input devices which are expressly associated with the XR device and are currently available.
XRRenderState	renderState() The read-only renderState property of an XRSession object indicates the returns a XRRenderState object describing how the user's environment which should be rendered.
int	requestAnimationFrame(XRFrameRequestCallback callback) The XRSession method requestAnimationFrame(), much like the Window method of the same name, schedules a callback to be executed the next time the browser is ready to paint the session's virtual environment to the XR display.
Promise<XRReferenceSpace>	requestReferenceSpace(java.lang.String type) The requestReferenceSpace() method of the XRSession interface returns a promise that resolves with an instance of either XRReferenceSpace or XRBoundedReferenceSpace as appropriate given the type of reference space requested.
void	updateRenderState() The updateRenderState() method of the XRSession interface of WebXR API schedules changes to be applied to the active render state prior to rendering of the next frame.
void	updateRenderState(XRRenderStateInit state) The updateRenderState() method of the XRSession interface of WebXR API schedules changes to be applied to the active render state prior to rendering of the next frame.
java.lang.String	visibilityState() The read-only visibilityState property of the XRSession interface is a string indicating whether the WebXR content is currently visible to the user, and if it is, whether it's the primary focus.

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

onend

@Nullable
public EventHandler onend

oninputsourceschange

@Nullable
public EventHandler oninputsourceschange

onselect

@Nullable
public EventHandler onselect

onselectend

@Nullable
public EventHandler onselectend

onselectstart

@Nullable
public EventHandler onselectstart

onsqueeze

@Nullable
public EventHandler onsqueeze

onsqueezeend

@Nullable
public EventHandler onsqueezeend

onsqueezestart

@Nullable
public EventHandler onsqueezestart

onvisibilitychange

@Nullable
public EventHandler onvisibilitychange

Constructor Detail

XRSession

protected XRSession()

Method Detail

inputSources

@JsProperty(name="inputSources")
 @Nonnull
public XRInputSourceArray inputSources()

The read-only inputSources property of the XRSession interface returns an XRInputSourceArray object which lists all controllers and input devices which are expressly associated with the XR device and are currently available.

See Also:

XRSession.inputSources - MDN, XRSession.inputSources - WebXR Device API

renderState

@JsProperty(name="renderState")
 @Nonnull
public XRRenderState renderState()

The read-only renderState property of an XRSession object indicates the returns a XRRenderState object describing how the user's environment which should be rendered.

See Also:

XRSession.renderState - MDN, XRSession.renderState - WebXR Device API

visibilityState

@JsProperty(name="visibilityState")
 @Nonnull
 @XRVisibilityState
public java.lang.String visibilityState()

The read-only visibilityState property of the XRSession interface is a string indicating whether the WebXR content is currently visible to the user, and if it is, whether it's the primary focus.

See Also:

XRSession.visibilityState - MDN, XRSession.visibilityState - WebXR Device API

cancelAnimationFrame

public void cancelAnimationFrame(int handle)

The cancelAnimationFrame() method of the XRSession interface cancels an animation frame which was previously requested by calling requestAnimationFrame.

See Also:

XRSession.cancelAnimationFrame - MDN, XRSession.cancelAnimationFrame - WebXR Device API

end

@Nonnull
public Promise<java.lang.Void> end()

The end() method shuts down the XRSession on which it's called, returning a promise which resolves once the session has fully shut down.

See Also:

XRSession.end - MDN, XRSession.end - WebXR Device API

requestAnimationFrame

public int requestAnimationFrame(@Nonnull
                                 XRFrameRequestCallback callback)

The XRSession method requestAnimationFrame(), much like the Window method of the same name, schedules a callback to be executed the next time the browser is ready to paint the session's virtual environment to the XR display.

See Also:

XRSession.requestAnimationFrame - MDN, XRSession.requestAnimationFrame - WebXR Device API

requestReferenceSpace

@Nonnull
public Promise<XRReferenceSpace> requestReferenceSpace(@XRReferenceSpaceType @Nonnull
                                                                java.lang.String type)

The requestReferenceSpace() method of the XRSession interface returns a promise that resolves with an instance of either XRReferenceSpace or XRBoundedReferenceSpace as appropriate given the type of reference space requested.

See Also:

XRSession.requestReferenceSpace - MDN, requestReferenceSpace() - WebXR Device API

updateRenderState

public void updateRenderState(@Nonnull
                              XRRenderStateInit state)

The updateRenderState() method of the XRSession interface of WebXR API schedules changes to be applied to the active render state prior to rendering of the next frame.

See Also:

XRSession.updateRenderState - MDN, XRSession.updateRenderState() - WebXR Device API

updateRenderState

public void updateRenderState()

The updateRenderState() method of the XRSession interface of WebXR API schedules changes to be applied to the active render state prior to rendering of the next frame.

See Also:

XRSession.updateRenderState - MDN, XRSession.updateRenderState() - WebXR Device API