OpenXR Specification 1.0.33 (2024-01-03)

This release primarily adds new ratified functionality to the specification describing the loader interaction with runtimes and API layers. This functionality was previously described in non-normative text in the loader design document, but was universally adopted for compatibility. It is now part of the normative, ratified core specification. This change only affects vendors of runtimes and API layers as well as contributors to the OpenXR loader: applications do not directly use this API, the loader uses it on their behalf. A number of other small fixes are also included. - Registry - Extension reservation: Update author ID and reserve extensions for Varjo. (internal MR 3083) - Extension reservation: Reserve 10 extension ids each for ANDROIDX & ANDROIDSYS. (internal MR 3086) - Khronos ratified addition: Specify the existing loader negotiation functions (without modification) in the XML, moving from loader_interfaces.h to a new generated header openxr_loader_negotiation.h. (internal MR 2807, internal issue 1953) - XR_KHR_android_thread_settings: Fix the description of XrAndroidThreadTypeKHR enum values - they were swapped relative to their implicit meaning from their name. (internal MR 3077) - XR_MNDX_egl_enable: Update version to 2 to reflect function pointer type change released in 1.0.29. (OpenXR-Docs PR 159) - Specification - Khronos ratified specification addition: move loader negotiation functions into the specification proper (from the loader design doc), moving corresponding functions from loader_interfaces.h to openxr_loader_negotiation.h. (The exact ratified core specification text is 1.0.29 with these changes added, available internally. Non-substantive core specification updates/fixes have occurred since then.) (internal MR 2807, internal issue 1953, internal MR 3101) - Scripts: Adjust Makefile so we now error on any checkSpecLinks warning when running that target. (internal MR 3072) - XR_HTC_anchor: Fix parameter name error in prose description. (internal MR 3072) - XR_KHR_android_thread_settings: Fix the description of XrAndroidThreadTypeKHR enum values - they were swapped relative to their implicit meaning from their name. (internal MR 3077) - XR_MNDX_egl_enable: Update revision info and version to 2 to reflect function pointer type change released in 1.0.29. (OpenXR-Docs PR 159) - loader design doc: Fix minor typos. (internal MR 3065, internal MR 3103) - Misc - Update/correct names. - Ship a .mailmap file in the public repositories, maintained separately from the larger one used in the private monorepo, to correct names/emails and unify contributor identities. - Update Khronos Group copyright dates. GitOrigin-RevId: a561c5898b72f59965790790a28bbc3b7e9bcf13
KhronosGroup · Jan 4, 2024 · 55abe9e · 55abe9e
1 parent 2fdfde4
commit 55abe9e
Show file tree

Hide file tree

Showing 314 changed files with 1,412 additions and 384 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2023, The Khronos Group Inc.
+# Copyright (c) 2017-2024, The Khronos Group Inc.
 #
 # SPDX-License-Identifier: Apache-2.0
 

diff --git a/.env b/.env
@@ -1,4 +1,4 @@
-# Copyright (c) 2022-2023, The Khronos Group Inc.
+# Copyright (c) 2022-2024, The Khronos Group Inc.
 #
 # SPDX-License-Identifier: Apache-2.0
 

diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -1,4 +1,4 @@
-# Copyright 2021-2023, The Khronos Group Inc. Inc.
+# Copyright 2021-2024, The Khronos Group Inc. Inc.
 #
 # SPDX-License-Identifier: CC-BY-4.0
 

diff --git a/.gitattributes b/.gitattributes
@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2023, The Khronos Group Inc.
+# Copyright (c) 2017-2024, The Khronos Group Inc.
 #
 # SPDX-License-Identifier: Apache-2.0
 

diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2023, The Khronos Group Inc.
+# Copyright (c) 2017-2024, The Khronos Group Inc.
 #
 # SPDX-License-Identifier: Apache-2.0
 

