Image tracking for immersive AR sessions. Providing a list of images and their estimated widths will enable tracking those images in the real world.
Auto AttachSearch playground for disableAutoAttach
Should auto-attach be disabled?
DisposedSearch playground for isDisposed
Is this feature disposed?
Feature Attach ObservableSearch playground for onFeatureAttachObservable
Observers registered here will be executed when the feature is attached
Feature Detach ObservableSearch playground for onFeatureDetachObservable
Observers registered here will be executed when the feature is detached
Trackable Image Found ObservableSearch playground for onTrackableImageFoundObservable
An image was deemed trackable, and the system will start tracking it.
Tracked Image Updated ObservableSearch playground for onTrackedImageUpdatedObservable
The image was found and its state was updated.
Untrackable Image Found ObservableSearch playground for onUntrackableImageFoundObservable
This will be triggered if the underlying system deems an image untrackable. The index is the index of the image from the array used to initialize the feature.
Readonly optionsSearch playground for options
read-only options to be used in this module
Native Feature NameSearch playground for xrNativeFeatureName
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
Is this feature attached
attach this feature Will usually be called by the features manager
true if successful.
detach this feature. Will usually be called by the features manager
true if successful.
Dispose this feature and all of the resources attached
Tracked Image By IdSearch playground for getTrackedImageById
Init ExtensionSearch playground for getXRSessionInitExtension
Extends the session init object if needed
augmentation object fo the xr session init object.
CompatibleSearch playground for isCompatible
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
whether or not the feature is compatible in this environment