Class WebXRExperienceHelper

camera

featuresManager

onInitialXRPoseSetObservable

onStateChangedObservable

sessionManager

state

disableSpecatatorMode

• disableSpecatatorMode(): void

  Disable spectator mode for desktop VR experiences.

  Returns void

dispose

• dispose(): void

  Disposes of the experience helper

  Returns void

enableSpectatorMode

• enableSpectatorMode(options?: WebXRSpectatorModeOption): void

  Enable spectator mode for desktop VR experiences. When spectator mode is enabled a camera will be attached to the desktop canvas and will display the first rig camera's view on the desktop canvas. Please note that this will degrade performance, as it requires another camera render. It is also not recommended to enable this in devices like the quest, as it brings no benefit there.

  Parameters

  • Optionaloptions: WebXRSpectatorModeOption

    giving WebXRSpectatorModeOption for specutator camera to setup when the spectator mode is enabled.

  Returns void

enterXRAsync

• enterXRAsync(
      sessionMode: XRSessionMode,
      referenceSpaceType: XRReferenceSpaceType,
      renderTarget?: WebXRRenderTarget<WebGLRenderingContext, XRWebGLLayer>,
      sessionCreationOptions?: XRSessionInit,
  ): Promise<WebXRSessionManager>

  Enters XR mode (This must be done within a user interaction in most browsers eg. button click)

  Parameters

  • sessionMode: XRSessionMode

    options for the XR session

  • referenceSpaceType: XRReferenceSpaceType

    frame of reference of the XR session

  • OptionalrenderTarget: WebXRRenderTarget<WebGLRenderingContext, XRWebGLLayer>

    the output canvas that will be used to enter XR mode

  • sessionCreationOptions: XRSessionInit = {}

    optional XRSessionInit object to init the session with

  Returns Promise<WebXRSessionManager>

  promise that resolves after xr mode has entered

exitXRAsync

• exitXRAsync(): Promise<void>

  Exits XR mode and returns the scene to its original state

  Returns Promise<void>

  promise that resolves after xr mode has exited

StaticCreateAsync

• CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>

  Creates the experience helper

  Parameters

  • scene: Scene

    the scene to attach the experience helper to

  Returns Promise<WebXRExperienceHelper>

  a promise for the experience helper