Skip to content

Commit 9e9d023

Browse files
committed
OpenXR SDK 1.1.36 (2024-04-15)
This is a substantial update to the OpenXR specification. The OpenXR loader in this release supports both OpenXR 1.0 and 1.1, and sample applications such as hello_xr continue to only require OpenXR 1.0. The schema associated with the xr.xml description of OpenXR has received a small but breaking change, so software that parses it may need an update accordingly. Additionally, the protocol for the OpenXR loader on Android to communicate with system or installable runtime brokers has been extended for improvfed backward- and forward-compatibility; see the changes to the loader design document for more information. - Registry - New ratified Khronos extension: XR_KHR_locate_spaces (internal MR 2272, internal issue 1706) - New ratified Khronos extension: XR_KHR_maintenance1 (internal MR 3053) - New ratified OpenXR version: XR_VERSION_1_1 - OpenXR 1.1. (internal MR 3053) - New multi-vendor extension: XR_EXT_future (internal MR 2610) - New vendor extension: XR_META_environment_depth (internal MR 2771, internal MR 3271) - Mark XR_OCULUS_android_session_state_enable as deprecated. (internal MR 3255) - Update the XML schema to change how dependencies are described (replacing requiresCore and requires attributes of extension, and feature and extension attributes of require, with a new depends attribute.). This is a breaking change of the XML schema, though in an infrequently processed attribute. This corresponds to the change made in Vulkan 1.3.241. (internal MR 3260) - SDK - API dump layer: Handle opaque futures defined by XR_EXT_future. (internal MR 2610) - API dump layer: Zero initialize out-param in calls to xrResultToString and xrStructureTypeToString. (internal MR 3284) - Android loader: Build using NDK 23.2. (internal MR 2992) - Android loader: Allow the loader to check multiple records from the broker, for backward- and forward-compatibility (internal MR 3269, internal issue 2226) - Loader: Improve error logging in the case that the Windows registry ActiveRuntime path cannot be parsed or found. (internal MR 3015, internal issue 2125) - Loader: Remove path separator parsing from Windows registry ActiveRuntime path to fix bug. (internal MR 3015) - Loader: Fix build issue for ARMv6 architectures, and note architecture naming quirk of Raspberry Pi OS in the architecture table in the loader documentation. (OpenXR-SDK-Source PR 464, OpenXR-SDK-Source issue 463) - Reduce duplication of environment variable getters and setters. (internal MR 3039) - Updates to scripts and software to handle aliases and promoted functionality in XR_KHR_maintenance1 and XR_VERSION_1_1 (internal MR 3053) - hello_xr: Fix Windows mirror window acquire, wait, present loop. (internal MR 3289) - hello_xr and other samples: Update Android compile SDK version (to 33), NDK version (to 23.2), and build tools version (to 34.0.0). (internal MR 2992) - hello_xr and runtime list: Request an OpenXR 1.0 instance by default. (internal MR 3320) - loader_test: Build fixes to allow loader_test to compile / run on Android. (internal MR 3153) GitOrigin-RevId: 5f8d07b310234c348624ff10252df784aa7908ad
1 parent 40f1542 commit 9e9d023

File tree

190 files changed

+17460
-2086
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

190 files changed

+17460
-2086
lines changed

.appveyor.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#
33
# SPDX-License-Identifier: Apache-2.0
44

5-
version: 1.0.34.{build}
5+
version: 1.1.36.{build}
66
image: Visual Studio 2017
77

88

.azure-pipelines/openxr-sdk-source.yml

+4-6
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,20 @@ stages:
2121
- job: loader_docs
2222
pool:
2323
vmImage: "ubuntu-latest"
24-
container: khronosgroup/docker-images:openxr.20230323
25-
# container: khronosgroup/docker-images@sha256:091f1d988744f0b5149126d1f4bdba342b72c01dc90c2d06d4a61738bec5521c
24+
container: khronosgroup/docker-images:openxr.20231010.1@sha256:64798e382f61ef988e30e281e0efef0b46c1aee7c9666587067207b7e270a63f
2625
steps:
2726
- script: make loader
2827
workingDirectory: specification
2928
displayName: Build loader document
30-
- publish: $(System.DefaultWorkingDirectory)/specification/generated/out/1.0/loader.html
29+
- publish: $(System.DefaultWorkingDirectory)/specification/generated/out/1.1/loader.html
3130
artifact: LoaderDoc
3231

