OpenXR SDK 1.1.40 (2024-08-22)

This release features a new ratified graphics API binding extension, XR_KHR_metal_enable, including support in hello_xr. The loader test has had substantial improvements as well. There are also an assortment of smaller fixes and improvements. - Registry - Add: New ratified Khronos extension: XR_KHR_metal_enable. (internal MR 2721) - Chore: Reserve 15 extension id numbers for ByteDance. (internal MR 3409) - Fix: Clarified that views in XR_VARJO_quad_views needs to have identical poses for each eye. (internal MR 3396) - Fix: Add missing interaction profile extensions for OpenXR 1.1 promoted Meta interaction profiles. (internal MR 3398) - Fix: Correctly mark the Magic Leap home button as a system button in the XML. (internal MR 3405) - Fix: Add XR_ERROR_VALIDATION_FAILURE to all functions from XR_EXT_conformance_automation. (internal MR 3417) - SDK - API dump layer: Improvement: Move a non-generated function out of the Python- generated source file. (internal MR 3336) - API dump layer: Improvement: Clean up usage of RAII mutex lock guards. (internal MR 3336) - Layers and loader: Improvement: Disambiguate XrGeneratedDispatchTable between loader and API layers. (internal MR 3406) - Loader test: Improvement: Migrate to use Catch2 (matching the CTS) instead of an ad-hoc test framework. (internal MR 3337) - hello_xr: Add: Metal graphics plugin (use -g Metal) for running it on macOS with XR_KHR_metal_enable extension. (internal MR 3009, internal MR 3456) - hello_xr: Improvement: Use XrMatrix4x4f_CreateFromRigidTransform in place of XrMatrix4x4f_CreateTranslationRotationScale for known rigid transforms. (internal MR 3349) Note: There is no 1.1.39 release: it was skipped to keep the monthly patch version increment cadence given the lack of a release in July. GitOrigin-RevId: 3ec99b59aaf8ac8d7c8d822ddd174fc6c0c5e57b
KhronosGroup · Aug 22, 2024 · 4b9834d · 4b9834d
1 parent 5270be9
commit 4b9834d
Show file tree

Hide file tree

Showing 639 changed files with 214,268 additions and 572 deletions.
diff --git a/.appveyor.yml b/.appveyor.yml
@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-version: 1.1.38.{build}
+version: 1.1.40.{build}
 image: Visual Studio 2017
 
 

diff --git a/.azure-pipelines/openxr-sdk-source.yml b/.azure-pipelines/openxr-sdk-source.yml
@@ -21,7 +21,7 @@ stages:
       - job: loader_docs
         pool:
           vmImage: "ubuntu-latest"
-        container: khronosgroup/docker-images:openxr.20231010.1@sha256:64798e382f61ef988e30e281e0efef0b46c1aee7c9666587067207b7e270a63f
+        container: khronosgroup/docker-images:openxr.20240805@sha256:05e900737234daf09d29a1c525a017ea8cc54a0d1f808569488e9ae6018053f2
         steps:
           - script: make loader
             workingDirectory: specification
@@ -34,7 +34,7 @@ stages:
       - job: archive
         pool:
           vmImage: "ubuntu-latest"
-        container: khronosgroup/docker-images:openxr.20231010.1@sha256:64798e382f61ef988e30e281e0efef0b46c1aee7c9666587067207b7e270a63f
+        container: khronosgroup/docker-images:openxr.20240805@sha256:05e900737234daf09d29a1c525a017ea8cc54a0d1f808569488e9ae6018053f2
         steps:
           - script: make loader
             workingDirectory: specification

diff --git a/.azure-pipelines/shared/build_jobs.yml b/.azure-pipelines/shared/build_jobs.yml
@@ -26,7 +26,7 @@ jobs:
           presentationBackend: wayland
     pool:
       vmImage: "ubuntu-latest"
-    container: khronosgroup/docker-images:openxr-sdk.20240412@sha256:e477137f8558565ac9173de8713a3e44d6d564ba042db9a20ff560eb4bfdeccc
+    container: khronosgroup/docker-images:openxr-sdk.20240805@sha256:bbc790ccdc56f291d72877c6fdb825edbb9c3222efb63dc4d3ac34e3bf13dd7a
 
     steps:
       # First build as debug

diff --git a/.azure-pipelines/shared/check_clang_format.yml b/.azure-pipelines/shared/check_clang_format.yml
@@ -6,7 +6,7 @@ jobs:
     displayName: "clang-format"
     pool:
       vmImage: "ubuntu-latest"
-    container: khronosgroup/docker-images:openxr-sdk.20240412@sha256:e477137f8558565ac9173de8713a3e44d6d564ba042db9a20ff560eb4bfdeccc
+    container: khronosgroup/docker-images:openxr.20240805@sha256:05e900737234daf09d29a1c525a017ea8cc54a0d1f808569488e9ae6018053f2
 
     steps:
       - checkout: self

diff --git a/.azure-pipelines/shared/check_file_format.yml b/.azure-pipelines/shared/check_file_format.yml
@@ -5,7 +5,7 @@ jobs:
     displayName: "Check file formatting"
     pool:
       vmImage: "ubuntu-latest"
