Hands Debug Overlay

1. Before you add the overlay, confirm that your project meets these requirements:
   • The project uses the Unity OpenXR Plugin (com.unity.xr.openxr). The overlay scripts compile only when this package is installed.
   • The project uses Unity XR Hands (com.unity.xr.hands) for hand tracking and pinch data. The latest Meta XR Core SDK already includes this dependency.
   • The project uses Unity OpenXR Plugin 1.17.0 or later for microgesture data.
   • The OpenXR settings enable Hand Tracking Subsystem, Meta Hand Tracking Aim, and Meta Hand Microgestures as features. The OpenXR settings enable Hand Interaction Profile as an interaction profile.
   • The scene has a camera tagged MainCamera.
   For Unity XR project setup, see Use Interaction SDK with Unity XR.
2. In the Project panel, go to Packages > Meta XR Interaction SDK Essentials > Runtime > UnityXR > Prefabs > DebugInputView.
   
3. Drag the HandsDebugOverlay prefab into the Hierarchy.
   
4. Press Play. The left and right panels appear in front of the camera in the Game view or on the device.

1. Open Project Settings > XR Plug-in Management > OpenXR for each build target you play or build on.
2. Enable Hand Tracking Subsystem, Meta Hand Tracking Aim, and Meta Hand Microgestures as features. Enable Hand Interaction Profile as an interaction profile.
   
3. Run the scene again and confirm the warnings no longer appear.

1. In the Hierarchy, select the HandsDebugOverlay GameObject. In the Inspector, find the DebugViewOverlay component.
   
2. Do not change the canvas and material references assigned in the prefab.
3. Under Configuration, adjust these settings:

   Property	Prefab Default	Range	Description
   Scale	0.001	0.0001 to 0.002	World-space scale of the panels.
   Horizontal Offset	0.5	0 to 1.5	Distance between the panels along the head’s right axis.
   Vertical Offset	0	-1 to 1	Offset of the panels along the head’s up axis.
   Opacity	0.8	0 to 1	Opacity of the panels.
   Log To Console	Enabled	n/a	Writes each gesture log entry to the Unity Console.

   Scale, Horizontal Offset, Vertical Offset, and Opacity apply at runtime. The component reads them every frame, so you can change them before or during Play.
4. Set Log To Console before you press Play. Changes to this checkbox after startup do not apply to the gesture logs. To change it at runtime, set the LogToConsole property from a script.
5. Check the two render layer settings before you press Play. The component reads them only at startup:
   • Overlay Render Layer (default: Default) must be a layer that the main camera draws.
   • Canvas Render Layer (default: UI) must be a layer that the main camera does not draw.
   If Canvas Render Layer is set to a layer the main camera draws, the camera draws the world-space canvas directly and the overlay also draws the quad on the overlay layer, so each panel appears twice.

// In initialization code that runs before Start(), pass the canvases, material, and layers:
overlay.InjectAllDebugViewOverlay(leftHandCanvas, rightHandCanvas,
    overlayMaterial, overlayRenderLayer, canvasRenderLayer);

1. Build and run on your device, or press Play in the editor with hand tracking active.
2. Hold your hands where the device can track them. Confirm that the pinch strength values change and that each finger switches between OFF and ON.
3. Pinch with your Index and Middle fingers. Confirm that the gesture log adds Index Pinch Start, Index Pinch End, Middle Pinch Start, and Middle Pinch End entries.
   
4. Perform microgestures and confirm that the log shows the matching swipe or tap entries.
5. If a panel shows a warning, enable the named feature or profile in the OpenXR settings for your target platform, as described in Enable the required OpenXR features and profile. Then run the scene again.

• To draw points, lines, and axes for debugging, see DebugGizmos.
• To set up Interaction SDK in a Unity XR project, see Use Interaction SDK with Unity XR.
• To use the OpenXR hand skeleton, see OpenXR Hand Skeleton in Interaction SDK.