Options for the default xr helper


  • WebXRDefaultExperienceOptions



Optional disableDefaultUI

Find examples in Playground
disableDefaultUI: boolean

Enable or disable default UI to enter XR

Optional disableTeleportation

Find examples in Playground
disableTeleportation: boolean

Should teleportation not initialize. defaults to false.

Optional floorMeshes

Find examples in Playground
floorMeshes: Array<AbstractMesh>

Floor meshes that will be used for teleport

Optional ignoreNativeCameraTransformation

Find examples in Playground
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 inputOptions

Find examples in Playground
inputOptions: IWebXRInputOptions

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

Optional optionalFeatures

Find examples in Playground
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 outputCanvasOptions

Find examples in Playground
outputCanvasOptions: WebXRManagedOutputCanvasOptions

optional configuration for the output canvas

Optional renderingGroupId

Find examples in Playground
renderingGroupId: number

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

Optional uiOptions

Find examples in Playground

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

Optional useStablePlugins

Find examples in Playground
useStablePlugins: boolean

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

Generated using TypeDoc