-    container: khronosgroup/docker-images:openxr-sdk.20240412@sha256:e477137f8558565ac9173de8713a3e44d6d564ba042db9a20ff560eb4bfdeccc
+    container: khronosgroup/docker-images:openxr-sdk.20240805@sha256:bbc790ccdc56f291d72877c6fdb825edbb9c3222efb63dc4d3ac34e3bf13dd7a
 
     steps:
       - script: ./file_format.sh

diff --git a/.azure-pipelines/shared/codespell.yml b/.azure-pipelines/shared/codespell.yml
@@ -6,7 +6,7 @@ jobs:
     displayName: "codespell"
     pool:
       vmImage: "ubuntu-latest"
-    container: khronosgroup/docker-images:openxr-sdk.20240412@sha256:e477137f8558565ac9173de8713a3e44d6d564ba042db9a20ff560eb4bfdeccc
+    container: khronosgroup/docker-images:openxr-sdk.20240805@sha256:bbc790ccdc56f291d72877c6fdb825edbb9c3222efb63dc4d3ac34e3bf13dd7a
 
     steps:
       - checkout: self

diff --git a/.github/workflows/check_clang_format_and_codespell.yml b/.github/workflows/check_clang_format_and_codespell.yml
@@ -10,7 +10,7 @@ jobs:
   clang-format:
     runs-on: ubuntu-latest
     container:
-      image: khronosgroup/docker-images:openxr-sdk.20240412@sha256:e477137f8558565ac9173de8713a3e44d6d564ba042db9a20ff560eb4bfdeccc
+      image: khronosgroup/docker-images:openxr.20240805@sha256:05e900737234daf09d29a1c525a017ea8cc54a0d1f808569488e9ae6018053f2
 
     steps:
       - uses: actions/checkout@v4

diff --git a/.gitignore b/.gitignore
@@ -41,6 +41,7 @@ specification/scripts/.cache
 
 # VS 2019 CMake artifacts
 out/build/
+out/install/
 
 # VS misc
 *.sln

diff --git a/.reuse/dep5 b/.reuse/dep5
@@ -69,6 +69,11 @@ Copyright: 2016-2020, Mitchell Dowd
 License: MIT
 Comment: Unmodified, vendored copy of commit e6c415837c5a487809fdbb2f71f1080d454eb99a
 
