Options
All
  • Public
  • Public/Protected
  • All
Menu

Options to create the webXR UI

Hierarchy

  • WebXREnterExitUIOptions

Index

Constructors

Properties

customButtons?: WebXREnterExitUIButton[]

User provided buttons to enable/disable WebXR. The system will provide default if not set

ignoreSessionGrantedEvent?: boolean

If set, the sessiongranted event will not be registered. sessiongranted is used to move seamlessly between WebXR experiences. If set to true the user will be forced to press the "enter XR" button even if sessiongranted event was triggered. If not set and a sessiongranted event was triggered, the XR session will start automatically.

onError?: (error: any) => void

Type declaration

    • (error: any): void
    • If defined, this function will be executed if the UI encounters an error when entering XR

      Parameters

      • error: any

      Returns void

optionalFeatures?: string[]

A list of optional features to init the session with

referenceSpaceType?: XRReferenceSpaceType

A reference space type to use when creating the default button. Default is local-floor

renderTarget?: Nullable<WebXRRenderTarget>

Context to enter xr with

requiredFeatures?: string[]

A list of optional features to init the session with

sessionMode?: XRSessionMode

A session mode to use when creating the default button. Default is immersive-vr

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited constructor
  • Static method

Settings

Theme