docs.unity3d.com
    Show / Hide Table of Contents

    Class ARCoreLoader

    Manages the lifecycle of ARCore subsystems.

    Inheritance
    Object
    XRLoader
    XRLoaderHelper
    ARCoreLoader
    Inherited Members
    XRLoaderHelper.m_SubsystemInstanceMap
    XRLoaderHelper.GetLoadedSubsystem<T>()
    XRLoaderHelper.StartSubsystem<T>()
    XRLoaderHelper.StopSubsystem<T>()
    XRLoaderHelper.DestroySubsystem<T>()
    UnityEngine.XR.Management.XRLoaderHelper.CreateSubsystem<TDescriptor, TSubsystem>(System.Collections.Generic.List<TDescriptor>, System.String)
    UnityEngine.XR.Management.XRLoaderHelper.CreateIntegratedSubsystem<TDescriptor, TSubsystem>(System.Collections.Generic.List<TDescriptor>, System.String)
    UnityEngine.XR.Management.XRLoaderHelper.CreateStandaloneSubsystem<TDescriptor, TSubsystem>(System.Collections.Generic.List<TDescriptor>, System.String)
    UnityEngine.XR.Management.XRLoaderHelper.WasAssignedToBuildTarget(UnityEditor.BuildTargetGroup)
    UnityEngine.XR.Management.XRLoaderHelper.WasUnassignedFromBuildTarget(UnityEditor.BuildTargetGroup)
    XRLoader.GetSupportedGraphicsDeviceTypes(Boolean)
    Namespace: UnityEngine.XR.ARCore
    Syntax
    public class ARCoreLoader : XRLoaderHelper

    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
    UnityEngine.XR.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
    Boolean

    Always returns true.

    Overrides
    XRLoaderHelper.Deinitialize()

    Initialize()

    Initializes the loader.

    Declaration
    public override bool Initialize()
    Returns
    Type Description
    Boolean

    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
    Boolean

    True if the subsystems were started, otherwise false.

    Overrides
    XRLoader.Start()

    Stop()

    Stops all subsystems.

    Declaration
    public override bool Stop()
    Returns
    Type Description
    Boolean

    True if the subsystems were stopped, otherwise false.

    Overrides
    XRLoader.Stop()
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023