https://github.com/khronosgroup/openxr-cts
Conformance test suite for OpenXR
https://github.com/khronosgroup/openxr-cts
augmented-reality conformance-tests openxr openxr-cts virtual-reality vr xr
Last synced: about 1 month ago
JSON representation
Conformance test suite for OpenXR
- Host: GitHub
- URL: https://github.com/khronosgroup/openxr-cts
- Owner: KhronosGroup
- License: apache-2.0
- Created: 2020-05-21T18:07:30.000Z (about 5 years ago)
- Default Branch: devel
- Last Pushed: 2025-04-25T23:24:24.000Z (about 2 months ago)
- Last Synced: 2025-05-07T10:17:25.710Z (about 1 month ago)
- Topics: augmented-reality, conformance-tests, openxr, openxr-cts, virtual-reality, vr, xr
- Language: C++
- Homepage: https://www.khronos.org/conformance/adopters/
- Size: 16.8 MB
- Stars: 68
- Watchers: 12
- Forks: 25
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.CTS.md
- License: COPYING.adoc
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# OpenXR™ Conformance Test Suite (OpenXR-CTS)
The OpenXR Conformance Test Suite is a collection of tests covering the breadth
of the OpenXR API. A runtime passing this test suite is a **necessary** part of
the [OpenXR Adopter Process][adopter], though it is **not sufficient** on its
own to deem a runtime conformant.
It is maintained as open source as a part of the work of the OpenXR Working
Group. It is maintained in two locations:
- The private, internal Khronos GitLab monorepo for OpenXR:
- A public repository on GitHub containing only the CTS and its dependencies:
Changes from GitHub are periodically imported into the private GitLab. Upon
specification patch release, the public `devel` branch is updated from the
internal repository. Upon approval of a new tagged release of OpenXR-CTS for
conformance submissions, the public `devel` and `approved` branches are updated
from the internal repo and signed tags are published.
[adopter]: https://www.khronos.org/conformance/adopters/
## Usage
For complete instructions on usage, design, and runtime requirements, see the
CTS Usage Guide in the `usage/` (`src/conformance/usage/`) directory.
AsciiDoctor can be used to generate a formatted HTML or PDF file from the
separate chapters:
```sh
# from the usage/ directory
# for an HTML document in generated/out/
make html
# for a PDF document in generated/out/
make pdf
```
HTML and PDF versions of the Usage Guide are also available on GitHub alongside
tagged, approved releases, or on the [OpenXR Registry][registry].
[registry]: https://registry.khronos.org/OpenXR/