Skip to main content
←API Reference

XRSubsystems

Classes​

NameTypeSummary
ObjectDetectionUtilitiesObjectDetectionUtilities
-
ProviderSubsystemProvider<XRVps2Subsystem>
-
ProviderSubsystemProvider<XRPersistentAnchorSubsystem>
An abstract class to be implemented by providers of this subsystem.
ProviderSubsystemProvider<XRObjectDetectionSubsystem>
The provider which will service the XRObjectDetectionSubsystem.
ProviderSubsystemProvider<XRWorldPositioningSubsystem>
The provider which will service the XRWorldPositioningSubsystem.
ProviderSubsystemProvider<XRSemanticsSubsystem>
The provider which will service the XRSemanticsSubsystem.
ProviderSubsystemProvider<XRScanningSubsystem>
An abstract class to be implemented by providers of this subsystem.
XRDetectedObjectXRDetectedObject
A class representing an object in the XR camera's view detected by the object detection model.
XRObjectDetectionSubsystemSubsystemWithProvider<XRObjectDetectionSubsystem, XRObjectDetectionSubsystemDescriptor, Provider>, ISubsystemWithModelMetadata
Defines an interface for interacting with object detection functionality.
XRObjectDetectionSubsystemDescriptorSubsystemDescriptorWithProvider<XRObjectDetectionSubsystem, Provider>
Descriptor for the XRSemanticsSubsystem.
XRPersistentAnchorConfigurationXRPersistentAnchorConfiguration
Configuration for PersistentAnchorSubsystem.
XRPersistentAnchorSubsystemTrackingSubsystem<XRPersistentAnchor, XRPersistentAnchorSubsystem, XRPersistentAnchorSubsystemDescriptor, Provider>
Base class for a persistent anchor subsystem.
XRPersistentAnchorSubsystemDescriptorSubsystemDescriptorWithProvider<XRPersistentAnchorSubsystem, Provider>
Descriptor for the XRPersistentAnchorSubsystem.
XRScanningConfigurationXRScanningConfiguration
Configuration for scanning.
XRScanningSubsystemSubsystemWithProvider<XRScanningSubsystem, XRScanningSubsystemDescriptor, Provider>
Defines an interface for interacting with scanning functionality.
XRScanningSubsystemDescriptorSubsystemDescriptorWithProvider<XRScanningSubsystem, Provider>
-
XRSemanticsSubsystemSubsystemWithProvider<XRSemanticsSubsystem, XRSemanticsSubsystemDescriptor, Provider>, ISubsystemWithModelMetadata
Defines an interface for interacting with semantic segmentation functionality.
XRSemanticsSubsystemDescriptorSubsystemDescriptorWithProvider<XRSemanticsSubsystem, Provider>
Descriptor for the XRSemanticsSubsystem.
XRVps2SubsystemTrackingSubsystem<XRPersistentAnchor, XRVps2Subsystem, XRVps2SubsystemDescriptor, Provider>
-
XRVps2SubsystemDescriptorSubsystemDescriptorWithProvider<XRVps2Subsystem, Provider>
Descriptor for the XRVps2Subsystem.
XRWorldPositioningSubsystemSubsystemWithProvider<XRWorldPositioningSubsystem, XRWorldPositioningSubsystemDescriptor, Provider>
Defines an interface for interacting with World Space functionality.
XRWorldPositioningSubsystemDescriptorSubsystemDescriptorWithProvider<XRWorldPositioningSubsystem, Provider>
Descriptor for the XRWorldPositioningSubsystem.

Structs​

NameTypeSummary
CinfoValueType, IEquatable<Cinfo>
Constructor info used to register a descriptor.
CinfoValueType, IEquatable<Cinfo>
Constructor info used to register a descriptor.
XRGeolocationValueType
Structure describing device location and heading.
XRObjectCategorizationValueType
A structure representing an object detection categorization. The object detection algorithm surfaces
at least one categorization per detected object, but usually there are multiple categorizations.
XRObjectDetectionSubsystemCinfoValueType, IEquatable<XRObjectDetectionSubsystemCinfo>
Constructor parameters for the XRObjectDetectionSubsystemDescriptor.
XRPersistentAnchorValueType, ITrackable, IEquatable<XRPersistentAnchor>
Describes session-relative data for an anchor.
XRPersistentAnchorDebugInfoValueType
Contains debug information of XRPersistentAnchorSubsystem
XRPersistentAnchorFrameDiagnosticsValueType
Diagnostic information about frames used for localization
XRPersistentAnchorLocalizationStatusValueType
Reports the result of a localization request.
XRPersistentAnchorNetworkRequestStatusValueType
Diagnostic information about a persistent anchor network request
XRPersistentAnchorPayloadValueType, IEquatable<XRPersistentAnchorPayload>
Represents the payload for a persistent anchor.
XRScanningVoxelDataValueType, IEquatable<XRScanningVoxelData>
Contains a native voxel buffers for positions and colors.
XRSemanticsSubsystemCinfoValueType, IEquatable<XRSemanticsSubsystemCinfo>
Constructor parameters for the XRSemanticsSubsystemDescriptor.
XRVps2GeolocationValueType
Structure describing device location and heading as calculated by VPS2.
XRVps2NetworkRequestRecordValueType
Diagnostic information about a VPS2 network request.
XRVps2PoseValueType
Structure describing device location in local AR coordinate space as
calculated by VPS2.
XRVps2SubsystemCinfoValueType, IEquatable<XRVps2SubsystemCinfo>
Constructor parameters for the XRVps2SubsystemDescriptor.
XRVps2TransformerValueType, IEquatable<XRVps2Transformer>
Struct containing the metadata required to perform bidirectional conversions between the application's kicak
AR tracking space and the global coordinate system (lat/lng/alt/heading).
XRWorldPositioningSubsystemCinfoValueType, IEquatable<XRWorldPositioningSubsystemCinfo>
Constructor parameters for the XRWorldPositioningSubsystemDescriptor.

Enums​

NameTypeSummary
DiagnosticLabeluint
Labels that describe possible issues with frame
ErrorCodeuint
Reports the error code of a localization network request, if any
LocalizationStatusbyte
Reports the status of a localization request (may contain multiple client -> server requests)
A limited localization means that localization returned a value, but there
is not enough confidence to provide a meaningful pose.
RequestStatusbyte
Reports the status of a localization network request (single client -> server request).
RequestTypebyte
Type of localization network request.
TrackingStateReasonuint
Provides further information about the tracking state of an anchor.
Query this if the anchor's tracking state is NotTracking
Vps2NetworkRequestTypeVps2NetworkRequestType
-
Vps2TrackingStateVps2TrackingState
-
WorldPositioningStatusWorldPositioningStatus
The WorldPositioningStatus represents the status of the AR to world transform. The transform
should only be used when the status is Available.
XRScanningStateXRScanningState
-
ON THIS PAGE