Namespace UnityEngine.XR.ARFoundation | AR Foundation | 3.0.1
docs.unity3d.com
    Show / Hide Table of Contents

    Namespace UnityEngine.XR.ARFoundation

    Classes

    ARAnchor

    Represents an Anchor tracked by an XR device.

    ARAnchorManager

    Manages anchors.

    ARBackgroundRendererFeature

    A render feature for rendering the camera background for AR devies.

    ARCameraBackground

    Add this component to a Camera to copy the color camera's texture onto the background.

    If you are using the Lightweight Render Pipeline (version 5.7.2 or later) or the Univerisal Render Pipeline (version 7.0.0 or later), you must also add the ARBackgroundRendererFeature to the list of render features for the scriptable renderer.

    ARCameraManager

    Manages the lifetime of the XRCameraSubsystem. Add one of these to a Camera in your scene if you want camera texture and light estimation information to be available.

    AREnvironmentProbe

    A game object component to manage the reflection probe settings as the environment probe changes are applied.

    AREnvironmentProbeManager

    This class creates, maintains, and destroys environment probe game object components as the XREnvironmentProbeSubsystem provides updates from environment probes as they are detected in the environment.

    ARFace

    Represents a face detected by an AR device.

    ARFaceManager

    Creates, updates, and removes GameObjects with ARFace components under the ARSessionOrigin's trackablesParent.

    ARFaceMeshVisualizer

    Generates a mesh for an ARFace.

    ARInputManager

    Manages the lifetime of the XRInputSubsystem. Add one of these to any GameObject in your scene if you want device pose information to be available. Read the input by using the TrackedPoseDriver

    ARLightEstimationDataTestFixture

    ARMeshManager

    A manager for triangle meshes generated by an AR device. Creates, updates, and removes GameObjects in response to the environment. For each mesh, a meshPrefab is instantiated which must contain at least a MeshFilter. If the meshPrefab's GameObject also has a MeshCollider, then a physics mesh is generated asynchronously, without blocking the main thread.

    ARParticipant

    Represents a participant (i.e., another device in a collaborative session).

    ARParticipantManager

    A manager for ARParticipants. Creates, updates, and removes GameObjects in response to other users in a multi-user collaborative session.

    ARPlane

    Represents a plane (i.e., a flat surface) detected by an AR device.

    ARPlaneManager

    A manager for ARPlanes. Creates, updates, and removes GameObjects in response to detected surfaces in the physical environment.

    ARPlaneMeshGenerators

    Generator functions for ARPlane mesh geometery.

    ARPlaneMeshVisualizer

    Generates a mesh for an ARPlane.

    ARPointCloud

    Represents a detected point cloud, aka feature points.

    ARPointCloudManager

    A manager for s. Uses the XRDepthSubsystem to recognize and track depth data in the physical environment.

    ARPointCloudMeshVisualizer

    Renders an ARPointCloud as a Mesh with MeshTopology.Points.

    ARPointCloudParticleVisualizer

    Renders an ARPointCloud as a ParticleSystem.

    ARPoseDriver

    The ARPoseDriver component applies the current Pose value of an AR device to the transform of the GameObject.

    ARRaycastManager

    Manages an XRRaycastSubsystem, exposing raycast functionality in ARFoundation. Use this component to raycast against trackables (i.e., detected features in the physical environment) when they do not have a presence in the Physics world.

    ARSession

    Controls the lifecycle and configuration options for an AR session. There is only one active session. If you have multiple ARSession components, they all talk to the same session and will conflict with each other.

    Enabling or disabling the ARSession will start or stop the session, respectively.

    ARSessionOrigin

    An ARSessionOrigin is the parent for an AR setup. It contains a Camera and any GameObjects created from detected features, such as planes or point clouds.

    ARTrackable<TSessionRelativeData, TTrackable>

    A generic component for trackables. A "trackable" is a feature in the physical environment that can be detected and tracked by an XR device.

    ARTrackableManager<TSubsystem, TSubsystemDescriptor, TSessionRelativeData, TTrackable>

    A generic manager for components generated by features detected in the physical environment.

    ARTrackedImage

    Represents a tracked image in the physical environment.

    ARTrackedImageManager

    A manager for ARTrackedImages. Uses the XRImageTrackingSubsystem to recognize and track 2D images in the physical environment.

    ARUpdateOrder

    The update order for MonoBehaviours in ARFoundation.

    MeshQueueTestFixture

    MutableRuntimeReferenceImageLibraryExtensions

    Extension methods for UnityEngine.XR.ARSubsystems.MutableRuntimeReferenceImageLibrary.

    PlaneDetectionModeMaskAttribute

    An attribute that can be placed on MonoBehaviour fields to generate the correct UI for the enum.

    PoseExtensions

    Several method extensions to Pose for inverse-transforming additional Unity types.

    PoseExtensionsTestFixture

    SubsystemLifecycleManager<TSubsystem, TSubsystemDescriptor>

    A base class for subsystems whose lifetime is managed by a MonoBehaviour.

    TransformExtensions

    Several method extensions to Transform for transforming and inverse-transforming additional Unity types.

    Structs

    ARAnchorsChangedEventArgs

    Event arguments for the anchorsChanged event.

    ARCameraFrameEventArgs

    A structure for camera-related information pertaining to a particular frame. This is used to communicate information in the event.

    AREnvironmentProbesChangedEvent

    Event arguments for the environmentProbesChanged event.

    ARFacesChangedEventArgs

    Event arguments for the event.

    ARFaceUpdatedEventArgs

    Holds data relevant to the updated event.

    ARLightEstimationData

    A structure for light estimation information provided by the AR device.

    ARMeshesChangedEventArgs

    Event arguments for the meshesChanged event.

    ARParticipantsChangedEventArgs

    Event arguments for the participantsChanged event.

    ARPlaneBoundaryChangedEventArgs

    Data associated with an boundaryChanged event.

    ARPlanesChangedEventArgs

    Event arguments for the planesChanged event.

    ARPointCloudChangedEventArgs

    Event arguments for the event.

    ARPointCloudUpdatedEventArgs

    The arguments for the updated event. This is currently empty, but may change in the future without the need to change the subscribers' method signatures.

    ARRaycastHit

    Represents the result of a raycast intersection with a trackable.

    ARSessionStateChangedEventArgs

    Container for SystemState event arguments. Used by the .

    ARTrackedImagesChangedEventArgs

    Event arguments for the trackedImagesChanged event.

    TrackableCollection<TTrackable>

    A collection for ARTrackable<TSessionRelativeData, TTrackable>s. This collection implements an IEnumerable-like interface which can be used in a foreach statement.

    TrackableCollection<TTrackable>.Enumerator

    An Enumerator for TTrackables.

    Enums

    AREnvironmentProbePlacementType

    Represents the method used to place an environment probe in the AR session.

    ARSessionState

    Represents the current state of the AR system.

    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