diff --git a/.mailmap b/.mailmap
@@ -0,0 +1,24 @@
+# Copyright 2017-2024, The Khronos Group Inc.
+#
+# SPDX-License-Identifier: CC-BY-4.0
+#
+# See mailmap docs: https://git-scm.com/docs/gitmailmap
+# Please keep in sorted order.
+# Generally, only add lines, unless you want to change the spelling
+# of your name.
+# Test by running git shortlog -s -e
+#
+# This mailmap is for **public repos** and should only be tested there.
+
+Blake Taylor <rotaylor@magicleap.com>
+Bryce Hutchings <bryceh@microsoft.com>
+Bryce Hutchings <bryceh@microsoft.com> <5100250+brycehutchings@users.noreply.github.com>
+Bryce Hutchings <bryceh@microsoft.com> <me@bryce.ws>
+Khronos Group Web Services <webservices@khronos.org>
+Khronos Group Web Services <webservices@khronos.org> <webmaster@khronos.org>
+Rylie Pavlik <rylie.pavlik@collabora.com>
+Rylie Pavlik <rylie.pavlik@collabora.com> <ryan.pavlik@collabora.com>
+Rylie Pavlik <rylie.pavlik@collabora.com> <ryan.pavlik@gmail.com>
+Yin Li <yl@microsoft.com>
+utzcoz <utzcoz@outlook.com>
+utzcoz <utzcoz@outlook.com> <43091780+utzcoz@users.noreply.github.com>
diff --git a/.proclamation.json.license b/.proclamation.json.license
@@ -1,4 +1,4 @@
 Copyright (c) 2020 Collabora, Ltd. and the Proclamation contributors
-Copyright (c) 2020-2023, The Khronos Group Inc.
+Copyright (c) 2020-2024, The Khronos Group Inc.
 
 SPDX-License-Identifier: CC0-1.0
diff --git a/.reuse/dep5 b/.reuse/dep5
@@ -1,6 +1,6 @@
 Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
 Upstream-Name: OpenXR
