loader: update design document
1 file changed
tree: 09c9514e57931cf410096495910cd9cb57db18b0
  1. .editorconfig
  2. .gitattributes
  3. .gitignore
  4. BUILDING.md
  5. CHANGELOG.SDK.md
  6. CMakeLists.txt
  7. CODE_OF_CONDUCT.md
  8. LICENSE
  9. README.md
  10. checkCodespell
  11. doc/
  12. external/
  13. include/
  14. openxr-codespell.exclude
  15. runClangFormat.sh
  16. specification/
  17. src/
README.md

OpenXR ® Software Development Kit (SDK) Project

NOTE: This repository contains components that will eventually be assembled into an OpenXR SDK, but are currently not organized nor packaged as a distributable SDK.

This repository contains source code and build scripts for implementations of the OpenXR loader, validation layers, and code samples.

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

Directory Structure

BUILDING.md           Instructions for building the projects
README.md             This file
COPYING.md            Copyright and licensing information
CODE_OF_CONDUCT.md    Code of Conduct
external/             External code for projects in the repo
include/              OpenXR platform include file
specification/        xr.xml file
src/                  Source code for various projects
src/api_layer         Sample code for developing API layers
src/loader            OpenXR loader code
src/tests/            various test code (if looking for sample code start with hello_xr/)

Currently the best sample code is in src/tests/hello_xr/. More will be added in the future.

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

Building

See BUILDING.md