Skip to content
Matthieu Bucchianeri edited this page Jan 22, 2024 · 20 revisions

OpenXR Eye Trackers

This software enables the use of eye trackers in HP Reverb G2 Omnicept, Meta Quest Pro, Varjo Aero and Pimax Crystal by OpenXR applications, via the XR_EXT_eye_gaze_interaction extension.

A couple of examples of applications relying on OpenXR eye gaze interaction support and that can now be enabled on many headsets with OpenXR-Eye-Trackers:

DISCLAIMER: This software is distributed as-is, without any warranties or conditions of any kind. Use at your own risks.

Table of Contents
  1. Compatibility
  2. Setup
  3. Troubleshooting
  4. Donate

Compatibility

Before installing, carefully the tables below to understand if your headset is supported and whether you need OpenXR-Eye-Trackers for the eye tracker to work:

Headset OpenXR runtime Supported by?
Meta Quest Pro Oculus OpenXR-Eye-Trackers
Meta Quest Pro VirtualDesktopXR (VDXR) VDXR - No need for OpenXR-Eye-Trackers
Meta Quest Pro SteamVR (Virtual Desktop) OpenXR-Eye-Trackers
Meta Quest Pro SteamVR (Steam Link) OpenXR-Eye-Trackers
Meta Quest Pro SteamVR (Oculus Link) Not supported [1]
Pimax Crystal PimaxXR PimaxXR - No need for OpenXR-Eye-Trackers
Pimax Crystal SteamVR OpenXR-Eye-Trackers
Pimax 5K/8K w Droolon Pi1 PimaxXR PimaxXR - No need for OpenXR-Eye-Trackers
Pimax 5K/8K w Droolon Pi1 SteamVR Not supported
Varjo Aero/VR-3/XR-3 Varjo Varjo Base - No need for OpenXR-Eye-Trackers
Varjo Aero/VR-3/XR-3 SteamVR OpenXR-Eye-Trackers
HP Reverb G2 Omnicept Windows Mixed Reality OpenXR-Eye-Trackers
HP Reverb G2 Omnicept SteamVR OpenXR-Eye-Trackers
Vive Pro Eye SteamVR VIVE Console - No need for OpenXR-Eye-Trackers [4]
Pico Neo Pro SteamVR (Streaming Assistant) Not supported [2]
Pico Neo Pro SteamVR (Virtual Desktop) Not supported [3]

[1] Support in SteamVR for Oculus would require Oculus to provide a public OVR API to retrieve eye tracking data, which they currently do not offer.

[2] Support in SteamVR for Pico with Streaming Assistant would require Pico to provide a public API to retrieve eye tracking data, which they currently do not offer.

[3] Support with Virtual Desktop for Pico is planned according to Guy Godin but blocked on Pico providing support on the device.

[4] A robust alternative to the VIVE Console eye tracking support is DragonDreams's OpenXR Layer VIVE SDK.

Setup

Download & installation

PLEASE DO NOT HOTLINK TO THE DOWNLOAD LINK BELOW - INSTEAD LINK TO THIS PAGE THAT COMES WITH BOTH THE DOWNLOAD LINK AND ALL THE NECESSARY INSTRUCTIONS! THANK YOU

YOU MUST COMPLETE ALL THE STEPS BELOW - IN ADDITION TO INSTALLING THE TOOL, YOU MUST FOLLOW THE INSTRUCTIONS SPECIFIC TO YOUR HEADSET

Quick download link: OpenXR-Eye-Trackers-1.2.0.msi

Download the latest version from the Releases page. Find the installer program under Assets, file OpenXR-Eye-Trackers-<version>.msi.

You might need to install the latest Visual C++ Redistributable.

Run the installer and follow the instructions to complete the installation.

Follow the additional steps specific to your headset in order to enable eye tracking (when applicable):

Removal

You can use 'Add or remove programs' (available from the Start Menu) and uninstall 'OpenXR-Eye-Trackers' from there.

image

Troubleshooting

You can use the 'OpenXR Eye Trackers Test Application' from 'Start Menu' in order to test the functionality of your eye trackers.

image

The log file can be found at %LocalAppData%\OpenXR-Eye-Trackers\OpenXR-Eye-Trackers.log. Please review the log file for error messages that may clue about the issue.

You may file an issue to report a problem or ask a question.

IF YOU DON'T INCLUDE YOUR LOG FILE AND A CLEAR EXPLANATION OF YOUR ISSUE, YOUR MESSAGE WILL BE IGNORED.

Special thanks

Thanks to my beta testers for helping throughout development and release (in alphabetical order):

Donate

Donations are welcome and totally optional. Please use my GitHub sponsorship page to make one-time or recurring donations!

Thank you!