Class WebXRDomOverlay
Hierarchy
-
WebXRAbstractFeature
- WebXRDomOverlay
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
Creates a new instance of the dom-overlay feature
Parameters
-
_xrSessionManager: WebXRSessionManager
an instance of WebXRSessionManager
-
options: IWebXRDomOverlayOptions
options to use when constructing this feature
Returns WebXRDomOverlay
-
Properties
disable
Should auto-attach be disabled?
is
Is this feature disposed?
Readonly optionsSearch playground for options
options to use when constructing this feature
xr
The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
Static Readonly NameSearch playground for Name
The module's name
Static Readonly VersionSearch playground for Version
The (Babylon) version of this module. This is an integer representing the implementation version. This number does not correspond to the WebXR specs version
Accessors
attached
-
Is this feature attached
Returns boolean
dom
-
The type of DOM overlay (null when not supported). Provided by UA and remains unchanged for duration of session.
Returns Nullable<WebXRDomOverlayType>
Methods
attachSearch playground for attach
-
attach this feature Will usually be called by the features manager
Returns boolean
true if successful.
detachSearch playground for detach
-
detach this feature.
Returns boolean
true if successful, false if failed or already detached
disposeSearch playground for dispose
-
Dispose this feature and all of the resources attached
Returns void
getXRSession
-
Extends the session init object if needed
Returns Promise<Partial<XRSessionInit>>
augmentation object for the xr session init object.
is
-
This function will be executed during before enabling the feature and can be used to not-allow enabling it. Note that at this point the session has NOT started, so this is purely checking if the browser supports it
Returns boolean
whether or not the feature is compatible in this environment
DOM Overlay Feature
5.0.0