docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class ARCoreLoader

    Manages the lifecycle of ARCore subsystems.

    Inheritance
    object
    Object
    ScriptableObject
    XRLoader
    XRLoaderHelper
    ARCoreLoader
    Implements
    IXRLoaderPreInit
    Inherited Members
    XRLoaderHelper.m_SubsystemInstanceMap
    XRLoaderHelper.GetLoadedSubsystem<T>()
    XRLoaderHelper.StartSubsystem<T>()
    XRLoaderHelper.StopSubsystem<T>()
    XRLoaderHelper.DestroySubsystem<T>()
    XRLoaderHelper.CreateSubsystem<TDescriptor, TSubsystem>(List<TDescriptor>, string)
    XRLoaderHelper.CreateIntegratedSubsystem<TDescriptor, TSubsystem>(List<TDescriptor>, string)
    XRLoaderHelper.CreateStandaloneSubsystem<TDescriptor, TSubsystem>(List<TDescriptor>, string)
    XRLoaderHelper.WasAssignedToBuildTarget(BuildTargetGroup)
    XRLoaderHelper.WasUnassignedFromBuildTarget(BuildTargetGroup)
    XRLoader.GetSupportedGraphicsDeviceTypes(bool)
    ScriptableObject.SetDirty()
    ScriptableObject.CreateInstance(string)
    ScriptableObject.CreateInstance(Type)
    ScriptableObject.CreateInstance<T>()
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.InstantiateAsync<T>(T)
    Object.InstantiateAsync<T>(T, Transform)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int)
    Object.InstantiateAsync<T>(T, int, Transform)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)
    Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Scene)
    Object.Instantiate<T>(T, InstantiateParameters)
    Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    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 true.

    Overrides
    XRLoaderHelper.Deinitialize()

    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

    True if the session subsystem was successfully created, otherwise false.

    Overrides
    XRLoader.Initialize()

    Start()

    Starts all subsystems.

    Declaration
    public override bool Start()
    Returns
    Type Description
    bool

    True if the subsystems were started, otherwise false.

    Overrides
    XRLoader.Start()

    Stop()

    Stops all subsystems.

    Declaration
    public override bool Stop()
    Returns
    Type Description
    bool

    True if the subsystems were stopped, otherwise false.

    Overrides
    XRLoader.Stop()

    Implements

    IXRLoaderPreInit
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)