+Files: src/external/metal-cpp/*
+Copyright: Copyright 2020-2022 Apple Inc.
+License: Apache-2.0
+Comment: Unmodified, vendored copy of metal-cpp_macOS13_iOS16.zip
+
 Files: external/python/jinja2/*
   external/python/Jinja2-2.11.3.dist-info/*
 Copyright: 2013-2019 by the Jinja team

diff --git a/CHANGELOG.SDK.md b/CHANGELOG.SDK.md
@@ -21,6 +21,52 @@ along with any public pull requests that have been accepted.
 In this repository in particular, since it is primarily software,
 pull requests may be integrated as they are accepted even between periodic updates.
 
+## OpenXR SDK 1.1.40 (2024-08-22)
+
+This release features a new ratified graphics API binding extension,
+`XR_KHR_metal_enable`, including support in hello_xr. The loader test has had
+substantial improvements as well. There are also an assortment of smaller fixes
+and improvements.
+
+- Registry
+  - Add: New ratified Khronos extension: `XR_KHR_metal_enable`.
+    ([internal MR 2721](https://gitlab.khronos.org/openxr/openxr/merge_requests/2721))
+  - Chore: Reserve 15 extension id numbers for ByteDance.
+    ([internal MR 3409](https://gitlab.khronos.org/openxr/openxr/merge_requests/3409))
+  - Fix: Clarified that views in `XR_VARJO_quad_views` needs to have identical
+    poses for each eye.
+    ([internal MR 3396](https://gitlab.khronos.org/openxr/openxr/merge_requests/3396))
+  - Fix: Add missing interaction profile extensions for OpenXR 1.1 promoted Meta
+    interaction profiles.
+    ([internal MR 3398](https://gitlab.khronos.org/openxr/openxr/merge_requests/3398))
+  - Fix: Correctly mark the Magic Leap home button as a system button in the XML.
+    ([internal MR 3405](https://gitlab.khronos.org/openxr/openxr/merge_requests/3405))
+  - Fix: Add `XR_ERROR_VALIDATION_FAILURE` to all functions from
+    `XR_EXT_conformance_automation`.
+    ([internal MR 3417](https://gitlab.khronos.org/openxr/openxr/merge_requests/3417))
+- SDK
+  - API dump layer: Improvement: Move a non-generated function out of the Python-
+    generated source file.
+    ([internal MR 3336](https://gitlab.khronos.org/openxr/openxr/merge_requests/3336))
+  - API dump layer: Improvement: Clean up usage of RAII mutex lock guards.
+    ([internal MR 3336](https://gitlab.khronos.org/openxr/openxr/merge_requests/3336))
+  - Layers and loader: Improvement: Disambiguate `XrGeneratedDispatchTable` between
+    loader and API layers.
+    ([internal MR 3406](https://gitlab.khronos.org/openxr/openxr/merge_requests/3406))
+  - Loader test: Improvement: Migrate to use Catch2 (matching the CTS) instead of
+    an ad-hoc test framework.
+    ([internal MR 3337](https://gitlab.khronos.org/openxr/openxr/merge_requests/3337))
+  - hello_xr: Add: Metal graphics plugin (use `-g Metal`) for running it on macOS
+    with `XR_KHR_metal_enable` extension.
+    ([internal MR 3009](https://gitlab.khronos.org/openxr/openxr/merge_requests/3009),
+    [internal MR 3456](https://gitlab.khronos.org/openxr/openxr/merge_requests/3456))
+  - hello_xr: Improvement: Use `XrMatrix4x4f_CreateFromRigidTransform` in place of
+    `XrMatrix4x4f_CreateTranslationRotationScale` for known rigid transforms.
+    ([internal MR 3349](https://gitlab.khronos.org/openxr/openxr/merge_requests/3349))
+
+**Note**: There is no 1.1.39 release: it was skipped to keep the monthly patch
+version increment cadence given the lack of a release in July.
+
 ## OpenXR SDK 1.1.38 (2024-06-09)
 
 This is a fairly small release, with one new extension and a handful of fixes.

diff --git a/maintainer-scripts/common.sh b/maintainer-scripts/common.sh
@@ -208,6 +208,8 @@ getSDKSourceFilenames() {
         src/external/android-jni-wrappers \
         src/external/jnipp \
         src/external/jsoncpp \
+        src/external/catch2 \
+        src/external/metal-cpp \
         src/loader \
         src/scripts \
         src/tests \

diff --git a/open-in-docker.sh b/open-in-docker.sh
@@ -17,7 +17,7 @@
 
 # This image/tag is generated from https://github.com/KhronosGroup/DockerContainers/blob/main/openxr.Dockerfile
 # Purpose: Spec (pdf/html) generation
-IMAGE_NAME=khronosgroup/docker-images:openxr.20240412
+IMAGE_NAME=khronosgroup/docker-images:openxr.20240805
 MOUNTPOINT=$(pwd)
 
 set -e

diff --git a/runClangFormat.sh b/runClangFormat.sh
@@ -17,11 +17,23 @@
 
 set -e
 (
-    PREFERRED_CLANG_FORMAT=clang-format-10
-    ACCEPTABLE_CLANG_FORMATS="${PREFERRED_CLANG_FORMAT} clang-format-11 clang-format-12 clang-format-13 clang-format-14 clang-format-15 clang-format-16 clang-format"
+    PREFERRED_CLANG_FORMAT=clang-format-14
+    ACCEPTABLE_CLANG_FORMATS=(
+        "${PREFERRED_CLANG_FORMAT}"
+        clang-format-11
+        clang-format-12
+        clang-format-13
+        clang-format-14
+        clang-format-15
+        clang-format-16
+        clang-format-17
+        clang-format-18
+        clang-format-19
+        clang-format-20
+        clang-format)
     cd "$(dirname "$0")"
     if [ ! "${CLANGFORMAT}" ]; then
-        for tool in ${ACCEPTABLE_CLANG_FORMATS}; do
+        for tool in "${ACCEPTABLE_CLANG_FORMATS[@]}"; do
             if which "$tool" > /dev/null 2> /dev/null; then
                 CLANGFORMAT=$tool
                 break
@@ -30,7 +42,7 @@ set -e
     fi
     if [ ! "${CLANGFORMAT}" ]; then
         echo "Could not find clang-format. Prefer ${PREFERRED_CLANG_FORMAT} but will accept newer." 1>&2
-        echo "Looked for the names: ${ACCEPTABLE_CLANG_FORMATS}"
+        echo "Looked for the names: ${ACCEPTABLE_CLANG_FORMATS[*]}"
         exit 1
     fi
     echo "'Official' clang-format version recommended is ${PREFERRED_CLANG_FORMAT}. Currently using:"
@@ -41,6 +53,7 @@ set -e
     find . \( -wholename ./src/\* \) \
         -and -not \( -wholename ./src/external/\* \) \
         -and -not \( -wholename ./src/scripts/\* \) \
+        -and -not \( -ipath \*/.cxx/\* \) \
         -and \( -name \*.hpp -or -name \*.h -or -name \*.cpp -or -name \*.c \) \
         -exec "${CLANGFORMAT}" -i -style=file {} +
 

diff --git a/specification/Makefile b/specification/Makefile
@@ -39,7 +39,7 @@ endif
 VERSIONS := XR_VERSION_1_0 XR_VERSION_1_1 XR_LOADER_VERSION_1_0
 VERSIONOPTIONS := $(foreach version,$(VERSIONS),-feature $(version))
 
-SPECREVISION = 1.1.38
+SPECREVISION = 1.1.40
 REVISION_COMPONENTS = $(subst ., ,$(SPECREVISION))
 MAJORMINORVER = $(word 1,$(REVISION_COMPONENTS)).$(word 2,$(REVISION_COMPONENTS))