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-interface

Field Summary

Fields

Modifier and Type	Field and Description
@JsNullable EventHandler	onend
@JsNullable EventHandler	onframeratechange
@JsNullable EventHandler	oninputsourceschange
@JsNullable EventHandler	onselect
@JsNullable EventHandler	onselectend
@JsNullable EventHandler	onselectstart
@JsNullable EventHandler	onsqueeze
@JsNullable EventHandler	onsqueezeend
@JsNullable EventHandler	onsqueezestart
@JsNullable 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.
java.lang.String	depthDataFormat()
java.lang.String	depthUsage()
XRDOMOverlayState	domOverlayState()
@JsNonNull 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.
java.lang.String	environmentBlendMode() The XRSession interface's read-only environmentBlendMode property identifies if—and to what degree—the computer-generated imagery is overlaid atop the real world.
java.lang.Double	frameRate()
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.
java.lang.String	interactionMode()
boolean	isDepthDataFormatSupported()
boolean	isDepthUsageSupported()
boolean	isDomOverlayStateSupported()
boolean	isEnvironmentBlendModeSupported()
boolean	isInteractionModeSupported()
boolean	isPreferredReflectionFormatSupported()
boolean	isRequestHitTestSourceForTransientInputSupported()
boolean	isRequestHitTestSourceSupported()
boolean	isRequestLightProbeSupported()
java.lang.String	preferredReflectionFormat()
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.
@JsNonNull Promise<XRHitTestSource>	requestHitTestSource(XRHitTestOptionsInit options)
@JsNonNull Promise<XRTransientInputHitTestSource>	requestHitTestSourceForTransientInput(XRTransientInputHitTestOptionsInit options)
@JsNonNull Promise<XRLightProbe>	requestLightProbe()
@JsNonNull Promise<XRLightProbe>	requestLightProbe(XRLightProbeInit options)
@JsNonNull 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.
Float32Array	supportedFrameRates()
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.
@JsNonNull Promise<java.lang.Void>	updateTargetFrameRate(float rate)
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

public @JsNullable EventHandler onend

onframeratechange

public @JsNullable EventHandler onframeratechange

oninputsourceschange

public @JsNullable EventHandler oninputsourceschange

onselect

public @JsNullable EventHandler onselect

onselectend

public @JsNullable EventHandler onselectend

onselectstart

public @JsNullable EventHandler onselectstart

onsqueeze

public @JsNullable EventHandler onsqueeze

onsqueezeend

public @JsNullable EventHandler onsqueezeend

onsqueezestart

public @JsNullable EventHandler onsqueezestart

onvisibilitychange

public @JsNullable EventHandler onvisibilitychange

Constructor Detail

XRSession

protected XRSession()

Method Detail

isDepthDataFormatSupported

@JsOverlay
public final boolean isDepthDataFormatSupported()

depthDataFormat

@JsProperty(name="depthDataFormat")
 @Nonnull
 @XRDepthDataFormat
public java.lang.String depthDataFormat()

isDepthUsageSupported

@JsOverlay
public final boolean isDepthUsageSupported()

depthUsage

@JsProperty(name="depthUsage")
 @Nonnull
 @XRDepthUsage
public java.lang.String depthUsage()

isDomOverlayStateSupported

@JsOverlay
public final boolean isDomOverlayStateSupported()

domOverlayState

@JsProperty(name="domOverlayState")
 @Nullable
public XRDOMOverlayState domOverlayState()

isEnvironmentBlendModeSupported

@JsOverlay
public final boolean isEnvironmentBlendModeSupported()

environmentBlendMode

@JsProperty(name="environmentBlendMode")
 @Nonnull
 @XREnvironmentBlendMode
public java.lang.String environmentBlendMode()

The XRSession interface's read-only environmentBlendMode property identifies if—and to what degree—the computer-generated imagery is overlaid atop the real world.

See Also:

XRSession.environmentBlendMode - MDN, XRSession.environmentBlendMode - WebXR Augmented Reality Module

frameRate

@JsProperty(name="frameRate")
 @Nullable
public java.lang.Double frameRate()

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

isInteractionModeSupported

@JsOverlay
public final boolean isInteractionModeSupported()

interactionMode

@JsProperty(name="interactionMode")
 @Nonnull
 @XRInteractionMode
public java.lang.String interactionMode()

isPreferredReflectionFormatSupported

@JsOverlay
public final boolean isPreferredReflectionFormatSupported()

preferredReflectionFormat

@JsProperty(name="preferredReflectionFormat")
 @Nonnull
 @XRReflectionFormat
public java.lang.String preferredReflectionFormat()

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

supportedFrameRates

@JsProperty(name="supportedFrameRates")
 @Nullable
public Float32Array supportedFrameRates()

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

public @JsNonNull 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

public @JsNonNull 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

updateTargetFrameRate

public @JsNonNull Promise<java.lang.Void> updateTargetFrameRate(float rate)

isRequestHitTestSourceSupported

@JsOverlay
public final boolean isRequestHitTestSourceSupported()

requestHitTestSource

public @JsNonNull Promise<XRHitTestSource> requestHitTestSource(@Nonnull
                                                                XRHitTestOptionsInit options)

isRequestHitTestSourceForTransientInputSupported

@JsOverlay
public final boolean isRequestHitTestSourceForTransientInputSupported()

requestHitTestSourceForTransientInput

public @JsNonNull Promise<XRTransientInputHitTestSource> requestHitTestSourceForTransientInput(@Nonnull
                                                                                               XRTransientInputHitTestOptionsInit options)

isRequestLightProbeSupported

@JsOverlay
public final boolean isRequestLightProbeSupported()

requestLightProbe

public @JsNonNull Promise<XRLightProbe> requestLightProbe(@Nonnull
                                                          XRLightProbeInit options)

requestLightProbe

public @JsNonNull Promise<XRLightProbe> requestLightProbe()