-Upstream-Contact: Ryan Pavlik <openxr-speceditor AT khronos DOT org>
+Upstream-Contact: Rylie Pavlik <openxr-speceditor AT khronos DOT org>
 Source: https://registry.khronos.org/OpenXR/
 
 Files: changes/conformance/*
@@ -10,11 +10,11 @@ Files: changes/conformance/*
        changes/README.md
        changes/template.md
        HOTFIX
-Copyright: 2019-2023, The Khronos Group Inc.
+Copyright: 2019-2024, The Khronos Group Inc.
 License: CC-BY-4.0
 
 Files: specification/config/copyright-spec.adoc
-Copyright: 2014-2023 The Khronos Group Inc
+Copyright: 2014-2024, The Khronos Group Inc
 License: LicenseRef-KhronosSpecCopyright-WithNormativeWording-v10
 
 Files: src/tests/hello_xr/android_resources/vulkan/mipmap-xxhdpi/ic_helloxr_launcher.png
@@ -27,7 +27,7 @@ Files: src/tests/hello_xr/android_resources/vulkan/mipmap-xxhdpi/ic_helloxr_laun
        src/tests/hello_xr/android_resources/opengles/mipmap-xhdpi/ic_helloxr_launcher.png
        src/tests/hello_xr/android_resources/opengles/mipmap-hdpi/ic_helloxr_launcher.png
        src/tests/hello_xr/android_resources/opengles/mipmap-xxxhdpi/ic_helloxr_launcher.png
-Copyright: Copyright (c) 2020-2023, The Khronos Group Inc.
+Copyright: Copyright (c) 2020-2024, The Khronos Group Inc.
   Copyright (c) 2020, Google
 License: Apache-2.0
 Comment: Based on a Material Icons asset ("emoji-people") with added text
@@ -86,7 +86,7 @@ Comment: In-line license comments requested, https://gitlab.khronos.org/openxr/o
 
 Files: specification/sources/chapters/extensions/ext/ext_performance_settings.adoc
   specification/sources/chapters/extensions/ext/ext_thermal_query.adoc
-Copyright: 2017-2023, The Khronos Group Inc.
+Copyright: 2017-2024, The Khronos Group Inc.
 License: CC-BY-4.0
 Comment: In-line license comments requested, https://gitlab.khronos.org/openxr/openxr/-/issues/1419
 
@@ -95,13 +95,13 @@ Files: src/conformance/platform_specific/android_resources/mipmap-hdpi/*
   src/conformance/platform_specific/android_resources/mipmap-xhdpi/*
   src/conformance/platform_specific/android_resources/mipmap-xxhdpi/*
   src/conformance/platform_specific/android_resources/mipmap-xxxhdpi/*
-Copyright: 2020-2023, The Khronos Group Inc.
+Copyright: 2020-2024, The Khronos Group Inc.
   2020, Google
 License: Apache-2.0
 Comment: Generated .png versions of an icon, created in Android Studio
   based on a Material Icons asset.
 
 Files: specification/scripts/vuidCounts.py
-Copyright: 2022-2023, The Khronos Group Inc.
+Copyright: 2022-2024, The Khronos Group Inc.
 License: Apache-2.0
 Comment: File automatically rewritten by VUID assignment.
diff --git a/CHANGELOG.Docs.md b/CHANGELOG.Docs.md
@@ -1,7 +1,7 @@
 # Changelog for OpenXR-Docs and OpenXR-Registry Repos
 
 <!--
-Copyright (c) 2019-2023, The Khronos Group Inc.
+Copyright (c) 2019-2024, The Khronos Group Inc.
 
 SPDX-License-Identifier: CC-BY-4.0
 -->
@@ -17,6 +17,67 @@ any public pull requests that have been accepted.
 This changelog only lists changes that affect the registry,
 headers, and/or specification text.
 
+## OpenXR Specification 1.0.33 (2024-01-03)
+
+This release primarily adds new ratified functionality to the specification
+describing the loader interaction with runtimes and API layers. This
+functionality was previously described in non-normative text in the loader
+design document, but was universally adopted for compatibility. It is now part
+of the normative, ratified core specification. This change only affects vendors
+of runtimes and API layers as well as contributors to the OpenXR loader:
+applications do not directly use this API, the loader uses it on their behalf. A
+number of other small fixes are also included.
+
+- Registry
+  - Extension reservation: Update author ID and reserve extensions for Varjo.
+    ([internal MR 3083](https://gitlab.khronos.org/openxr/openxr/merge_requests/3083))
+  - Extension reservation: Reserve 10 extension ids each for `ANDROIDX` &
+    `ANDROIDSYS`.
+    ([internal MR 3086](https://gitlab.khronos.org/openxr/openxr/merge_requests/3086))
+  - Khronos ratified addition: Specify the existing loader negotiation functions
+    (without modification) in the XML, moving from `loader_interfaces.h` to a new
+    generated header `openxr_loader_negotiation.h`.
+    ([internal MR 2807](https://gitlab.khronos.org/openxr/openxr/merge_requests/2807),
+    [internal issue 1953](https://gitlab.khronos.org/openxr/openxr/issues/1953))
+  - `XR_KHR_android_thread_settings`: Fix the description of
+    `XrAndroidThreadTypeKHR` enum values - they were swapped relative to their
+    implicit meaning from their name.
+    ([internal MR 3077](https://gitlab.khronos.org/openxr/openxr/merge_requests/3077))
+  - `XR_MNDX_egl_enable`: Update version to 2 to reflect function pointer type
+    change released in 1.0.29.
+    ([OpenXR-Docs PR 159](https://github.com/KhronosGroup/OpenXR-Docs/pull/159))
+- Specification
+  - Khronos ratified specification addition: move loader negotiation functions into
+    the specification proper (from the loader design doc), moving corresponding
+    functions from `loader_interfaces.h` to `openxr_loader_negotiation.h`. (The
+    exact ratified core specification text is 1.0.29 with these changes added,
+    available internally. Non-substantive core specification updates/fixes have
+    occurred since then.)
+    ([internal MR 2807](https://gitlab.khronos.org/openxr/openxr/merge_requests/2807),
+    [internal issue 1953](https://gitlab.khronos.org/openxr/openxr/issues/1953),
+    [internal MR 3101](https://gitlab.khronos.org/openxr/openxr/merge_requests/3101))
+  - Scripts: Adjust Makefile so we now error on any checkSpecLinks warning when
+    running that target.
+    ([internal MR 3072](https://gitlab.khronos.org/openxr/openxr/merge_requests/3072))
+  - `XR_HTC_anchor`: Fix parameter name error in prose description.
+    ([internal MR 3072](https://gitlab.khronos.org/openxr/openxr/merge_requests/3072))
+  - `XR_KHR_android_thread_settings`: Fix the description of
+    `XrAndroidThreadTypeKHR` enum values - they were swapped relative to their
+    implicit meaning from their name.
+    ([internal MR 3077](https://gitlab.khronos.org/openxr/openxr/merge_requests/3077))
+  - `XR_MNDX_egl_enable`: Update revision info and version to 2 to reflect function
+    pointer type change released in 1.0.29.
+    ([OpenXR-Docs PR 159](https://github.com/KhronosGroup/OpenXR-Docs/pull/159))
+  - loader design doc: Fix minor typos.
+    ([internal MR 3065](https://gitlab.khronos.org/openxr/openxr/merge_requests/3065),
+    [internal MR 3103](https://gitlab.khronos.org/openxr/openxr/merge_requests/3103))
+- Misc
+  - Update/correct names.
+  - Ship a `.mailmap` file in the public repositories, maintained separately
+    from the larger one used in the private monorepo, to correct names/emails
+    and unify contributor identities.
+  - Update Khronos Group copyright dates.
+
 ## OpenXR Specification 1.0.32 (2023-11-29)
 
 This release contains a number of vendor extensions, plus a new ratified

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,6 +1,6 @@
 
 <!--
-Copyright (c) 2014-2023, The Khronos Group Inc.
+Copyright (c) 2014-2024, The Khronos Group Inc.
 
 SPDX-License-Identifier: CC-BY-4.0
 -->

diff --git a/COPYING.adoc b/COPYING.adoc
@@ -1,6 +1,6 @@
 = COPYING.adoc for the Khronos Group OpenXR projects
 
-// Copyright (c) 2020-2023, The Khronos Group Inc.
+// Copyright (c) 2020-2024, The Khronos Group Inc.
 //
 // SPDX-License-Identifier: CC-BY-4.0
 

diff --git a/LICENSES/LicenseRef-KhronosSpecCopyright-WithNormativeWording-v10.txt b/LICENSES/LicenseRef-KhronosSpecCopyright-WithNormativeWording-v10.txt
@@ -1,4 +1,4 @@
-Copyright (c) 2017-2023, The Khronos Group Inc.
+Copyright (c) 2017-2024, The Khronos Group Inc.
 
 This Specification is protected by copyright laws and contains material
 proprietary to Khronos.

diff --git a/README.adoc b/README.adoc
@@ -2,7 +2,7 @@ ifdef::env-github[]
 :note-caption: :information_source:
 endif::[]
 
-// Copyright (c) 2017-2023, The Khronos Group Inc.
+// Copyright (c) 2017-2024, The Khronos Group Inc.
 //
 // SPDX-License-Identifier: CC-BY-4.0
 

diff --git a/changes/registry/pr.159.gh.OpenXR-Docs.md b/changes/registry/pr.159.gh.OpenXR-Docs.md
diff --git a/changes/specification/pr.159.gh.OpenXR-Docs.md b/changes/specification/pr.159.gh.OpenXR-Docs.md
diff --git a/checkCodespell b/checkCodespell
@@ -1,6 +1,6 @@
 #!/bin/sh
 #
-# Copyright (c) 2019-2023, The Khronos Group Inc.
+# Copyright (c) 2019-2024, The Khronos Group Inc.
 #
 # SPDX-License-Identifier: Apache-2.0
 #

diff --git a/include/generated_header_list.txt b/include/generated_header_list.txt
@@ -1,4 +1,5 @@
 openxr.h
+openxr_loader_negotiation.h
 openxr_platform.h
 openxr_reflection.h
 openxr_reflection_structs.h

diff --git a/include/generated_header_list.txt.license b/include/generated_header_list.txt.license
@@ -1,4 +1,4 @@
-Copyright (c) 2017-2023, The Khronos Group Inc.
+Copyright (c) 2017-2024, The Khronos Group Inc.
 
 SPDX-License-Identifier: Apache-2.0
 

diff --git a/include/openxr/openxr_platform_defines.h b/include/openxr/openxr_platform_defines.h
@@ -1,5 +1,5 @@
 /*
-** Copyright (c) 2017-2023, The Khronos Group Inc.
+** Copyright (c) 2017-2024, The Khronos Group Inc.
 **
 ** SPDX-License-Identifier: Apache-2.0 OR MIT
 */