3332
- stage: Generate
3433
jobs:
3534
- job: archive
3635
pool:
3736
vmImage: "ubuntu-latest"
38-
container: khronosgroup/docker-images:openxr.20230323
39-
# container: khronosgroup/docker-images@sha256:091f1d988744f0b5149126d1f4bdba342b72c01dc90c2d06d4a61738bec5521c
37+
container: khronosgroup/docker-images:openxr.20231010.1@sha256:64798e382f61ef988e30e281e0efef0b46c1aee7c9666587067207b7e270a63f
4038
steps:
4139
- script: make loader
4240
workingDirectory: specification
@@ -64,7 +62,7 @@ stages:
6462
presentationBackend: wayland
6563
pool:
6664
vmImage: "ubuntu-latest"
67-
container: khronosgroup/docker-images:openxr-pregenerated-sdk.20230323
65+
container: khronosgroup/docker-images:openxr-pregenerated-sdk.20240412@sha256:0006d0994219477d460953f0eda1fa6053f770c68da23b190be7c0d067f078b5
6866
# container: sha256:845e19e59f22c29fedc33dcaa4f3c5f8aa44e367283ef955c7549239cf9a46d2
6967
steps:
7068
- task: DownloadPipelineArtifact@2

.azure-pipelines/shared/build_jobs.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@ jobs:
2626
presentationBackend: wayland
2727
pool:
2828
vmImage: "ubuntu-latest"
29-
# 20230614
30-
container: khronosgroup/docker-images:openxr-sdk@sha256:fbc5fe29a0787cccc8f66bd9bd03c9dbddf591c7d1aea673108c38c908b280f5
29+
container: khronosgroup/docker-images:openxr-sdk.20240412@sha256:e477137f8558565ac9173de8713a3e44d6d564ba042db9a20ff560eb4bfdeccc
3130

3231
steps:
3332
# First build as debug

.azure-pipelines/shared/check_clang_format.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ jobs:
66
displayName: "clang-format"
77
pool:
88
vmImage: "ubuntu-latest"
9-
# 20230614
10-
container: khronosgroup/docker-images:openxr-sdk@sha256:fbc5fe29a0787cccc8f66bd9bd03c9dbddf591c7d1aea673108c38c908b280f5
9+
container: khronosgroup/docker-images:openxr-sdk.20240412@sha256:e477137f8558565ac9173de8713a3e44d6d564ba042db9a20ff560eb4bfdeccc
1110

1211
steps:
1312
- checkout: self

.azure-pipelines/shared/check_file_format.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ jobs:
55
displayName: "Check file formatting"
66
pool:
77
vmImage: "ubuntu-latest"
8-
# 20230614
9-
container: khronosgroup/docker-images:openxr-sdk@sha256:fbc5fe29a0787cccc8f66bd9bd03c9dbddf591c7d1aea673108c38c908b280f5
8+
container: khronosgroup/docker-images:openxr-sdk.20240412@sha256:e477137f8558565ac9173de8713a3e44d6d564ba042db9a20ff560eb4bfdeccc
109

1110
steps:
1211
- script: ./file_format.sh

.azure-pipelines/shared/codespell.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ jobs:
66
displayName: "codespell"
77
pool:
88
vmImage: "ubuntu-latest"
9-
# 20230614
10-
container: khronosgroup/docker-images:openxr-sdk@sha256:fbc5fe29a0787cccc8f66bd9bd03c9dbddf591c7d1aea673108c38c908b280f5
9+
container: khronosgroup/docker-images:openxr-sdk.20240412@sha256:e477137f8558565ac9173de8713a3e44d6d564ba042db9a20ff560eb4bfdeccc
1110

1211
steps:
1312
- checkout: self

.git-blame-ignore-revs

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
# git config blame.ignoreRevsFile .git-blame-ignore-revs
1414

1515
## Old changes
16+
0c93c42891ad6b95aee81709398ded7416c9f397
1617
767537d9523253de1615b01450a8b22c8e2cc6a2
1718

1819
## 1.0.17 - Fix XML indentation

.github/workflows/check_clang_format_and_codespell.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ jobs:
1010
clang-format:
1111
runs-on: ubuntu-latest
1212
container:
13-
# 20230614
14-
image: khronosgroup/docker-images:openxr-sdk@sha256:fbc5fe29a0787cccc8f66bd9bd03c9dbddf591c7d1aea673108c38c908b280f5
13+
image: khronosgroup/docker-images:openxr-sdk.20240412@sha256:e477137f8558565ac9173de8713a3e44d6d564ba042db9a20ff560eb4bfdeccc
1514

1615
steps:
1716
- uses: actions/checkout@v4

.github/workflows/gradle-wrapper-validation.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Copyright 2022-2023, Collabora, Ltd.
1+
# Copyright 2022-2024, Collabora, Ltd.
2+
#
23
# SPDX-License-Identifier: CC0-1.0
34

45
name: Validate Gradle Wrapper
@@ -18,4 +19,4 @@ jobs:
1819
- uses: actions/checkout@v4
1920
with:
2021
lfs: true
21-
- uses: gradle/wrapper-validation-action@v3
22+
- uses: gradle/actions/wrapper-validation@v3

