This project serves to demonstrate how you can write your own VR or XR application using OpenXR and Vulkan. These are the OpenXR Vulkan Example's main features:
- Basic rendering of example scene to the headset, and into a resizeable mirror view on your desktop monitor.
- Focus on easy to read and understand C++ without smart pointers, inheritance, templates, etc.
- Warning-free code base spread over a small handful of classes.
- No OpenXR or Vulkan validation errors or warnings.
- CMake project setup for easy building.
Integrating both OpenXR and Vulkan yourself can be a daunting and painfully time-consuming task. Both APIs are very verbose and require the correct handling of many minute details. This is why there are two main use cases where the OpenXR Vulkan Example comes in handy:
- Fork the repository and use it as a starting point, saving yourself weeks of tedious integration work before you get to the juicy bits of VR or XR development.
- Reference the code while writing your own integration, to help you out if you are stuck with a problem, or for inspiration.
- Download the latest release (once available) or build the project yourself with the steps below.
- Make sure your headset is connected to your computer and running or active.
- Run the program!
- Install the Vulkan SDK version 1.3 or newer.
- Install CMake version 3.1 or newer.
- Clone the repository and generate build files.
- Build!
The repository includes binaries for all dependencies except the Vulkan SDK on Windows. These can be found in the external folder. You will have to build these dependencies yourself on other platforms. Use the adress and version tag or commit hash in version.txt to ensure compatibility. Please don't hesitate to open a pull request if you have build dependencies for previously unsupported platforms.