Class WebXREnterExitUIOptions
Hierarchy
- WebXREnterExitUIOptions
Index
Properties
Optional custom ButtonsSearch playground for customButtons
User provided buttons to enable/disable WebXR. The system will provide default if not set
Optional ignore Session Granted EventSearch playground for ignoreSessionGrantedEvent
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.
Optional on ErrorSearch playground for onError
If defined, this function will be executed if the UI encounters an error when entering XR
Type declaration
-
-
Parameters
-
error: any
Returns void
-
-
Optional optional FeaturesSearch playground for optionalFeatures
A list of optional features to init the session with
Optional reference Space TypeSearch playground for referenceSpaceType
A reference space type to use when creating the default button. Default is local-floor
Optional render TargetSearch playground for renderTarget
Context to enter xr with
Optional required FeaturesSearch playground for requiredFeatures
A list of optional features to init the session with
Optional session ModeSearch playground for sessionMode
A session mode to use when creating the default button. Default is immersive-vr
Options to create the webXR UI