Namespace UnityEngine.XR.ARFoundation | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Namespace UnityEngine.XR.ARFoundation

    Classes

    ARBackgroundRendererAsset

    ARCameraBackground

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

    ARCameraOptions

    Add this component to a Camera to set configuration options for the physical camera used by an AR device.

    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.

    ARFoundationBackgroundRenderer

    Uses command buffers to blit an image to a camera's background.

    ARPlane

    Represents a plane detected by an AR device.

    ARPlaneManager

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

    ARPlaneMeshGenerators

    Generator functions for ARPlane mesh geometery.

    ARPlaneMeshVisualizer

    Generates a mesh for an ARPlane.

    ARPointCloud

    Represents a detected point cloud, aka feature points.

    ARPointCloudManager

    Creates and updates a GameObject under the ARSessionOrigin's TrackablesParent to represent a point cloud.

    When enabled, this component subscribes to pointCloudUpdated event. If this component is disabled, and there are no other subscribers to that event, point clouds will be disabled.

    ARPointCloudMeshVisualizer

    Renders an ARPointCloud as a Mesh with MeshTopology.Points.

    ARPointCloudParticleVisualizer

    Renders an ARPointCloud as a ParticleSystem.

    ARReferencePoint

    Represents a Reference Point (aka anchor) tracked by an AR device.

    ARReferencePointManager

    Manages reference points (aka anchors).

    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.

    ARSubsystemManager

    Manages the lifecycle of multiple XR Subsystems specific to AR.

    ARSubsystemUtil

    A collection of utilities for working with the AR-related Subsystems.

    PoseExtensions

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

    TransformExtensions

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

    Structs

    ARCameraFrameEventArgs

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

    ARFaceAddedEventArgs

    Holds data relevant to face added events.

    ARFaceRemovedEventArgs

    Holds data relevant to face removed events.

    ARFaceUpdatedEventArgs

    Holds data relevant to face updated events.

    ARPlaneAddedEventArgs

    Holds data relevant to plane added events.

    ARPlaneBoundaryChangedEventArgs

    Data associated with an boundaryChanged event.

    ARPlaneRemovedEventArgs

    Holds data relevant to plane removed events.

    ARPlaneUpdatedEventArgs

    Holds data relevant to plane updated events.

    ARPointCloudUpdatedEventArgs

    Arguments for the pointCloudUpdated event.

    ARRaycastHit

    Represents the result of a raycast intersection with a trackable.

    ARReferencePointUpdatedEventArgs

    Holds data relevant to reference point updated events.

    ARSystemStateChangedEventArgs

    Container for SystemState event arguments. Used by the ARSubsystemManager.

    LightEstimationData

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

    Enums

    ARRenderMode

    AR rendering modes used with ARFoundationBackgroundRenderer.

    ARSystemState

    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