Type Alias: XROptions

XROptions = object

Defined in: packages/core/src/init/xr.ts:92

Options for launching an XR session.

Properties

features?

optional features: XRFeatureOptions

Defined in: packages/core/src/init/xr.ts:98

Structured feature flags; avoids raw string arrays.

---

launchOnSessionGranted?

optional launchOnSessionGranted: boolean

Defined in: packages/core/src/init/xr.ts:117

Launch XR when the browser grants an immersive session through an external entry point such as a headset deep link. The listener is armed before asynchronous world initialization so an early grant is not lost. This takes precedence over offer; IWSDK does not run both native grant and offer flows for the same world.

Default Value

false

---

referenceSpace?

optional referenceSpace: ReferenceSpaceSpec

Defined in: packages/core/src/init/xr.ts:96

Reference space policy (preferred + fallback).

---

restoreCameraOnExit?

optional restoreCameraOnExit: boolean

Defined in: packages/core/src/init/xr.ts:108

Auto-restore world.camera to its pre-XR local transform and projection when the session ends. Without this, WebGLRenderer.xr leaves the camera at the last head pose and the 2D fallback view is inside-the-head until the user re-applies a camera setup. Restore is deferred one rAF so WebXRManager finishes tearing down on the end-tick before the camera is overwritten.

Default Value

true

---

sessionMode?

optional sessionMode: SessionMode

Defined in: packages/core/src/init/xr.ts:94

Session mode to request.

Default Value

SessionMode.ImmersiveVR