XRSession is extended to contain the initiateRoomCapture method which, if supported, will ask the XR Compositor to capture the current room layout. It is up to the XRCompositor if this will replace or augment the set of tracked planes. The user agent MAY also ignore this call, for instance if it doesn’t support a manual room capture more or if it determines that the room is already set up. The initiateRoomCapture method MUST only be able to be called once per XRSession.

inputSources

val inputSources: XRInputSourceArray

Returns a list of this session's XRInputSources, each representing an input device used to control the camera and/or scene.

interactionMode

val interactionMode: XRInteractionMode?

isSystemKeyboardSupported

val isSystemKeyboardSupported: Boolean

onend

var onend: EventHandler<XRSessionEvent, *, *>

onframeratechange

var onframeratechange: EventHandler<XRSessionEvent, *, *>

oninputsourceschange

var oninputsourceschange: EventHandler<XRInputSourcesChangeEvent, *, *>

onselect

var onselect: EventHandler<XRInputSourceEvent, *, *>

onselectend

var onselectend: EventHandler<XRInputSourceEvent, *, *>

onselectstart

var onselectstart: EventHandler<XRInputSourceEvent, *, *>

onsqueeze

var onsqueeze: EventHandler<XRInputSourceEvent, *, *>

onsqueezeend

var onsqueezeend: EventHandler<XRInputSourceEvent, *, *>

onsqueezestart

var onsqueezestart: EventHandler<XRInputSourceEvent, *, *>

onvisibilitychange

var onvisibilitychange: EventHandler<XRSessionEvent, *, *>

pauseDepthSensing

val pauseDepthSensing: () -> Unit?

persistentAnchors

val persistentAnchors: ReadonlyArray<JsString>?

A list of the known persistent anchors

renderState

val renderState: XRRenderState

object which contains options affecting how the imagery is rendered. This includes things such as the near and far clipping planes

requestHitTest

var requestHitTest: (ray: XRRay, referenceSpace: XRReferenceSpace) -> Promise<ReadonlyArray<XRHitResult>>?

Legacy

requestHitTestSource

var requestHitTestSource: (options: XRHitTestOptionsInit) -> Promise<XRHitTestSource>?

requestHitTestSourceForTransientInput

var requestHitTestSourceForTransientInput: (options: XRTransientInputHitTestOptionsInit) -> Promise<XRTransientInputHitTestSource>?

restorePersistentAnchor

var restorePersistentAnchor: (uuid: String) -> Promise<XRAnchor>?

Restores a persistent anchor with the given UUID.

resumeDepthSensing

val resumeDepthSensing: () -> Unit?

supportedFrameRates

val supportedFrameRates: Float32Array<*>?

visibilityState

val visibilityState: XRVisibilityState

Functions

awaitAnimationFrame

suspend fun XRSession.awaitAnimationFrame(): XRFrame

cancelAnimationFrame

fun cancelAnimationFrame(id: XRFrameRequestId)

Removes a callback from the animation frame painting callback from XRSession's set of animation frame rendering callbacks, given the identifying handle returned by a previous call to requestAnimationFrame().

dispatchEvent

open fun dispatchEvent(event: Event): Boolean

end

inline suspend fun XRSession.end()

Ends the WebXR session. Returns a promise which resolves when the session has been shut down.

endAsync

fun endAsync(): Promise<Void>

Ends the WebXR session. Returns a promise which resolves when the session has been shut down.

requestAnimationFrame

fun requestAnimationFrame(callback: XRFrameRequestCallback): XRFrameRequestId

Schedules the specified method to be called the next time the user agent is working on rendering an animation frame for the WebXR device. Returns an integer value which can be used to identify the request for the purposes of canceling the callback using cancelAnimationFrame(). This method is comparable to the Window.requestAnimationFrame() method.

requestReferenceSpace

inline suspend fun XRSession.requestReferenceSpace(type: XRReferenceSpaceType): XRSpace

Requests that a new XRReferenceSpace of the specified type be created. Returns a promise which resolves with the XRReferenceSpace or XRBoundedReferenceSpace which was requested, or throws a NotSupportedError if the requested space type isn't supported by the device.

requestReferenceSpaceAsync

fun requestReferenceSpaceAsync(type: XRReferenceSpaceType): Promise<XRSpace>

updateRenderState

inline suspend fun XRSession.updateRenderState()

inline suspend fun XRSession.updateRenderState(renderStateInit: XRRenderStateInit)

updateRenderStateAsync

fun updateRenderStateAsync(renderStateInit: XRRenderStateInit = definedExternally): Promise<Void>

updateTargetFrameRate

inline suspend fun XRSession.updateTargetFrameRate(rate: Float)

updateTargetFrameRateAsync

fun updateTargetFrameRateAsync(rate: Float): Promise<Void>

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>