docs.unity3d.com
    Show / Hide Table of Contents

    Class ARKitLoader

    Manages the lifecycle of ARKit subsystems.

    Inheritance
    Object
    XRLoader
    XRLoaderHelper
    ARKitLoader
    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.ARKit
    Syntax
    public class ARKitLoader : XRLoaderHelper

    Properties

    anchorSubsystem

    The XRAnchorSubsystem whose lifecycle is managed by this loader.

    Declaration
    public XRAnchorSubsystem anchorSubsystem { get; }
    Property Value
    Type Description
    XRAnchorSubsystem

    cameraSubsystem

    The XRCameraSubsystem whose lifecycle is managed by this loader.

    Declaration
    public XRCameraSubsystem cameraSubsystem { get; }
    Property Value
    Type Description
    XRCameraSubsystem

    depthSubsystem

    The XRDepthSubsystem whose lifecycle is managed by this loader.

    Declaration
    public XRDepthSubsystem depthSubsystem { get; }
    Property Value
    Type Description
    XRDepthSubsystem

    environmentProbeSubsystem

    The XREnvironmentProbeSubsystem whose lifecycle is managed by this loader.

    Declaration
    public XREnvironmentProbeSubsystem environmentProbeSubsystem { get; }
    Property Value
    Type Description
    XREnvironmentProbeSubsystem

    faceSubsystem

    The XRFaceSubsystem whose lifecycle is managed by this loader.

    Declaration
    public XRFaceSubsystem faceSubsystem { get; }
    Property Value
    Type Description
    XRFaceSubsystem

    humanBodySubsystem

    The XRHumanBodySubsystem whose lifecycle is managed by this loader.

    Declaration
    public XRHumanBodySubsystem humanBodySubsystem { get; }
    Property Value
    Type Description
    XRHumanBodySubsystem

    imageTrackingSubsystem

    The XRImageTrackingSubsystem whose lifecycle is managed by this loader.

    Declaration
    public XRImageTrackingSubsystem imageTrackingSubsystem { get; }
    Property Value
    Type Description
    XRImageTrackingSubsystem

    inputSubsystem

    The XRInputSubsystem whose lifecycle is managed by this loader.

    Declaration
    public XRInputSubsystem inputSubsystem { get; }
    Property Value
    Type Description
    XRInputSubsystem

    meshSubsystem

    The XRMeshSubsystem whose lifecycle is managed by this loader.

    Declaration
    public XRMeshSubsystem meshSubsystem { get; }
    Property Value
    Type Description
    XRMeshSubsystem

    objectTrackingSubsystem

    The XRObjectTrackingSubsystem whose lifecycle is managed by this loader.

    Declaration
    public XRObjectTrackingSubsystem objectTrackingSubsystem { get; }
    Property Value
    Type Description
    XRObjectTrackingSubsystem

    occlusionSubsystem

    The XROcclusionSubsystem whose lifecycle is managed by this loader.

    Declaration
    public XROcclusionSubsystem occlusionSubsystem { get; }
    Property Value
    Type Description
    XROcclusionSubsystem

    participantSubsystem

    The XRParticipantSubsystem whose lifecycle is managed by this loader.

    Declaration
    public XRParticipantSubsystem participantSubsystem { get; }
    Property Value
    Type Description
    XRParticipantSubsystem

    planeSubsystem

    The XRPlaneSubsystem whose lifecycle is managed by this loader.

    Declaration
    public XRPlaneSubsystem planeSubsystem { get; }
    Property Value
    Type Description
    XRPlaneSubsystem

    raycastSubsystem

    The XRRaycastSubsystem whose lifecycle is managed by this loader.

    Declaration
    public XRRaycastSubsystem raycastSubsystem { get; }
    Property Value
    Type Description
    XRRaycastSubsystem

    sessionSubsystem

    The XRSessionSubsystem whose lifecycle is managed by this loader.

    Declaration
    public XRSessionSubsystem sessionSubsystem { get; }
    Property Value
    Type Description
    XRSessionSubsystem

    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()

    This method does nothing. Subsystems must be started individually.

    Declaration
    public override bool Start()
    Returns
    Type Description
    Boolean

    Returns true on iOS. Returns false otherwise.

    Overrides
    XRLoader.Start()

    Stop()

    This method does nothing. Subsystems must be stopped individually.

    Declaration
    public override bool Stop()
    Returns
    Type Description
    Boolean

    Returns true on iOS. Returns false otherwise.

    Overrides
    XRLoader.Stop()
    Back to top
    Terms of use
    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