Skip to content
Matthieu Bucchianeri edited this page Jul 30, 2023 · 4 revisions

Introduction

This project is a generic OpenXR API layer template for Windows applications that can be customized easily.

More about OpenXR and the OpenXR Loader.

Some example applications built using the template:

Compatibility

The API layer template aims at compatibility with all applications and devices, however in its early stages, it has only undergone so much testing. Here are some key compatibility points:

What? Supported? Tested?
Windows Mixed Reality OpenXR runtime Yes Yes
Oculus OpenXR runtime Yes Yes
Varjo OpenXR runtime Yes Yes
PimaxXR OpenXR runtime Yes Yes
SteamVR OpenXR runtime Yes Yes
HTC Vive Cosmos/Focus OpenXR runtime Yes Yes
Direct3D 11 applications Yes Yes
Direct3D 12 applications Yes Yes
Vulkan applications Coming soon
OpenGL applications Not planned

Testing involved the following applications: Bonelab, Digital Combat Simulator, Hubris, iRacing, Microsoft Flight Simulator 2020 and War Thunder.

Found a bug? Please file an issue.

Tutorials

Tutorial 1: Your first OpenXR API layer

Tutorial 2: Your first in-VR overlay

Tutorial 3: Adding motion controller inputs to your overlay

Tutorial 4: Capturing a desktop window in your overlay

Advanced Tutorial 5: Altering the graphics submitted by the application

Advanced Tutorial 6: Drawing in 3D on top of the application

Advanced Tutorial 7: Altering the tracking data and inputs from the platform

Advanced Tutorial 8: Implementing an OpenXR extension

HELP WANTED: Tutorial on using ImGUI (or similar D3D-compatible framework) to make a beautiful overlay with the framework!