Merge branch 'devel' into approved

KhronosGroup · Jun 6, 2024 · c761ade · c761ade
2 parents 14902d8 + c42343f
commit c761ade
Show file tree

Hide file tree

Showing 138 changed files with 1,534 additions and 560 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -25,8 +25,9 @@
 *.png     binary
 
 # git-lfs big files
-*.pdf filter=lfs diff=lfs merge=lfs -text
-*.glb filter=lfs diff=lfs merge=lfs -text
+*.pdf                    filter=lfs diff=lfs merge=lfs -text
+*.glb                    filter=lfs diff=lfs merge=lfs -text
+src/conformance/**/*.png filter=lfs diff=lfs merge=lfs -text
 
 # Shell/python scripts that don't end in .sh
 specification/makeAllExts           eol=lf

diff --git a/.gitignore b/.gitignore
@@ -21,6 +21,7 @@ generated-includes
 cmake_install.cmake
 cmake_uninstall.cmake
 cmake-build-*
+specification/vendor/bundle/
 
 # Marker file for a snapshot build
 SNAPSHOT

diff --git a/CHANGELOG.CTS.md b/CHANGELOG.CTS.md
@@ -17,6 +17,51 @@ particular, since it is primarily software, pull requests may be integrated as
 they are accepted even between periodic updates. However, versions that are not
 signed tags on the `approved` branch are not valid for conformance submission.
 
