# OpenXR-Guide

**Repository Path**: mirrors_KhronosGroup/OpenXR-Guide

## Basic Information

- **Project Name**: OpenXR-Guide
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: CC-BY-4.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-07-23
- **Last Updated**: 2025-09-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!--
Copyright 2021-2022 The Khronos Group, Inc.
SPDX-License-Identifier: CC-BY-4.0
-->

# OpenXR Guide

![OpenXR logo](./images/openxr_logo.png)
![Khronos logo](./images/khronos_logo.png)

The OpenXR Guide is designed to help developers get up and going with the world
of OpenXR. It is aimed to be a light read that leads to many other useful links
depending on what a developer is looking for. All information is intended to
help better fill the gaps about the many nuances of OpenXR.

## Overview
- [What is OpenXR?](./chapters/what_is_openxr.md)
- [Goals, Design, Philosophy](./chapters/goals_design_philosophy.md)

## Using OpenXR
- [Frame submission](./chapters/frame_submission.md). A guide focusing on the details of OpenXR frame submission including common calling patterns, optimizations and pitfalls.

## Video Guides
- [OpenXR for native development](https://learn.microsoft.com/en-us/windows/mixed-reality/develop/native/openxr#openxr-for-native-development). A 60-minute video tour of the major components of the OpenXR API presented by Alex Turner at Microsoft.
- [OpenXR Master Class | ChinaVR 2020](https://www.youtube.com/watch?v=0qMJsiEUpUE). A deep dive into how an OpenXR application is structured, how the interaction system works, how multiple applications and overlays are supported and more, presented by Ryan A. Pavlik, Principal Software Engineer at Collabora and OpenXR Working Group Specification Editor.

## Sample Apps
- [hello_xr](https://github.com/KhronosGroup/OpenXR-SDK-Source/tree/main/src/tests/hello_xr). The official hello_xr OpenXR sample application with support for all graphics APIs and major platforms.
- [OpenXR Samples for Mixed Reality Developers](https://github.com/microsoft/OpenXR-MixedReality). The Microsoft Mixed Reality sample applications for Windows and HoloLens.

## Appendix
- [License](./LICENSE)
- [Code of conduct](./CODE_OF_CONDUCT.md)