Skip to content

Add a disclaimer to index.rst about the graphics abstraction #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rbessems merged 1 commit into from
Jun 26, 2025
Merged

Add a disclaimer to index.rst about the graphics abstraction #150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions tutorial/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ An API is an application programming interface, a set of rules for how a softwar

This tutorial introduces programming with OpenXR. If you use a game engine such as Unreal Engine, Unity or Godot, you may not need to interact directly with OpenXR: the engine abstracts this away. However, it may be beneficial to learn the underlying concepts.

OpenXR is designed to work with various different graphics APIs: Vulkan, Direct3D 11, Direct3D 12, OpenGL and OpenGL ES are all supported at present. You will need some familiarity with your graphics API of choice to get the most out of this tutorial.
OpenXR is designed to work with various different graphics APIs: Vulkan, Direct3D 11, Direct3D 12, OpenGL and OpenGL ES are all supported at present. You will need some familiarity with your graphics API of choice to get the most out of this tutorial. Please note that the graphics abstraction provided here is not intended to be production ready. It is intended as a minimal example of how you could integrate OpenXR into your own application.

Other prerequisites are:

* A Windows or Linux PC to compile the code.
* An IDE (integrated development environment) that supports your target device: either Visual Studio 2017 or later; or Android Studio.
* Some XR hardware to run on: either an XR device that connects to your PC, or an Android-based device like a Meta Quest or Pico Neo. It is also possible to use `Monado <https://monado.freedesktop.org/>`_ to emulate XR hardware.
* CMake 3.22.1 is required.
* CMake 3.28.3+ is required.
* Python 3.6+ is required to build the OpenXR-SDK-Source repository. See `OpenXR-SDK-Source/BUILDING.md <https://github.com/KhronosGroup/OpenXR-SDK-Source/blob/main/BUILDING.md>`_.

Tutorial Structure
Expand Down