+## OpenXR CTS 1.1.37.0 (2024-06-06)
+
+- Conformance Tests
+  - Fix: Action test when constrained to right-hand only.
+    ([internal MR 3244](https://gitlab.khronos.org/openxr/openxr/merge_requests/3244))
+  - Fix: Skip StereoWithFoveatedInset-interactive if runtime does not support it.
+    ([internal MR 3350](https://gitlab.khronos.org/openxr/openxr/merge_requests/3350))
+  - Fix: Dangling pointer in action test.
+    ([internal MR 3357](https://gitlab.khronos.org/openxr/openxr/merge_requests/3357))
+  - Fix: Resolve Vulkan validation warning in some tests.
+    ([internal MR 3367](https://gitlab.khronos.org/openxr/openxr/merge_requests/3367))
+  - Improvement: Use absolute epsilons for pose comparison in action test.
+    ([internal MR 3244](https://gitlab.khronos.org/openxr/openxr/merge_requests/3244))
+  - Improvement: Improve user message in action test.
+    ([internal MR 3244](https://gitlab.khronos.org/openxr/openxr/merge_requests/3244))
+  - Improvement: Only suggest binding the proceed action to ".../click" binding
+    paths, rather than all binding paths of boolean type, to avoid accidental
+    activation.
+    ([internal MR 3312](https://gitlab.khronos.org/openxr/openxr/merge_requests/3312))
+  - Improvement: Support hiding parts of models in the glTF/PBR subsystem.
+    ([internal MR 3314](https://gitlab.khronos.org/openxr/openxr/merge_requests/3314))
+  - Improvement: Code cleanup.
+    ([internal MR 3323](https://gitlab.khronos.org/openxr/openxr/merge_requests/3323))
+  - Improvement: Use new `XR_API_VERSION_1_0` and `XR_API_VERSION_1_1` defines.
+    ([internal MR 3329](https://gitlab.khronos.org/openxr/openxr/merge_requests/3329))
+  - Improvement: Relax too strict palm/grip_surface pose assumptions.
+    ([internal MR 3345](https://gitlab.khronos.org/openxr/openxr/merge_requests/3345))
+  - Improvement: Add missing extension name tags to test cases.
+    ([internal MR 3355](https://gitlab.khronos.org/openxr/openxr/merge_requests/3355))
+  - Improvement: Code cleanup and documentation in helper utilities.
+    ([internal MR 3356](https://gitlab.khronos.org/openxr/openxr/merge_requests/3356))
+  - Improvement: Code cleanups and clang-tidy fixes.
+    ([internal MR 3357](https://gitlab.khronos.org/openxr/openxr/merge_requests/3357),
+    [internal MR 3357](https://gitlab.khronos.org/openxr/openxr/merge_requests/3357))
+  - Improvement: Improve readability of test sources.
+    ([internal MR 3358](https://gitlab.khronos.org/openxr/openxr/merge_requests/3358))
+  - Improvement: Fix duplicated inaccurate code comment.
+    ([internal MR 3372](https://gitlab.khronos.org/openxr/openxr/merge_requests/3372))
+  - New test: Add interactive tests for `XR_KHR_composition_layer_equirect` and
+    `XR_KHR_composition_layer_equirect2`.
+    ([internal MR 2882](https://gitlab.khronos.org/openxr/openxr/merge_requests/2882))
+  - New test: Add test which creates a session but does not call
+    `xrDestroySession`.
+    ([internal MR 3247](https://gitlab.khronos.org/openxr/openxr/merge_requests/3247))
+
 ## OpenXR CTS 1.1.36.0 (2024-04-25)
 
 This new release supports testing both OpenXR 1.0 and OpenXR 1.1 runtimes, and

diff --git a/maintainer-scripts/common.sh b/maintainer-scripts/common.sh
@@ -154,6 +154,7 @@ getSDKSourceFilenames() {
         checkCodespell \
         CMakeLists.txt \
         format_file.sh \
+        open-in-docker.sh \
         LICENSE \
         openxr-codespell.exclude \
         runClangFormat.sh \

diff --git a/specification/Makefile b/specification/Makefile
@@ -7,7 +7,13 @@ SHELL = /usr/bin/env bash
 QUIET      ?= @
 VERYQUIET  ?= @
 PYTHON	   ?= python3
+ifneq (,$(strip $(BUNDLER)))
+ASCIIDOC   ?= bundle exec asciidoctor --trace
+HEXAPDF    ?= bundle exec hexapdf
+else
 ASCIIDOC   ?= asciidoctor
+HEXAPDF    ?= hexapdf
+endif
 RM          = rm -f
 RMRF        = rm -rf
 MKDIR       = mkdir -p
@@ -33,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.36
+SPECREVISION = 1.1.37
 REVISION_COMPONENTS = $(subst ., ,$(SPECREVISION))
 MAJORMINORVER = $(word 1,$(REVISION_COMPONENTS)).$(word 2,$(REVISION_COMPONENTS))
 
@@ -343,7 +349,7 @@ pdfA4: $(PDFA4SPEC)
 ASCIIDOCTOR_TARGETS += $(PDFSPEC) $(PDFA4SPEC)
 
 # Target-specific variables and deps customizing the AsciiDoctor rule
-$(PDFSPEC) $(PDFA4SPEC): BACKEND_ARGS=--backend pdf --require asciidoctor-pdf -a compress  -r ./scripts/pdf-index-customizer.rb
+$(PDFSPEC) $(PDFA4SPEC): BACKEND_ARGS=--backend pdf --require asciidoctor-pdf -a compress --require ./scripts/pdf-index-customizer.rb
 $(PDFSPEC): PAGESIZE=LETTER
 $(PDFA4SPEC): PAGESIZE=A4
 $(PDFSPEC) $(PDFA4SPEC): $(COMMONDOCS)
@@ -647,14 +653,17 @@ $(REGISTRYOUTDIR)/headers/openxr: | $(REGISTRYOUTDIR)/headers
 	$(QUIET)$(MKDIR) "$@"
 
 release-htmlpdf: html pdf $(REGISTRYOUTDIR)/pdf $(REGISTRYOUTDIR)/html
-	-asciidoctor-pdf-optimize $(PDFSPEC)
-	$(QUIET)$(CP) $(PDFSPEC) $(REGISTRYOUTDIR)/pdf/$(SPEC_FILENAME_STEM).pdf
+	$(ECHO) "[hexapdf]     $(call MAKE_RELATIVE,$(REGISTRYOUTDIR)/pdf/$(SPEC_FILENAME_STEM).pdf)"
+	$(QUIET)$(HEXAPDF) optimize --force $(PDFSPEC) $(REGISTRYOUTDIR)/pdf/$(SPEC_FILENAME_STEM).pdf
+	$(ECHO) "[cp]          $(call MAKE_RELATIVE,$(REGISTRYOUTDIR)/html/$(SPEC_FILENAME_STEM).html)"
 	$(QUIET)$(CP) $(HTMLSPEC) $(REGISTRYOUTDIR)/html/$(SPEC_FILENAME_STEM).html
 .PHONY: release-htmlpdf
 
 
 release: release-htmlpdf manhtmlpages loader styleguide extprocess | $(REGISTRYOUTDIR) $(REGISTRYOUTDIR)/man
+	$(ECHO) "[cp]          $(call MAKE_RELATIVE,$(REGISTRYOUTDIR))/{styleguide,extprocess,loader}.html"
 	$(QUIET)$(CP) $(OUTDIR)/styleguide.html $(OUTDIR)/extprocess.html $(OUTDIR)/loader.html $(REGISTRYOUTDIR)
+	$(ECHO) "[cp]          $(REGISTRYOUTDIR)/man/html"
 	$(QUIET)$(CP) -R $(MANHTMLDIR) $(REGISTRYOUTDIR)/man/html
 .PHONY: release
 

diff --git a/specification/README.md b/specification/README.md
@@ -8,10 +8,13 @@ SPDX-License-Identifier: CC-BY-4.0
 
 Before building the specification, install the necessary prerequisite tools as described later in this document.
 
-You may instead choose to use the `open-in-docker.sh` script,
-which will mount the repository in a container built from an image with all the necessary tools installed.
-See that script for more details.
-You can find the associated Dockerfile at https://github.com/KhronosGroup/DockerContainers/blob/master/Dockerfile.openxr
+You may instead choose to use the `open-in-docker.sh` script, available in the
+OpenXR-Docs (spec source) and OpenXR-SDK-Source (SDK, for loader docs build)
+repo as well as the internal monorepo. This script which will mount the
+repository in a container built from an image with all the necessary tools
+installed: these are regularly pushed to Docker Hub. See that script for more
+details. You can find the associated Dockerfile at
+<https://github.com/KhronosGroup/DockerContainers/blob/main/openxr.Dockerfile>
 
 ## Conditional Inclusion of Extensions
 
@@ -91,6 +94,10 @@ specified by the Makefile variable `$(OUTDIR)` (by default,
 It is recommended to build these targets using a "helper" script from above,
 unless you want to only build the core spec without any extensions.
 
+Most of these are not supported if building in `OpenXR-SDK-Source`: this
+repository is mostly software, and the only contained AsciiDoc content is the
+loader design document source.
+
 These targets are currently supported.
 
 * API spec:
@@ -119,6 +126,10 @@ For example:
 make styleguide
 ```
 
+Many of these are not supported if building in `OpenXR-SDK-Source`: this
+repository is mostly software, and the only contained AsciiDoc content is the
+loader design document source.
+
 * "OpenXR Documentation and Extensions" guide (aka Style Guide):
   * `styleguide` - Single-file HTML5 in `$(OUTDIR)/styleguide.html`
 * OpenXR Extensions Process guide:
@@ -219,7 +230,8 @@ parts you don't use) completely before trying to install.
 > Asciidoctor-pdf versions before `1.5.0.alpha15` have issues with multi-page
 valid usage blocks, in that the background only renders for the first page.
 `alpha.15` fixes this issue (as well as a few others); do not use prior
-versions.
+versions. On the other hand, versions later than 1.6.2 break our index
+customization script, so 1.6.2 is ideal.
 
 Only the `asciidoctor` and `rouge` gems (and their dependencies) are needed if
 you do not intend to build PDF versions of the spec and supporting documents.
@@ -230,6 +242,14 @@ people submitting MRs with substantial changes to the Specification are
 responsible for verifying that their branches build *both* `html` and `pdf`
 targets.
 
+The easiest way to get the right version of these gems is to use "bundler":
+
+```sh
+bundle install
+```
+
+Then, pass `BUNDLER=1` to each `make` (or wrapper script) invocation.
+
 ### Platforms and System Packages
 
 #### Windows

diff --git a/specification/registry/xr.xml b/specification/registry/xr.xml
@@ -58,6 +58,7 @@ maintained in the default branch of the Khronos OpenXR GitHub project.
         <tag name="OPPO"       author="OPPO"                  contact="Buyi Xu @fantastxu, Haomiao Jiang @hjiang36"/>
         <tag name="PLUTO"      author="Pluto VR"              contact="Jared Cheshier @Jared, Sophia Baldonado @sophia"/>
         <tag name="QCOM"       author="Qualcomm Technologies" contact="Armelle @alaine_qcom, Martin Renschler @martinr"/>
+        <tag name="RZR"        author="Razer"                 contact="Alexandre Hulsken @ahulsken, Eric Vezzoli @EricVezzoli"/>
         <tag name="STARBREEZE" author="Starbreeze"            contact="David Srour @dsrour"/>
         <tag name="TOBII"      author="Tobii"                 contact="Denny Rönngren @denron"/>
         <tag name="ULTRALEAP"  author="Ultraleap"             contact="Robert Blenkinsopp @rblenkinsopp"/>
@@ -133,7 +134,16 @@ maintained in the default branch of the Khronos OpenXR GitHub project.
         updates them automatically by processing a line at a time.
         -->
         <type category="define">// OpenXR current version number.
-#define <name>XR_CURRENT_API_VERSION</name> <type>XR_MAKE_VERSION</type>(1, 1, 36)</type>
+#define <name>XR_CURRENT_API_VERSION</name> <type>XR_MAKE_VERSION</type>(1, 1, 37)</type>
+
+        <!--
+        Defines for a fixed major.minor version of OpenXR preserving the shared patch version.
+        -->
+        <type category="define">// OpenXR 1.0 version number
+#define <name>XR_API_VERSION_1_0</name> <type>XR_MAKE_VERSION</type>(1, 0, XR_VERSION_PATCH(XR_CURRENT_API_VERSION))</type>
+
+        <type category="define">// OpenXR 1.1 version number
+#define <name>XR_API_VERSION_1_1</name> <type>XR_MAKE_VERSION</type>(1, 1, XR_VERSION_PATCH(XR_CURRENT_API_VERSION))</type>
 
         <!--
         NOTE: For avoidance of ambiguity, there should only be 1 <name> tag immediately in
@@ -7658,6 +7668,7 @@ typedef XrResult (XRAPI_PTR *<name>PFN_xrCreateApiLayerInstance</name>)(
         </require>
         <require comment="API version">
             <type name="XR_CURRENT_API_VERSION"/>
+            <type name="XR_API_VERSION_1_0"/>
             <type name="XR_VERSION_MAJOR"/>
             <type name="XR_VERSION_MINOR"/>
             <type name="XR_VERSION_PATCH"/>
@@ -7844,6 +7855,10 @@ typedef XrResult (XRAPI_PTR *<name>PFN_xrCreateApiLayerInstance</name>)(
 
 
     <feature api="openxr" name="XR_VERSION_1_1" number="1.1">
+        <require comment="API version">
+            <type name="XR_API_VERSION_1_1"/>
+        </require>
+
         <require comment="Promoted from XR_KHR_maintenance1">
 
             <!-- new structs -->
@@ -8627,7 +8642,7 @@ typedef XrResult (XRAPI_PTR *<name>PFN_xrCreateApiLayerInstance</name>)(
 
     <extension name="XR_FB_composition_layer_alpha_blend" number="42" type="instance" supported="openxr">
         <require>
-            <enum value="2"                                               name="XR_FB_composition_layer_alpha_blend_SPEC_VERSION"/>
+            <enum value="3"                                               name="XR_FB_composition_layer_alpha_blend_SPEC_VERSION"/>
             <enum value="&quot;XR_FB_composition_layer_alpha_blend&quot;" name="XR_FB_COMPOSITION_LAYER_ALPHA_BLEND_EXTENSION_NAME"/>
             <type name="XrBlendFactorFB"/>
             <type name="XrCompositionLayerAlphaBlendFB"/>
@@ -10612,6 +10627,12 @@ typedef XrResult (XRAPI_PTR *<name>PFN_xrCreateApiLayerInstance</name>)(
             <extend interaction_profile_path="/interaction_profiles/oculus/touch_controller">
                 <component subpath="/input/palm_ext/pose"   type="XR_ACTION_TYPE_POSE_INPUT"/>
             </extend>
+            <extend interaction_profile_path="/interaction_profiles/facebook/touch_controller_pro">
+                <component subpath="/input/palm_ext/pose"   type="XR_ACTION_TYPE_POSE_INPUT"/>
+            </extend>
+            <extend interaction_profile_path="/interaction_profiles/meta/touch_controller_plus">
+                <component subpath="/input/palm_ext/pose"   type="XR_ACTION_TYPE_POSE_INPUT"/>
+            </extend>
             <extend interaction_profile_path="/interaction_profiles/valve/index_controller">
                 <component subpath="/input/palm_ext/pose"   type="XR_ACTION_TYPE_POSE_INPUT"/>
             </extend>
@@ -15214,6 +15235,55 @@ typedef XrResult (XRAPI_PTR *<name>PFN_xrCreateApiLayerInstance</name>)(
         </require>
     </extension>
 
+    <extension name="XR_EXT_spatial_anchor" number="739" type="instance" supported="disabled">
+        <require>
+            <enum value="1"                                 name="XR_EXT_spatial_anchor_SPEC_VERSION"/>
+            <enum value="&quot;XR_EXT_spatial_anchor&quot;" name="XR_EXT_SPATIAL_ANCHOR_EXTENSION_NAME"/>
+        </require>
+    </extension>
+
+    <extension name="XR_EXT_spatial_anchor_persistence" number="740" type="instance" supported="disabled">
+        <require>
+            <enum value="1"                                             name="XR_EXT_spatial_anchor_persistence_SPEC_VERSION"/>
+            <enum value="&quot;XR_EXT_spatial_anchor_persistence&quot;" name="XR_EXT_SPATIAL_ANCHOR_PERSISTENCE_EXTENSION_NAME"/>
+        </require>
+    </extension>
+
+    <extension name="XR_EXT_spatial_entity" number="741" type="instance" supported="disabled">
+        <require>
+            <enum value="1"                                 name="XR_EXT_spatial_entity_SPEC_VERSION"/>
+            <enum value="&quot;XR_EXT_spatial_entity&quot;" name="XR_EXT_SPATIAL_ENTITY_EXTENSION_NAME"/>
+        </require>
+    </extension>
+
+    <extension name="XR_EXT_spatial_entity_discovery" number="742" type="instance" supported="disabled">
+        <require>
+            <enum value="1"                                           name="XR_EXT_spatial_entity_discovery_SPEC_VERSION"/>
+            <enum value="&quot;XR_EXT_spatial_entity_discovery&quot;" name="XR_EXT_SPATIAL_ENTITY_DISCOVERY_EXTENSION_NAME"/>
+        </require>
+    </extension>
+
+    <extension name="XR_EXT_extension_743" number="743" type="instance" supported="disabled">
+        <require>
+            <enum value="1"                                name="XR_EXT_extension_743_SPEC_VERSION"/>
+            <enum value="&quot;XR_EXT_extension_743&quot;" name="XR_EXT_EXTENSION_743_EXTENSION_NAME"/>
+        </require>
+    </extension>
+
+    <extension name="XR_EXT_extension_744" number="744" type="instance" supported="disabled">
+        <require>
+            <enum value="1"                                name="XR_EXT_extension_744_SPEC_VERSION"/>
+            <enum value="&quot;XR_EXT_extension_744&quot;" name="XR_EXT_EXTENSION_744_EXTENSION_NAME"/>
+        </require>
+    </extension>
+
+    <extension name="XR_EXT_extension_745" number="745" type="instance" supported="disabled">
+        <require>
+            <enum value="1"                                name="XR_EXT_extension_745_SPEC_VERSION"/>
+            <enum value="&quot;XR_EXT_extension_745&quot;" name="XR_EXT_EXTENSION_745_EXTENSION_NAME"/>
+        </require>
+    </extension>
+
     </extensions>
 
 </registry>
diff --git a/specification/scripts/extensionmetadocgenerator.py b/specification/scripts/extensionmetadocgenerator.py
@@ -154,6 +154,7 @@ def specLink(self, xrefName, xrefText, isRefpage = False):
 
     def conditionalLinkCoreAPI(self, apiVersion, linkSuffix, isRefpage):
         versionMatch = re.match(f"{self.conventions.api_version_prefix}(\\d+)_(\\d+)", apiVersion)
+        assert versionMatch
         major = versionMatch.group(1)
         minor = versionMatch.group(2)
 
@@ -295,9 +296,7 @@ def makeMetafile(self, extensions, SPV_deps, isRefpage = False):
                 separator = ''
             else:
                 separator = '+'
-            write(separator + '\n--\n' +
-                  dependencyMarkup(self.depends) +
-                  '--', file=fp)
+            write(f"{separator}\n--\n{dependencyMarkup(self.depends)}--", file=fp)
         else:
             # Do not specify the base API redundantly, but put something
             # here to avoid formatting trouble.
@@ -328,10 +327,7 @@ def versionKey(name):
 
             names = sorted(sorted(interacts), key=versionKey)
             for name in names:
-                if "_VERSION_" in name:
-                    write(f"* Interacts with {self.conventions.formatVersion(name)}", file=fp)
-                else:
-                    write(f"* Interacts with {self.conventions.formatExtension(name)}", file=fp)
+                write(f"* Interacts with {self.conventions.formatVersionOrExtension(name)}", file=fp)
 
         if self.name in SPV_deps:
             self.writeTag('SPIR-V Dependencies', None, isRefpage, fp)

diff --git a/specification/scripts/parse_dependency.py b/specification/scripts/parse_dependency.py
@@ -126,7 +126,7 @@ def push_first(toks):
     exprStack.append(toks[0])
 
 # An identifier (version or extension name)
-dependencyIdent = Word(alphanums + '_')
+dependencyIdent = Word(f"{alphanums}_")
 
 # Infix expression for depends expressions
 dependencyExpr = pp.infixNotation(dependencyIdent,
@@ -303,7 +303,7 @@ def markupTraverse(expr, level = 0, root = True):
        - root - True only on initial call"""
 
     if level > 0:
-        prefix = '{nbsp}{nbsp}' * level * 2 + ' '
+        prefix = f"{'{nbsp}{nbsp}' * level * 2} "
     else:
         prefix = ''
     str = ''
@@ -318,9 +318,9 @@ def markupTraverse(expr, level = 0, root = True):
 
             str = str + markupTraverse(elem, level = nextlevel, root = False)
         elif elem in ('+', ','):
-            str = str + f'{prefix}{opMarkupAsciidoc(elem)} +\n'
+            str = f"{str}{prefix}{opMarkupAsciidoc(elem)} +\n"
         else:
-            str = str + f'{prefix}{leafMarkupAsciidoc(elem)} +\n'
+            str = f"{str}{prefix}{leafMarkupAsciidoc(elem)} +\n"
 
     return str