• Public
  • Public/Protected
  • All

Class WebXRDefaultExperienceOptions

Options for the default xr helper


  • WebXRDefaultExperienceOptions



Optional disableDefaultUISearch playground for disableDefaultUI

disableDefaultUI: boolean

Enable or disable default UI to enter XR

Optional disableNearInteractionSearch playground for disableNearInteraction

disableNearInteraction: boolean

Should nearInteraction not initialize. Defaults to false.

Optional disablePointerSelectionSearch playground for disablePointerSelection

disablePointerSelection: boolean

Should pointer selection not initialize. Note that disabling pointer selection also disables teleportation. Defaults to false.

Optional disableTeleportationSearch playground for disableTeleportation

disableTeleportation: boolean

Should teleportation not initialize. Defaults to false.

Optional floorMeshesSearch playground for floorMeshes

floorMeshes: Array<AbstractMesh>

Floor meshes that will be used for teleport

Optional ignoreNativeCameraTransformationSearch playground for ignoreNativeCameraTransformation

ignoreNativeCameraTransformation: boolean

If set to true, the first frame will not be used to reset position The first frame is mainly used when copying transformation from the old camera Mainly used in AR

Optional inputOptionsSearch playground for inputOptions

inputOptions: IWebXRInputOptions

Disable the controller mesh-loading. Can be used if you want to load your own meshes

Optional optionalFeaturesSearch playground for optionalFeatures

optionalFeatures: boolean | string[]

A list of optional features to init the session with If set to true, all features we support will be added

Optional outputCanvasOptionsSearch playground for outputCanvasOptions

outputCanvasOptions: WebXRManagedOutputCanvasOptions

optional configuration for the output canvas

Optional pointerSelectionOptionsSearch playground for pointerSelectionOptions

optional configuration for pointer selection

Optional renderingGroupIdSearch playground for renderingGroupId

renderingGroupId: number

An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes

Optional uiOptionsSearch playground for uiOptions

optional UI options. This can be used among other to change session mode and reference space type

Optional useStablePluginsSearch playground for useStablePlugins

useStablePlugins: boolean

When loading teleportation and pointer select, use stable versions instead of latest.


  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method