This OpenXR-Tutorial repository contains both the text and code samples for the OpenXR-Tutorial website (https://openxr-tutorial.com/).

• OpenXR-Tutorial
  • Table of Contents
  • Chapters
    • 1. Introduction
    • 2. OpenXR Setup
    • 3. Graphics
    • 4. Interactions
    • 5. Extensions
    • 6. Next Setup
  • Website
  • Setup
  • Build
    • Supported Platforms
    • Building the Tutorial Website
  • Contributors
  • Legal Notice
    • Website
    • Repository
  • Related resources

This chapter describes the goals of OpenXR and gives an overview of the core concepts used in the API. It describes how to set up your project as well.

This chapter explains how to set up an XrInstance and XrSession. It also discusses how to poll events in OpenXR.

XrSwapchain construction is explained in this chapter along with the XrEnvironmentBlendMode and the XrReferenceSpaceType. Finally, it explains how to set up a render loop and draw some simple geometry.

This chapter focuses solely on explaining and demonstrating both the interaction profile and action systems that OpenXR uses. These systems provide a way for developers and users to bind inputs to actions allowing greater cross-vendor compatibility of an application.

This chapter discusses a few extensions for Hand tracking and Composition Layer Depth. Extensions allow greater functionality to be added to an application provided that the hardware and runtime support them.

This chapter contains a collection of topics to act as a jumping-off point to explore further the diverse and ever-growing world of XR development. Of note are the sections on Multiview rendering, OpenXR API Layers and Multithreaded rendering.

https://openxr-tutorial.com/

Prerequisites: git

Clone the repo with submodules using the following command:

git clone https://github.com/KhronosGroup/OpenXR-Tutorials.git
cd OpenXR-Tutorials

Follow build instructions for your platform below.

• Windows - Build Guide

• Linux - Build Guide

• Android - Build Guide

The tutorial website is built with Sphinx, a Python-based documentation build tool. To build the website, set the CMake variable XR_TUTORIAL_BUILD_DOCUMENTATION to TRUE. Set the CMake variable BUILD_ALL_EXTENSIONS to FALSE if you only intend to build the documentation and might be missing requirements for graphics APIs. Install the following Python modules:

pip install sphinx==6.1.3
pip install breathe
pip install myst-parser
pip install sphinxcontrib-jquery
pip install sphinx-copybutton
pip install sphinxcontrib-mermaid
pip install reuse

Now build the project Sphinx from the command line or your IDE.

The original text of the OpenXR Tutorial is by Roderick Kennedy and Andrew Richards of Simul Software Ltd. The design of the site is by Calland Creative Ltd. The site is overseen by the Khronos OpenXR Working Group. Thanks to all volunteers who tested the site through its development.

© 2023, The Khronos Group. Creative Commons International 4.0 BY Attribution. Code is licensed as Apache 2.0.

"OpenXR" and the OpenXR logo are trademarks owned by The Khronos Group Inc. and are registered as a trademark in China, the European Union, Japan and the United Kingdom. Vulkan and the Vulkan logo are registered trademarks of the Khronos Group Inc.

OpenGL® and the oval logo are trademarks or registered trademarks of Hewlett Packard Enterprise in the United States and/or other countries worldwide. OpenGL is a registered trademark and the OpenGL ES logo is a trademark of Hewlett Packard Enterprise used by permission by Khronos.

Microsoft DirectX, Microsoft DirectX11, and Microsoft DirectX12 are trademarks owned by Microsoft.

The OpenXR Tutorial is owned and operated by The Khronos Group Inc. Khronos Legal Notices, Privacy Policy, and Code of Conduct apply.

See LICENSE.

Khronos OpenXR Main page

OpenXR 1.0 Specification

OpenXR 1.0 Manual Pages