docs.unity3d.com
    Show / Hide Table of Contents

    AR Foundation Debug menu

    You can add the AR Foundation Debug menu to an AR scene to add a menu of tracking information and available configurations. When that scene is active on a target device, you can use the menu to view the following information:

    • Stats Info
      • FPS
      • Tracking Mode
    • Session Configurations
    • Debug Options
      • XR Origin
      • Planes
      • Anchors
      • Point Clouds

    The AR Debug menu works with any scene that contains an ARSession, an XROrigin, and a Camera.

    The Debug menu is a Prefab object containing the ARDebugMenu script and a set of GameObjects and components that provide the UI. See Setting up the menu for instructions to add the Debug menu to a scene.

    Setting up the menu

    To create an out-of-the-box fully configured debug menu, right-click anywhere in the Hierarchy window and select XR > AR Debug Menu.

    Right-click in the Hierarchy window Select XR
    Right-click in the Hierarchy window to display a menu of GameObject creation options Select XR > AR Debug Menu

    The AR Debug menu appears as a toolbar that is anchored either to the left or bottom side of the screen.

    Features

    Stats Info

    The Stats Info tab provides general information about a session, including current FPS and TrackingMode.

    Stats Info tab
    Stats Info tab

    Session Configurations

    The Session Configurations tab displays all the available session Configurations for a specific platform and highlights the currently active configuration.

    Session Configurations tab
    Session Configurations tab

    Debug Options

    The Debug Options tab allows the user to toggle visualizers for various ARTrackables in the scene.

    Debug Options tab
    Debug Options tab

    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