XRSession
Hierarchy
- EventTarget
- XRSession
Implements
Implemented by
Index
Constructors
Properties
Methods
Properties
Optionalcharging
Optionalcharging
Optionaldischarging
Optionallevel
Readonlyinput
Readonlyrender
object which contains options affecting how the imagery is rendered. This includes things such as the near and far clipping planes
Readonlyenvironment
Readonlyvisibility
Optional Readonlyframe
Optional Readonlysupported
Optional Readonlyenabled
Readonlyis
Optional Readonlyinteraction
onend
oninputsourceschange
onselect
onselectstart
onselectend
onsqueeze
onsqueezestart
onsqueezeend
onvisibilitychange
onframeratechange
Optionalrequest
Optionalrequest
options: XRTransientInputHitTestOptionsInit,
) => undefined | Promise<XRTransientInputHitTestSource>
Optionalrequest
ray: XRRay,
referenceSpace: XRReferenceSpace,
) => undefined | Promise<XRHitResult[]>
Optional Readonlydom
Optional Readonlydepth
Optional Readonlydepth
Methods
cancel
cancelAnimationFrame(id: number): voidRemoves 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().
Parameters
id: number
Returns void
end
request
requestAnimationFrame(callback: XRFrameRequestCallback): numberSchedules 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.
Parameters
callback: XRFrameRequestCallback
Returns number
request
requestReferenceSpace(
type: XRReferenceSpaceType,
): Promise<XRReferenceSpace | XRBoundedReferenceSpace>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.
Parameters
type: XRReferenceSpaceType
Returns Promise<XRReferenceSpace | XRBoundedReferenceSpace>
update
updateRenderState(renderStateInit?: XRRenderStateInit): Promise<void>Parameters
OptionalrenderStateInit: XRRenderStateInit
Returns Promise<void>
update
add
addEventListener<K extends keyof XRSessionEventMap>(
type: K,
listener: (this: XRSession, ev: XRSessionEventMap[K]) => any,
options?: boolean | AddEventListenerOptions,
): voidAppends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Type Parameters
- K extends keyof XRSessionEventMap
Parameters
type: Klistener: (this: XRSession, ev: XRSessionEventMap[K]) => anyOptionaloptions: boolean | AddEventListenerOptions
Returns void
addEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | AddEventListenerOptions,
): voidAppends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Parameters
type: stringlistener: EventListenerOrEventListenerObjectOptionaloptions: boolean | AddEventListenerOptions
Returns void
remove
removeEventListener<K extends keyof XRSessionEventMap>(
type: K,
listener: (this: XRSession, ev: XRSessionEventMap[K]) => any,
options?: boolean | EventListenerOptions,
): voidRemoves the event listener in target's event listener list with the same type, callback, and options.
Type Parameters
- K extends keyof XRSessionEventMap
Parameters
type: Klistener: (this: XRSession, ev: XRSessionEventMap[K]) => anyOptionaloptions: boolean | EventListenerOptions
Returns void
removeEventListener(
type: string,
listener: EventListenerOrEventListenerObject,
options?: boolean | EventListenerOptions,
): voidRemoves the event listener in target's event listener list with the same type, callback, and options.
Parameters
type: stringlistener: EventListenerOrEventListenerObjectOptionaloptions: boolean | EventListenerOptions
Returns void
Optionalinitiate
initiateRoomCapture(): Promise<undefined>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.
Returns a list of this session's XRInputSources, each representing an input device used to control the camera and/or scene.