Class ARDebugMenu
Menu that is added to a scene to surface tracking data and visualize trackables in order to aid in debugging.
Inherited Members
Namespace: UnityEngine.XR.ARFoundation
Assembly: Unity.XR.ARFoundation.dll
Syntax
[RequireComponent(typeof(Canvas))]
public class ARDebugMenu : MonoBehaviourProperties
anchorPrefab
Specifies a debug prefab that will be attached to an ARAnchor.
Declaration
public GameObject anchorPrefab { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject | A debug prefab that will be attached to the AR anchors in a scene. |
cameraConfigurationDropdown
The dropdown that will display the list of currently available camera configurations.
Declaration
public Dropdown cameraConfigurationDropdown { get; set; }Property Value
| Type | Description |
|---|---|
| Dropdown | A dropdown that will display the list of currently available camera configurations. |
cameraConfigurationMenu
The menu that displays available XRCameraConfigurations for the current session configuration.
Declaration
public GameObject cameraConfigurationMenu { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject | A menu that will be used to display available camera configurations for the current session configuration. |
cameraDepthSensorLabel
The label that will display whether depth sensor is supported in the current camera configuration.
Declaration
public Text cameraDepthSensorLabel { get; set; }Property Value
| Type | Description |
|---|---|
| Text | A label that will display whether depth sensor is supported in the current camera configuration. |
cameraFrameRateLabel
The label that will display the frame rate of the current camera configuration.
Declaration
public Text cameraFrameRateLabel { get; set; }Property Value
| Type | Description |
|---|---|
| Text | A label that will display the frame rate of the current camera configuration. |
cameraResolutionLabel
The label that will display the resolution of the current camera configuration.
Declaration
public Text cameraResolutionLabel { get; set; }Property Value
| Type | Description |
|---|---|
| Text | A label that will display the resolution of the current camera configuration. |
checkMarkTexture
The checkmark texture that will be used in the Configuration submenu to display available configurations.
Declaration
public Texture2D checkMarkTexture { get; set; }Property Value
| Type | Description |
|---|---|
| Texture2D | A checkmark texture that will be used in the configuration submenu to display available configurations. |
configurationMenu
The menu that displays available Configurations for the current platform.
Declaration
public GameObject configurationMenu { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject | A menu that will be used to display available session configurations for the current platform. |
configurationMenuRoot
The root of the menu that displays available Configurations for the current platform. This helps center the data in the generated menu.
Declaration
public GameObject configurationMenuRoot { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject | The root of the menu where the available configurations for the current platform will be displayed and anchored. |
debugMenuRenderMode
The render mode of the debug menu's canvas.
Declaration
public ARDebugMenu.DebugMenuRenderMode debugMenuRenderMode { get; set; }Property Value
| Type | Description |
|---|---|
| ARDebugMenu.DebugMenuRenderMode | The render mode can either be in world space, screen space or in an automated mode that sets mobile platforms to screen space and non-mobile platforms to worldspace. |
debugOptionsMenu
The menu that provides buttons for visualizing different trackables for debugging purposes.
Declaration
public GameObject debugOptionsMenu { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject | A menu that will be used to display different trackables for debugging purposes. |
debugOptionsToastMenu
The menu that displays informative warning messages.
Declaration
public GameObject debugOptionsToastMenu { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject | A menu that displays an informative warning messages. |
displayCameraConfigurationsMenuButton
The button that displays the AR Debug Menu's camera configuration sub-menu.
Declaration
public Button displayCameraConfigurationsMenuButton { get; set; }Property Value
| Type | Description |
|---|---|
| Button | A button that will be used to display the AR Debug Menu's camera configuration sub-menu. |
displayConfigurationsMenuButton
The button that displays the AR Debug Menu's session configuration sub-menu.
Declaration
public Button displayConfigurationsMenuButton { get; set; }Property Value
| Type | Description |
|---|---|
| Button | A button that will be used to display the AR Debug Menu's session configuration sub-menu. |
displayDebugOptionsMenuButton
The button that displays the AR Debug Menu's debug options sub-menu.
Declaration
public Button displayDebugOptionsMenuButton { get; set; }Property Value
| Type | Description |
|---|---|
| Button | A button that will be used to display the AR Debug Menu's debug options sub-menu. |
displayInfoMenuButton
The button that displays the AR Debug Menu's info sub-menu.
Declaration
public Button displayInfoMenuButton { get; set; }Property Value
| Type | Description |
|---|---|
| Button | A button that will be used to display the AR Debug Menu's info sub-menu. |
fpsLabel
The text object that will display current FPS.
Declaration
public Text fpsLabel { get; set; }Property Value
| Type | Description |
|---|---|
| Text | A text object that will display current FPS. |
infoMenu
The menu that contains debug info such as current FPS and tracking state.
Declaration
public GameObject infoMenu { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject | A menu that will be used to display debug info such as current FPS and tracking state. |
lineRendererPrefab
Specifies the line renderer that will be used to outline planes in the scene.
Declaration
public LineRenderer lineRendererPrefab { get; set; }Property Value
| Type | Description |
|---|---|
| LineRenderer | A line renderer used to outline planes in the scene. |
menuFont
The font that will be used for the generated parts of the menu.
Declaration
public Font menuFont { get; set; }Property Value
| Type | Description |
|---|---|
| Font | A font that will be used for the generated parts of the menu. |
originAxisPrefab
Specifies a debug prefab that will be attached to the Unity.XR.CoreUtils.XROrigin.
Declaration
public GameObject originAxisPrefab { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject | A debug prefab that will be attached to the XR origin. |
pointCloudParticleSystem
Specifies a particle system to visualize an ARPointCloud.
Declaration
public ParticleSystem pointCloudParticleSystem { get; set; }Property Value
| Type | Description |
|---|---|
| ParticleSystem | A particle system that will visualize point clouds. |
showAnchorsButton
The button that displays anchors in the scene.
Declaration
public DebugSlider showAnchorsButton { get; set; }Property Value
| Type | Description |
|---|---|
| DebugSlider | A button that will be used to display anchors in the scene. |
showOriginButton
The button that displays the XR origin prefab.
Declaration
public DebugSlider showOriginButton { get; set; }Property Value
| Type | Description |
|---|---|
| DebugSlider | A button that will be used to display the XR origin prefab. |
showPlanesButton
The button that displays detected AR planes in the scene.
Declaration
public DebugSlider showPlanesButton { get; set; }Property Value
| Type | Description |
|---|---|
| DebugSlider | A button that will be used to display detected AR planes in the scene. |
showPointCloudsButton
The button that displays detected point clouds in the scene.
Declaration
public DebugSlider showPointCloudsButton { get; set; }Property Value
| Type | Description |
|---|---|
| DebugSlider | A button that will be used to display detected point clouds in the scene. |
toolbar
The side bar that contains the buttons to the status info, configurations, and debug options menus.
Declaration
public GameObject toolbar { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject | A side bar that contains the buttons to the status info, configurations, and debug options menus. |
trackingModeLabel
The text object that will display current tracking mode.
Declaration
public Text trackingModeLabel { get; set; }Property Value
| Type | Description |
|---|---|
| Text | A text object that will display current tracking mode. |