diff --git a/open-in-docker.sh b/open-in-docker.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-# Copyright (c) 2019-2023, The Khronos Group Inc.
+# Copyright (c) 2019-2024, The Khronos Group Inc.
 # Copyright (c) 2019 Collabora, Ltd.
 # SPDX-License-Identifier: Apache-2.0
 

diff --git a/openxr-codespell.exclude b/openxr-codespell.exclude
@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2023, The Khronos Group Inc.
+# Copyright (c) 2017-2024, The Khronos Group Inc.
 #
 # SPDX-License-Identifier: CC-BY-4.0
 # Lines that should be excluded from codespell - trailing newline required!

diff --git a/specification/.gitignore b/specification/.gitignore
@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2023, The Khronos Group Inc.
+# Copyright (c) 2017-2024, The Khronos Group Inc.
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -12,6 +12,7 @@ diffs/
 # Artifacts from converting/checking RELAX-NG Compact schema.
 registry/registry.rng
 registry/regenerated.rnc
+registry/regenerated.rnc.backup
 
 # Schematron-related files
 registry/schxslt-cli.jar

diff --git a/specification/Gemfile b/specification/Gemfile
@@ -1,4 +1,4 @@
-# Copyright (c) 2022-2023, The Khronos Group Inc.
+# Copyright (c) 2022-2024, The Khronos Group Inc.
 #
 # SPDX-License-Identifier: Apache-2.0
 

