Skip to main content
←API Reference

XRSubsystems


Classes​

NameTypeSummary
ProviderSubsystemProvider<XRVps2AnchorSubsystem>
The provider API for XRVps2AnchorSubsystem-derived classes to implement.
ProviderSubsystemProvider<XRVps2AssetSubsystem>
The provider API for XRVps2AssetSubsystem-derived classes to implement.
ProviderSubsystemProvider<XRVps2Subsystem>
-
ProviderSubsystemProvider<XRDeviceMappingSubsystem>
-
ProviderSubsystemProvider<XRSceneSegmentationSubsystem>
The provider which will service the XRSceneSegmentationSubsystem.
ProviderSubsystemProvider<XRScanningSubsystem>
An abstract class to be implemented by providers of this subsystem.
Vps2AssetIdVps2AssetId
Conversions between VPS asset UUID strings and TrackableIds.
XRDeviceMappingSubsystemSubsystemWithProvider<XRDeviceMappingSubsystem, XRDeviceMappingSubsystemDescriptor, Provider>
-
XRDeviceMappingSubsystemDescriptorSubsystemDescriptorWithProvider<XRDeviceMappingSubsystem, Provider>
-
XRScanningConfigurationXRScanningConfiguration
Configuration for scanning.
XRScanningSubsystemSubsystemWithProvider<XRScanningSubsystem, XRScanningSubsystemDescriptor, Provider>
Defines an interface for interacting with scanning functionality.
XRScanningSubsystemDescriptorSubsystemDescriptorWithProvider<XRScanningSubsystem, Provider>
-
XRSceneSegmentationSubsystemSubsystemWithProvider<XRSceneSegmentationSubsystem, XRSceneSegmentationSubsystemDescriptor, Provider>, ISubsystemWithModelMetadata
Defines an interface for interacting with semantic segmentation functionality.
XRSceneSegmentationSubsystemDescriptorSubsystemDescriptorWithProvider<XRSceneSegmentationSubsystem, Provider>
Descriptor for the XRSceneSegmentationSubsystem.
XRVps2AnchorSubsystemTrackingSubsystem<XRVps2Anchor, XRVps2AnchorSubsystem, XRVps2AnchorSubsystemDescriptor, Provider>
A tracking subsystem serving VPS2 anchors as trackables.
XRVps2AnchorSubsystemDescriptorSubsystemDescriptorWithProvider<XRVps2AnchorSubsystem, Provider>
Descriptor for the XRVps2AnchorSubsystem.
XRVps2AssetSubsystemTrackingSubsystem<XRVps2Asset, XRVps2AssetSubsystem, XRVps2AssetSubsystemDescriptor, Provider>
A tracking subsystem serving the origins of VPS assets as trackables.
XRVps2AssetSubsystemDescriptorSubsystemDescriptorWithProvider<XRVps2AssetSubsystem, Provider>
Descriptor for the XRVps2AssetSubsystem.
XRVps2SubsystemSubsystemWithProvider<XRVps2Subsystem, XRVps2SubsystemDescriptor, Provider>
The subsystem owning the VPS2 feature's lifecycle: configuration, localization,
and geolocation. Anchors and asset origins are served by the
XRVps2AnchorSubsystem and XRVps2AssetSubsystem
trackable subsystems, which run against the feature this subsystem manages.
XRVps2SubsystemDescriptorSubsystemDescriptorWithProvider<XRVps2Subsystem, Provider>
Descriptor for the XRVps2Subsystem.

Structs​

NameTypeSummary
CinfoValueType, IEquatable<Cinfo>
-
CinfoValueType, IEquatable<Cinfo>
Constructor info used to register a descriptor.
Vps2LocalizedAssetValueType, IEquatable<Vps2LocalizedAsset>
The VPS asset the device is localized to.
XRGeolocationValueType
Structure describing a location and heading. Coordinates use the WGS84 datum.
XRScanningVoxelDataValueType, IEquatable<XRScanningVoxelData>
Contains a native voxel buffers for positions and colors.
XRSceneSegmentationSubsystemCinfoValueType, IEquatable<XRSceneSegmentationSubsystemCinfo>
Constructor parameters for the XRSceneSegmentationSubsystemDescriptor.
XRVps2AnchorValueType, ITrackable, IEquatable<XRVps2Anchor>
Describes session-relative data for an anchor.
Note: trackingState can stay tracked while a device is disturbed, such as a
covered camera or a dark room, and stays tracked indefinitely while the device stays
still. It changes once confidence drops low enough. Use trackingConfidence and
trackingStateReason to react more sensitively to device disturbances.
XRVps2AnchorPayloadValueType, IEquatable<XRVps2AnchorPayload>
Represents the payload for a persistent anchor.
XRVps2AnchorSubsystemCinfoValueType, IEquatable<XRVps2AnchorSubsystemCinfo>
Constructor parameters for the XRVps2AnchorSubsystemDescriptor.
XRVps2AssetValueType, ITrackable, IEquatable<XRVps2Asset>
Describes session-relative data for a VPS asset's origin.
XRVps2AssetSubsystemCinfoValueType, IEquatable<XRVps2AssetSubsystemCinfo>
Constructor parameters for the XRVps2AssetSubsystemDescriptor.
XRVps2AssetTrackingDataValueType
The pose of a VPS asset's origin in the device's AR tracking space.
XRVps2GeolocationValueType
Structure describing device location and heading as calculated by VPS2.
XRVps2LocalizationValueType, IEquatable<XRVps2Localization>
Spatial mapping between the device’s AR tracking space and real-world geolocation,
as determined by VPS2.
XRVps2LocalizationRequestRecordValueType
Diagnostic information about a VPS2 network request.
XRVps2PoseValueType
Pose in AR session space calculated by VPS2 from a geolocation. This is the pose of
the geolocation that was passed in, not of the device.
XRVps2SubsystemCinfoValueType, IEquatable<XRVps2SubsystemCinfo>
Constructor parameters for the XRVps2SubsystemDescriptor.

Enums​

NameTypeSummary
ScanningStateScanningState
-
Vps2AnchorTrackingStateReasonuint
Provides further information about the tracking state of an anchor.
Query this if the anchor's tracking state is NotTracking
Vps2LocalizationErrorbyte
Possible errors from VPS2 localization operations.
Vps2LocalizationRequestStatusbyte
-
Vps2LocalizationRequestTypebyte
Type of request reported by a XRVps2LocalizationRequestRecord.
Vps2TrackingStateVps2TrackingState
Quality of the device's VPS localization.
Note: Precise can persist while a device is disturbed, such as a covered camera
or a dark room, and persists indefinitely while the device stays still. It changes once
confidence drops low enough.