Class: WebXRSessionManager

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

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

Extends

• EventDispatcher<WebXRSessionManagerEventMap>

Constructors

Constructor

new WebXRSessionManager(renderer, sessionInit, mode): WebXRSessionManager

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

Parameters

renderer

WebGLOrWebGPURenderer

sessionInit

XRSessionInit

mode

XRSessionMode

Returns

WebXRSessionManager

Overrides

THREE.EventDispatcher<WebXRSessionManagerEventMap>.constructor

Properties

currentSession?

optional currentSession: XRSession

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

Methods

dispose()

dispose(): Promise<void>

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

Returns

Promise<void>

---

endSession()

endSession(): Promise<void>

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

Ends the WebXR session.

Returns

Promise<void>

---

getSessionOptions()

getSessionOptions(): XRSessionInit | undefined

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

Returns

XRSessionInit | undefined

---

initialize()

initialize(): Promise<void>

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

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:159

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:102

Requests and initializes a WebXR session.

Returns

void