Interface IWebXRFeature
Hierarchy
- IDisposable
- IWebXRFeature
Implemented by
Index
Properties
attachedSearch playground for attached
Is this feature attached
Optional depends
A list of (Babylon WebXR) features this feature depends on
disable
Should auto-attach be disabled?
is
Was this feature disposed;
on
Triggered when the feature is attached
on
Triggered when the feature is detached
Optional xr
The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
Methods
attachSearch playground for attach
Attach the feature to the session Will usually be called by the features manager
Parameters
Optional force: boolean
should attachment be forced (even when already attached)
Returns boolean
true if successful.
detachSearch playground for detach
Detach the feature from the session Will usually be called by the features manager
Returns boolean
true if successful.
disposeSearch playground for dispose
Releases all held resources
Returns void
Optional getXRSession
If this feature requires to extend the XRSessionInit object, this function will return the partial XR session init object
Returns Promise<Partial<XRSessionInit>>
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
Defining the interface required for a (webxr) feature