.mailmap

+9
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,20 @@ Blake Taylor <[email protected]>
1414
Bryce Hutchings <[email protected]>
1515
1616
17+
Daniel Willmott <[email protected]>
18+
Ivan Chupakhin <[email protected]>
19+
20+
Kevin Qin <[email protected]>
21+
1722
Khronos Group Web Services <[email protected]>
1823
Khronos Group Web Services <[email protected]> <[email protected]>
24+
25+
26+
Rachel Huang <[email protected]>
1927
Rylie Pavlik <[email protected]>
2028
2129
2230
31+
samuel degrande <[email protected]>
2332
2433

.proclamation.json

+4
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@
2222
"news_filename": "CHANGELOG.Docs.md",
2323
"template": "changes/template.md",
2424
"sections": {
25+
"Major Update": {
26+
"directory": "changes/major",
27+
"sort_by_prefix": true
28+
},
2529
"Registry": {
2630
"directory": "changes/registry",
2731
"sort_by_prefix": true

.reuse/dep5

+6
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Upstream-Contact: Rylie Pavlik <openxr-speceditor AT khronos DOT org>
44
Source: https://registry.khronos.org/OpenXR/
55

66
Files: changes/conformance/*
7+
changes/major/*
78
changes/registry/*
89
changes/sdk/*
910
changes/specification/*
@@ -79,6 +80,11 @@ Files: external/python/markupsafe/*
7980
Copyright: 2010 Pallets
8081
License: BSD-3-Clause
8182

83+
Files: external/python/pyparsing/*
84+
external/python/pyparsing-3.1.2.dist-info/*
85+
Copyright: 2003-2022, Paul T. McGuire <[email protected]>
86+
License: BSD-3-Clause
87+
8288
Files: specification/sources/chapters/extensions/epic/epic_view_configuration_fov.adoc
8389
Copyright: 2020, Epic Games, Inc.
8490
License: CC-BY-4.0

CHANGELOG.SDK.md

+71
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,77 @@ along with any public pull requests that have been accepted.
2121
In this repository in particular, since it is primarily software,
2222
pull requests may be integrated as they are accepted even between periodic updates.
2323

24+
## OpenXR SDK 1.1.36 (2024-04-15)
25+
26+
This is a substantial update to the OpenXR specification. The OpenXR loader in
27+
this release supports both OpenXR 1.0 and 1.1, and sample applications such as
28+
hello_xr continue to only require OpenXR 1.0. The schema associated with the
29+
`xr.xml` description of OpenXR has received a small but breaking change, so
30+
software that parses it may need an update accordingly. Additionally, the
31+
protocol for the OpenXR loader on Android to communicate with system or
32+
installable runtime brokers has been extended for improvfed backward- and
33+
forward-compatibility; see the changes to the loader design document for more
34+
information.
35+
36+
- Registry
37+
- New ratified Khronos extension: `XR_KHR_locate_spaces`
38+
([internal MR 2272](https://gitlab.khronos.org/openxr/openxr/merge_requests/2272),
39+
[internal issue 1706](https://gitlab.khronos.org/openxr/openxr/issues/1706))
40+
- New ratified Khronos extension: `XR_KHR_maintenance1`
41+
([internal MR 3053](https://gitlab.khronos.org/openxr/openxr/merge_requests/3053))
42+
- New ratified OpenXR version: `XR_VERSION_1_1` - OpenXR 1.1.
43+
([internal MR 3053](https://gitlab.khronos.org/openxr/openxr/merge_requests/3053))
44+
- New multi-vendor extension: `XR_EXT_future`
45+
([internal MR 2610](https://gitlab.khronos.org/openxr/openxr/merge_requests/2610))
46+
- New vendor extension: `XR_META_environment_depth`
47+
([internal MR 2771](https://gitlab.khronos.org/openxr/openxr/merge_requests/2771),
48+
[internal MR 3271](https://gitlab.khronos.org/openxr/openxr/merge_requests/3271))
49+
- Mark `XR_OCULUS_android_session_state_enable` as deprecated.
50+
([internal MR 3255](https://gitlab.khronos.org/openxr/openxr/merge_requests/3255))
51+
- Update the XML schema to change how dependencies are described (replacing
52+
`requiresCore` and `requires` attributes of `extension`, and `feature` and
53+
`extension` attributes of `require`, with a new `depends` attribute.). This is
54+
a **breaking change** of the XML schema, though in an infrequently processed
55+
attribute. This corresponds to the change made in Vulkan 1.3.241.
56+
([internal MR 3260](https://gitlab.khronos.org/openxr/openxr/merge_requests/3260))
57+
- SDK
58+
- API dump layer: Handle opaque futures defined by `XR_EXT_future`.
59+
([internal MR 2610](https://gitlab.khronos.org/openxr/openxr/merge_requests/2610))
60+
- API dump layer: Zero initialize out-param in calls to `xrResultToString` and
61+
`xrStructureTypeToString`.
62+
([internal MR 3284](https://gitlab.khronos.org/openxr/openxr/merge_requests/3284))
63+
- Android loader: Build using NDK 23.2.
64+
([internal MR 2992](https://gitlab.khronos.org/openxr/openxr/merge_requests/2992))
65+
- Android loader: Allow the loader to check multiple records from the broker, for
66+
backward- and forward-compatibility
67+
([internal MR 3269](https://gitlab.khronos.org/openxr/openxr/merge_requests/3269),
68+
[internal issue 2226](https://gitlab.khronos.org/openxr/openxr/issues/2226))
69+
- Loader: Improve error logging in the case that the Windows registry
70+
`ActiveRuntime` path cannot be parsed or found.
71+
([internal MR 3015](https://gitlab.khronos.org/openxr/openxr/merge_requests/3015),
72+
[internal issue 2125](https://gitlab.khronos.org/openxr/openxr/issues/2125))
73+
- Loader: Remove path separator parsing from Windows registry `ActiveRuntime`
74+
path to fix bug.
75+
([internal MR 3015](https://gitlab.khronos.org/openxr/openxr/merge_requests/3015))
76+
- Loader: Fix build issue for ARMv6 architectures, and note architecture naming
77+
quirk of Raspberry Pi OS in the architecture table in the loader documentation.
78+
([OpenXR-SDK-Source PR 464](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/464),
79+
[OpenXR-SDK-Source issue 463](https://github.com/KhronosGroup/OpenXR-SDK-Source/issues/463))
80+
- Reduce duplication of environment variable getters and setters.
81+
([internal MR 3039](https://gitlab.khronos.org/openxr/openxr/merge_requests/3039))
82+
- Updates to scripts and software to handle aliases and promoted functionality in
83+
`XR_KHR_maintenance1` and `XR_VERSION_1_1`
84+
([internal MR 3053](https://gitlab.khronos.org/openxr/openxr/merge_requests/3053))
85+
- hello_xr: Fix Windows mirror window acquire, wait, present loop.
86+
([internal MR 3289](https://gitlab.khronos.org/openxr/openxr/merge_requests/3289))
87+
- hello_xr and other samples: Update Android compile SDK version (to 33), NDK
88+
version (to 23.2), and build tools version (to 34.0.0).
89+
([internal MR 2992](https://gitlab.khronos.org/openxr/openxr/merge_requests/2992))
90+
- hello_xr and runtime list: Request an OpenXR 1.0 instance by default.
91+
([internal MR 3320](https://gitlab.khronos.org/openxr/openxr/merge_requests/3320))
92+
- loader_test: Build fixes to allow loader_test to compile / run on Android.
93+
([internal MR 3153](https://gitlab.khronos.org/openxr/openxr/merge_requests/3153))
94+
2495
## OpenXR SDK 1.0.34 (2024-02-16)
2596

2697
This release features a number of new multi-vendor and vendor extensions,

changes/registry/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ For reserving one or more extensions:
3535
> Extension reservation: Reserve an extension for VendorName.
3636
3737
- Pluralize "an extension" if reserving multiple extensions
38-
- May pre-pend "Register author ID and" if applicable (after the colon).
38+
- May prepend "Register author ID and" if applicable (after the colon).
3939
- You may optionally provide information about your plans for those extensions,
4040
but this is not required, just permitted.

changes/sdk/pr.464.gh.OpenXR-SDK-Source.md

-4
This file was deleted.

checkCodespell

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ CODESPELL_IGNORE=${CODESPELL_IGNORE:-${DEFAULT_CODESPELL_IGNORE}}
4545
# ba is from a regex
4646
# unknwn is a header file name
4747
# Wee, Ser, Nuber, Blok are names
48-
IGNORE_WORDS="lod,nd,ba,unknwn,wee,ser,nuber,blok"
48+
IGNORE_WORDS="lod,nd,ba,unknwn,wee,ser,nuber,blok,rouge,implementor,implementors"
4949

5050
# Add to this to exclude individual files or directories (comma-delimited)
5151
# - Skipping external code.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Permission is hereby granted, free of charge, to any person obtaining
2+
a copy of this software and associated documentation files (the
3+
"Software"), to deal in the Software without restriction, including
4+
without limitation the rights to use, copy, modify, merge, publish,
5+
distribute, sublicense, and/or sell copies of the Software, and to
6+
permit persons to whom the Software is furnished to do so, subject to
7+
the following conditions:
8+
9+
The above copyright notice and this permission notice shall be
10+
included in all copies or substantial portions of the Software.
11+
12+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
13+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
14+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
15+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
16+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
17+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
18+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)