Class WebXRBackgroundRemover
Hierarchy
-
WebXRAbstractFeature
- WebXRBackgroundRemover
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
constructs a new background remover module
Parameters
-
_xrSessionManager: WebXRSessionManager
the session manager for this module
-
Optional options: IWebXRBackgroundRemoverOptions
read-only options to be used in this module
Returns WebXRBackgroundRemover
-
Properties
disable
Should auto-attach be disabled?
is
Is this feature disposed?
on
registered observers will be triggered when the background state changes
Readonly optionsSearch playground for options
read-only options to be used in this module
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
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. Will usually be called by the features manager
Returns boolean
true if successful.
disposeSearch playground for dispose
-
Dispose this feature and all of the resources attached
Returns void
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
A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.