Skip to content
OpenXR Specification sources and related material
Branch: master
Clone or download
rpavlik Change log for OpenXR 0.90.1 provisional spec update (8-May-2019)
No API changes, and only minimal consistency changes to the spec/registry.
Mostly an update for tooling, layers, loader, and sample code.
Header version has been bumped to 43, but no symbols that should have actually been in use have changed.

The OpenXR-Docs repo now contains the scripts and sources needed to build
the specification output files.

### Internal Issues

- General, Build, Other
  - Unify (for the most part) the OpenXR and Vulkan generator scripts. (internal MR 1166)
  - Avoid dllexport for all apps compiled with `openxr_platform_defines.h` (internal MR 1187)
- API Registry and Headers
  - Remove impossible and undocumented error codes. (internal MR 1185 and 1189)
  - Mark layers in `XrFrameEndInfo` as optional. (internal MR 1151, internal issue 899)
  - Remove unused windows types from `openxr_platform.h` (internal MR 1197)
  - Make `openxr_platform.h` include `openxr.h` on which it depends. (internal MR 1140, internal issue 918)
  - Remove unused, undocumented defines. (internal MR 1238, internal issue 1012)
Latest commit 4405f1d May 8, 2019

README.adoc

OpenXR® API Documentation Project

[NOTE: This is the initial set up for the provisional release of the specification. Not all the files are populated yet, and expect significant changes as the spec moves towards 1.0.]

This repository contains sources for the formal documentation of the OpenXR API. This includes:

  • the OpenXR API Specification

  • OpenXR header files

  • related tools and scripts.

The authoritative public repository is located at https://github.com/KhronosGroup/OpenXR-Docs/. It hosts public Issue tracker, and accepts patches (Pull Requests) from the general public.

Directory Structure

The directory structure is as follows:

README.adoc           This file
COPYING.md            Copyright and licensing information
CODE_OF_CONDUCT.md    Code of Conduct
specification/        Specification - files to generate the spec
include/openxr/       OpenXR headers, generated from the Registry

This structure is for the provisional specification. Things are incomplete at launch but will be added to going forward.

Building the Specification and Reference Pages

The document sources are marked up in Asciidoctor format, and we use asciidoctor and related toolchain components to generate output documents. Once the public scripts are ready, see BUILD.adoc for more information on installing the toolchain and building the Specification.

The ability to generate the header and related files will be added in the future.

You can’t perform that action at this time.