Skip to main content

Class: WebXRSessionManager

Defined in: src/core/components/WebXRSessionManager.ts:31

Manages the WebXR session lifecycle by extending THREE.EventDispatcher to broadcast its state to any listener.

Extends​

Constructors​

Constructor​

new WebXRSessionManager(renderer, sessionInit, mode, fallbackToVR): WebXRSessionManager

Defined in: src/core/components/WebXRSessionManager.ts:39

Parameters​

renderer​

WebGLOrWebGPURenderer

sessionInit​

XRSessionInit

mode​

XRSessionMode

fallbackToVR​

boolean = true

Returns​

WebXRSessionManager

Overrides​

THREE.EventDispatcher<WebXRSessionManagerEventMap>.constructor

Properties​

currentSession?​

optional currentSession: XRSession

Defined in: src/core/components/WebXRSessionManager.ts:32

Methods​

dispose()​

dispose(): Promise<void>

Defined in: src/core/components/WebXRSessionManager.ts:263

Returns​

Promise<void>


endSession()​

endSession(): Promise<void>

Defined in: src/core/components/WebXRSessionManager.ts:171

Ends the WebXR session.

Returns​

Promise<void>


getSessionOptions()​

getSessionOptions(): XRSessionInit | undefined

Defined in: src/core/components/WebXRSessionManager.ts:192

Returns​

XRSessionInit | undefined


initialize()​

initialize(): Promise<void>

Defined in: src/core/components/WebXRSessionManager.ts:53

Checks for WebXR support and availability of the requested session mode. This should be called to initialize the manager and trigger the first events.

Returns​

Promise<void>


isXRSupported()​

isXRSupported(): boolean | undefined

Defined in: src/core/components/WebXRSessionManager.ts:188

Returns whether XR is supported. Will be undefined until initialize is complete.

Returns​

boolean | undefined


startSession()​

startSession(): void

Defined in: src/core/components/WebXRSessionManager.ts:131

Requests and initializes a WebXR session.

Returns​

void