Class XRSession Abstract
Hierarchy
- EventTarget
- XRSession
Implements
Implemented by
Index
Constructors
Properties
Methods
- add
Event Listener - cancel
Animation Frame - end
- get
Tracked Image Scores - initiate
Room Capture - remove
Event Listener - request
Animation Frame - request
Hit Test - request
Hit Test Source - request
Hit Test Source For Transient Input - request
Light Probe - request
Reference Space - try
Set Feature Point Cloud Enabled - try
Set Mesh Detector Enabled - try
Set Preferred Mesh Detector Options - try
Set Preferred Plane Detector Options - update
Render State - update
Target Frame Rate - update
World Tracking State
Constructors
constructor
Returns XRSession
Properties
Readonly depth
Readonly depth
Optional Readonly dom
enabled
Readonly environment
Optional Readonly frame
Readonly input
onendSearch playground for onend
onframeratechangeSearch playground for onframeratechange
oninputsourceschangeSearch playground for oninputsourceschange
onselectSearch playground for onselect
onselectendSearch playground for onselectend
onselectstartSearch playground for onselectstart
onsqueezeSearch playground for onsqueeze
onsqueezeendSearch playground for onsqueezeend
onsqueezestartSearch playground for onsqueezestart
onvisibilitychangeSearch playground for onvisibilitychange
Optional Readonly preferred
Readonly render
object which contains options affecting how the imagery is rendered. This includes things such as the near and far clipping planes
Optional Readonly supported
Readonly visibility
Methods
add
Type Parameters
K extends keyof XRSessionEventMap
Parameters
type: K
listener: ((this: XRSession, ev: XRSessionEventMap[K]) => any)
Parameters
this: XRSession
ev: XRSessionEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
cancel
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().
Parameters
id: number
Returns void
endSearch playground for end
Ends the WebXR session. Returns a promise which resolves when the session has been shut down.
Returns Promise<void>
Optional get
Returns Promise<XRImageTrackingScore[]>
Optional initiate
Returns Promise<void>
remove
Type Parameters
K extends keyof XRSessionEventMap
Parameters
type: K
listener: ((this: XRSession, ev: XRSessionEventMap[K]) => any)
Parameters
this: XRSession
ev: XRSessionEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
request
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.
Parameters
callback: XRFrameRequestCallback
Returns number
Optional request
Parameters
ray: XRRay
referenceSpace: XRReferenceSpace
Returns Promise<XRHitResult[]>
Optional request
Parameters
options: XRHitTestOptionsInit
Returns Promise<XRHitTestSource>
Optional request
Parameters
options: XRTransientInputHitTestOptionsInit
Returns Promise<XRTransientInputHitTestSource>
request
The XRSession interface is extended with the ability to create new XRLightProbe instances. XRLightProbe instances have a session object, which is the XRSession that created this XRLightProbe.
Can reject with with a "NotSupportedError" DOMException
Parameters
Optional options: XRLightProbeInit
Returns Promise<XRLightProbe>
request
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>
try
Parameters
enabled: boolean
Returns boolean
try
Parameters
enabled: boolean
Returns boolean
try
Parameters
preferredOptions: XRGeometryDetectorOptions
Returns boolean
try
Parameters
preferredOptions: XRGeometryDetectorOptions
Returns boolean
update
Parameters
Optional renderStateInit: XRRenderStateInit
Returns Promise<void>
update
Parameters
rate: number
Returns Promise<void>
Optional update
Parameters
options: { planeDetectionState?: { enabled: boolean } }
Optional plane
Detection State?: { enabled: boolean } enabled: boolean
Returns undefined | void
Returns a list of this session's XRInputSources, each representing an input device used to control the camera and/or scene.