OpenXR Specification sources and related material
Go to file
Ryan Pavlik 35616b1db1 OpenXR 1.0.3 release (7-October-2019)
Patch release for the 1.0 series.

Updates version to 1.0.3.

- OpenXR-SDK-Source PR #139 - Write output atomically at the end of generator scripts

### Internal issues

- Spec
  - Clarify what happens when a swapchain that has never been released is passed
    to `xrEndFrame`. (internal MR 1569, internal issue 1121)
  - Remove duplicated paragraph in `XR_KHR_vulkan_enable` (internal MR 1543)
- Registry
  - Add `XR_EXT_view_configuration_depth_range` extension (internal MR 1502,
    internal issue 1201)
  - Reserve a Monado extension (internal MR 1541)
2019-10-07 20:39:07 -05:00
include/openxr OpenXR 1.0.3 release (7-October-2019) 2019-10-07 20:39:07 -05:00
specification OpenXR 1.0.3 release (7-October-2019) 2019-10-07 20:39:07 -05:00
.gitattributes Upload release 1.0.0 of OpenXR specification sources. 2019-07-29 08:09:30 -05:00
.gitignore Upload release 1.0.0 of OpenXR specification sources. 2019-07-29 08:09:30 -05:00
CHANGELOG.Docs.md OpenXR 1.0.3 release (7-October-2019) 2019-10-07 20:39:07 -05:00
CODE_OF_CONDUCT.md Change log for OpenXR 0.90.1 provisional spec update (8-May-2019) 2019-05-09 10:20:24 -05:00
COPYING.md add COPYING file 2019-03-16 13:26:26 -07:00
README.adoc OpenXR 1.0.1 release (2-August-2019) 2019-08-02 19:20:10 -05:00
checkCodespell Upload release 1.0.0 of OpenXR specification sources. 2019-07-29 08:09:30 -05:00
open-in-docker.sh OpenXR 1.0.1 release (2-August-2019) 2019-08-02 19:20:10 -05:00
openxr-codespell.exclude Upload release 1.0.0 of OpenXR specification sources. 2019-07-29 08:09:30 -05:00
tox.ini OpenXR 1.0.1 release (2-August-2019) 2019-08-02 19:20:10 -05:00

README.adoc

ifdef::env-github[]
:note-caption: :information_source:
endif::[]

= OpenXR™ API Documentation Project

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

[options="compact"]
 * the OpenXR API Specification
 * OpenXR header files (generated from the specification)
 * 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/       Static OpenXR header (not generated from the Registry)
```

== Building the Specification and Reference Pages, and Regenerating Headers

The document sources are marked up in Asciidoctor format, and we use
`asciidoctor` and related toolchain components to generate output documents.
See link:specification/README.md[specification/README.md]
for more information on installing the toolchain and building the
Specification.