diff --git a/specification/Makefile b/specification/Makefile
@@ -1,4 +1,4 @@
-# Copyright 2013-2023 The Khronos Group Inc.
+# Copyright 2013-2024, The Khronos Group Inc.
 #
 # SPDX-License-Identifier: Apache-2.0
 
@@ -32,7 +32,7 @@ ifneq (,$(strip $(VERY_STRICT)))
 ASCIIDOC := $(ASCIIDOC) --failure-level WARN
 endif
 
-SPECREVISION = 1.0.32
+SPECREVISION = 1.0.33
 REVISION_COMPONENTS = $(subst ., ,$(SPECREVISION))
 MAJORMINORVER = $(word 1,$(REVISION_COMPONENTS)).$(word 2,$(REVISION_COMPONENTS))
 
@@ -133,10 +133,11 @@ config_stamp:
 HEADER_DIR    := $(OUTDIR)/openxr
 HEADER	      := $(HEADER_DIR)/openxr.h
 PLATHEAD      := $(HEADER_DIR)/openxr_platform.h
+LOADERHEAD    := $(HEADER_DIR)/openxr_loader_negotiation.h
 REFLECTHEADERS:= $(HEADER_DIR)/openxr_reflection.h \
                  $(HEADER_DIR)/openxr_reflection_structs.h \
                  $(HEADER_DIR)/openxr_reflection_parent_structs.h
-GENHEADERS    := $(HEADER) $(PLATHEAD) $(REFLECTHEADERS)
+GENHEADERS    := $(HEADER) $(PLATHEAD) $(LOADERHEAD) $(REFLECTHEADERS)
 DEFINESHEAD   := $(HEADER_DIR)/openxr_platform_defines.h
 
 # Platform header (just copy)
@@ -535,7 +536,7 @@ CHECK_MARKUP_SCRIPT = $(CURDIR)/checkMarkup
 # Edit the following line's "ignore_count" when the number of checkSpecLinks errors changes,
 # either by reducing (ensuring we keep the improvement)
 # or by increasing (if there's an error we can't resolve right now and don't want to break CI)
