Class ARCoreLoader
Manages the lifecycle of ARCore subsystems.
Implements
Inherited Members
Namespace: UnityEngine.XR.ARCore
Assembly: Unity.XR.ARCore.dll
Syntax
public class ARCoreLoader : XRLoaderHelper, IXRLoaderPreInit
Properties
anchorSubsystem
The XRAnchorSubsystem
whose lifecycle is managed by this loader.
Declaration
public XRAnchorSubsystem anchorSubsystem { get; }
Property Value
Type | Description |
---|---|
XRAnchorSubsystem | The XR anchor subsystem instance. |
cameraSubsystem
The XRCameraSubsystem
whose lifecycle is managed by this loader.
Declaration
public XRCameraSubsystem cameraSubsystem { get; }
Property Value
Type | Description |
---|---|
XRCameraSubsystem | The camera subsystem instance. |
depthSubsystem
The XRDepthSubsystem whose lifecycle is managed by this loader. This field is obsolete. Use pointCloudSubsystem instead.
Declaration
[Obsolete("Use pointCloudSubsystem instead. (2022-02-03)")]
public XRDepthSubsystem depthSubsystem { get; }
Property Value
Type | Description |
---|---|
XRDepthSubsystem | The XR point cloud subsystem instance. |
environmentProbeSubsystem
The XREnvironmentProbeSubsystem
whose lifecycle is managed by this loader.
Declaration
public XREnvironmentProbeSubsystem environmentProbeSubsystem { get; }
Property Value
Type | Description |
---|---|
XREnvironmentProbeSubsystem | The XR environment probe subsystem instance. |
faceSubsystem
The XRFaceSubsystem
whose lifecycle is managed by this loader.
Declaration
public XRFaceSubsystem faceSubsystem { get; }
Property Value
Type | Description |
---|---|
XRFaceSubsystem | The XR face subsystem instance. |
imageTrackingSubsystem
The XRImageTrackingSubsystem
whose lifecycle is managed by this loader.
Declaration
public XRImageTrackingSubsystem imageTrackingSubsystem { get; }
Property Value
Type | Description |
---|---|
XRImageTrackingSubsystem | The XR image tracking subsystem instance. |
inputSubsystem
The XRInputSubsystem
whose lifecycle is managed by this loader.
Declaration
public XRInputSubsystem inputSubsystem { get; }
Property Value
Type | Description |
---|---|
XRInputSubsystem | The XR input subsystem instance. |
occlusionSubsystem
The XROcclusionSubsystem
whose lifecycle is managed by this loader.
Declaration
public XROcclusionSubsystem occlusionSubsystem { get; }
Property Value
Type | Description |
---|---|
XROcclusionSubsystem | The XR occlusion subsystem instance. |
planeSubsystem
The XRPlaneSubsystem
whose lifecycle is managed by this loader.
Declaration
public XRPlaneSubsystem planeSubsystem { get; }
Property Value
Type | Description |
---|---|
XRPlaneSubsystem | The XR plane subsystem instance. |
pointCloudSubsystem
The XRPointCloudSubsystem
whose lifecycle is managed by this loader.
Declaration
public XRPointCloudSubsystem pointCloudSubsystem { get; }
Property Value
Type | Description |
---|---|
XRPointCloudSubsystem | The XR point cloud subsystem instance. |
raycastSubsystem
The XRRaycastSubsystem
whose lifecycle is managed by this loader.
Declaration
public XRRaycastSubsystem raycastSubsystem { get; }
Property Value
Type | Description |
---|---|
XRRaycastSubsystem | The XR raycast subsystem instance. |
sessionSubsystem
The XRSessionSubsystem
whose lifecycle is managed by this loader.
Declaration
public XRSessionSubsystem sessionSubsystem { get; }
Property Value
Type | Description |
---|---|
XRSessionSubsystem | The session subsystem instance. |
Methods
Deinitialize()
Destroys each subsystem.
Declaration
public override bool Deinitialize()
Returns
Type | Description |
---|---|
bool | Always returns |
Overrides
GetPreInitLibraryName(BuildTarget, BuildTargetGroup)
Register the plug-in library to load during XR pre-initialization. This executes XRSDKPreInit
callback defined in the plug-in library.
Declaration
public string GetPreInitLibraryName(BuildTarget buildTarget, BuildTargetGroup buildTargetGroup)
Parameters
Type | Name | Description |
---|---|---|
BuildTarget | buildTarget | An enum specifying which platform this build is for. |
BuildTargetGroup | buildTargetGroup | An enum specifying which platform group this build is for. |
Returns
Type | Description |
---|---|
string | The name of the library which need to be loaded during XR pre-initialization. |
Initialize()
Initializes the loader.
Declaration
public override bool Initialize()
Returns
Type | Description |
---|---|
bool |
|
Overrides
Start()
Starts all subsystems.
Declaration
public override bool Start()
Returns
Type | Description |
---|---|
bool |
|
Overrides
Stop()
Stops all subsystems.
Declaration
public override bool Stop()
Returns
Type | Description |
---|---|
bool |
|