Direct Preview lets you test and iterate on complex interactions directly inside the Godot Editor using live data from the Android XR Device. With Direct Preview, the host machine renders and debugs the content, streams the visual viewport directly to your physical Android XR device, and streams supported OpenXR extensions back to the host in real time.
Follow this guide to set up Direct Preview for your project in Godot.
Prerequisites
Before beginning, ensure your development environment meets the following requirements:
- Godot version: Godot 4.6.2 or higher.
Project setup: Complete all steps in the Godot Engine project setup guide.
Completing these steps also provides you with the required version of the Godot OpenXR Vendors Plugin, which enables support for Android XR specific extensions.
- Android XR Engine Hub: Complete all the steps in the get started section of the Android XR Engine Hub guide to install and configure your host machine for Direct Preview.
Hardware:
- Use a host machine running Windows 11.
- Use a modern graphics card with Vulkan Video Encoding support.
Configure your editor settings
Select the active OpenXR runtime specifically for the editor session:
- Open your project in Godot.
- Navigate to Editor Settings.
- Locate the XR section.
In the OpenXR drop-down (or Runtimes list), select AndroidXR Streaming Runtime.
Start Direct Preview
Start Direct Preview to stream directly from Godot:
Connect your Android XR device to your host machine using a high-quality USB-C cable.
If you've never used this device with Direct Preview before, connect and configure the device for Direct Preview in the Android XR Engine Hub before you start Direct Preview through your game engine.
In the Godot Editor, click Play or press
F5.The Godot Game window on your host machine mirrors the view, and the headset displays the VR content.