-CHECK_SPEC_LINKS_SCRIPT = $(CURDIR)/scripts/check_spec_links.py --ignore_count=0 -Wall --include_warn
+CHECK_SPEC_LINKS_SCRIPT = $(CURDIR)/scripts/check_spec_links.py --ignore_count=0 -Wall --include_warn -Werror
 # -Werror disabled for now because there are ~14 -Wrefpage_missing messages.
 # Would like those in the logs, but not in the count for build-breaking.
 
@@ -631,7 +632,7 @@ clean_generated:
 
 # Clean generated targets as well as intermediates.
 clean clobber: clean_dirt clean_generated
-	$(RM) $(HEADER) $(PLATHEAD) $(REFLECTHEADERS) $(DEFINESHEAD) $(HTMLSPEC) $(PDFSPEC) $(PDFA4SPEC) $(STYLEGUIDE) $(LOADERGUIDE) $(CONFIG_STAMP_FN)
+	$(RM) $(HEADER) $(PLATHEAD) $(LOADERHEAD) $(REFLECTHEADERS) $(DEFINESHEAD) $(HTMLSPEC) $(PDFSPEC) $(PDFA4SPEC) $(STYLEGUIDE) $(LOADERGUIDE) $(CONFIG_STAMP_FN)
 	# Clean up extracted code
 	if [ -f $(EXAMPLES_MAKEFILE) ]; then $(MAKE) -f $(EXAMPLES_MAKEFILE) clean-examples; fi
 	$(RM) $(EXAMPLES_MAKEFILE)

diff --git a/specification/README.md b/specification/README.md
@@ -1,7 +1,7 @@
 # Building the OpenXR Specification
 
 <!--
-Copyright 2014-2023 The Khronos Group Inc.
+Copyright 2014-2024, The Khronos Group Inc.
 
 SPDX-License-Identifier: CC-BY-4.0
 -->

diff --git a/specification/checkMarkup b/specification/checkMarkup
@@ -1,6 +1,6 @@
 #!/bin/sh
 #
-# Copyright (c) 2018-2023, The Khronos Group Inc.
+# Copyright (c) 2018-2024, The Khronos Group Inc.
 #
 # SPDX-License-Identifier: Apache-2.0
 #

diff --git a/specification/checkSchematron.sh b/specification/checkSchematron.sh
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# Copyright (c) 2019-2023, The Khronos Group Inc.
+# Copyright (c) 2019-2024, The Khronos Group Inc.
 #
 # SPDX-License-Identifier: Apache-2.0
 #

diff --git a/specification/checkSpecLinks b/specification/checkSpecLinks
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# Copyright (c) 2018-2023, The Khronos Group Inc.
+# Copyright (c) 2018-2024, The Khronos Group Inc.
 #
 # SPDX-License-Identifier: Apache-2.0
 #

diff --git a/specification/checkXml.sh b/specification/checkXml.sh
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# Copyright (c) 2019-2023, The Khronos Group Inc.
+# Copyright (c) 2019-2024, The Khronos Group Inc.
 #
 # SPDX-License-Identifier: Apache-2.0
 #
@@ -71,7 +71,7 @@ if $HAVE_TRANG; then
     echo "Converting $RNG back into $REGEN_RNC (formatted, but with some missing blank lines)"
     trang -o indent=4 $RNG $REGEN_RNC
     # Remove trailing whitespace from regenerated RNC
-    sed -i 's/ *$//' $REGEN_RNC
+    sed -i.backup 's/ *$//' $REGEN_RNC
 else
     echo "Recommend installing 'trang' for schema syntax checking and rnc <-> rng conversions."
 fi

diff --git a/specification/config/attribs.adoc b/specification/config/attribs.adoc
@@ -1,4 +1,4 @@
-// Copyright (c) 2015-2023, The Khronos Group Inc.
+// Copyright (c) 2015-2024, The Khronos Group Inc.
 //
 // SPDX-License-Identifier: CC-BY-4.0