OpenXR SDK 1.0.11 (2020-08-14)

This release is mainly for SDK improvements, with only small changes to
the docs. A new error code is provided for xrCreateSession for
developers convenience.

-   Registry
    -   Register ULTRALEAP author ID for Ultraleap. (internal MR 1877)
    -   Reserve the extension number 98 to 101 for future MSFT
        extensions. (internal MR 1879)
    -   schema: Distinguish parentstruct and structextends attributes in
        comments. (internal MR 1881, OpenXR-Docs/#51, internal issue
        1396)
    -   Add a new result code,
        XR_ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING, for runtimes to
        return if xrBeginSession is called before calling one of the
        xrGetGraphicsRequirements calls. (internal MR 1882,
        OpenXR-Docs/#53, internal issue 1397)
-   SDK
    -   Improve language usage in code and comments to be more
        respectful. (internal MR 1881)
    -   Loader: Correct type of “extension_version” in API layer
        manifest files to string, while maintaining backwards
        compatibility. Remove undocumented and unused
        “device_extensions” and “entrypoints” keys. (internal MR 1867,
        internal issue 1411)
    -   Replace usage of std::filesystem::canonical with
        PathCchCanonicalize on Windows platform to work around bug on
        UWP platforms. This also replaces PathCanonicalize with
        PathCchCanonicalize and adds the appropriate library for linking
        in. (OpenXR-SDK-Source/#198)
    -   Support for building more projects when targeting UWP, and
        support for all architectures when targeting Win32.
        (OpenXR-SDK-Source/#199)
    -   hello_xr: fix Vulkan image layout transitions. (internal MR
        1876)
    -   validation: Enable three additional checks (on optional arrays
        with non- optional counts) that were missing because of a script
        error. (internal MR 1881)

CHANGELOG.SDK.md

@@ -19,6 +19,49 @@ 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.0.11 (2020-08-14)
+
+This release is mainly for SDK improvements, with only small changes to the
+docs. A new error code is provided for `xrCreateSession` for developers
+convenience.
+
+- Registry
+  - Register `ULTRALEAP` author ID for Ultraleap.
+    ([internal MR 1877](https://gitlab.khronos.org/openxr/openxr/merge_requests/1877))
+  - Reserve the extension number 98 to 101 for future MSFT extensions.
+    ([internal MR 1879](https://gitlab.khronos.org/openxr/openxr/merge_requests/1879))
+  - schema: Distinguish `parentstruct` and `structextends` attributes in comments.
+    ([internal MR 1881](https://gitlab.khronos.org/openxr/openxr/merge_requests/1881),
+    [OpenXR-Docs/#51](https://github.com/KhronosGroup/OpenXR-Docs/issues/51),
+    [internal issue 1396](https://gitlab.khronos.org/openxr/openxr/issues/1396))
+  - Add a new result code, `XR_ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING`, for
+    runtimes to return if `xrBeginSession` is called before calling one of the
+    `xrGetGraphicsRequirements` calls.
+    ([internal MR 1882](https://gitlab.khronos.org/openxr/openxr/merge_requests/1882),
+    [OpenXR-Docs/#53](https://github.com/KhronosGroup/OpenXR-Docs/issues/53),
+    [internal issue 1397](https://gitlab.khronos.org/openxr/openxr/issues/1397))
+- SDK
+  - Improve language usage in code and comments to be more respectful.
+    ([internal MR 1881](https://gitlab.khronos.org/openxr/openxr/merge_requests/1881))
+  - Loader: Correct type of "extension_version" in API layer manifest files to
+    string, while maintaining backwards compatibility. Remove undocumented and
+    unused "device_extensions" and "entrypoints" keys.
+    ([internal MR 1867](https://gitlab.khronos.org/openxr/openxr/merge_requests/1867),
+    [internal issue 1411](https://gitlab.khronos.org/openxr/openxr/issues/1411))
+  - Replace usage of `std::filesystem::canonical` with `PathCchCanonicalize` on
+    Windows platform to work around bug on UWP platforms. This also replaces
+    `PathCanonicalize` with `PathCchCanonicalize` and adds the appropriate library
+    for linking in.
+    ([OpenXR-SDK-Source/#198](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/198))
+  - Support for building more projects when targeting UWP, and support for all
+    architectures when targeting Win32.
+    ([OpenXR-SDK-Source/#199](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/199))
+  - hello_xr: fix Vulkan image layout transitions.
+    ([internal MR 1876](https://gitlab.khronos.org/openxr/openxr/merge_requests/1876))
+  - validation: Enable three additional checks (on optional arrays with non-
+    optional counts) that were missing because of a script error.
+    ([internal MR 1881](https://gitlab.khronos.org/openxr/openxr/merge_requests/1881))
+
 ## OpenXR SDK 1.0.10 (2020-07-28)
 
 Note the relicensing of the registry XML file and some include files provided by

maintainer-scripts/check-changelog-fragments.sh

@@ -6,24 +6,24 @@ set -e
 
 if [ $# -eq 0 ]; then
     TOPIC=HEAD
-    MASTER=origin/master
+    MAINLINE=origin/master
 elif [ $# -eq 1 ]; then
     TOPIC=$1
-    MASTER=origin/master
+    MAINLINE=origin/master
 elif [ $# -eq 2 ]; then
     TOPIC=$1
-    MASTER=$2
+    MAINLINE=$2
 else
-    echo "$0 [<topic_branch> [<master_branch>]]" >&2
+    echo "$0 [<topic_branch> [<main_branch>]]" >&2
     exit 1
 fi
 
-BASE=$(git merge-base "${MASTER}" "${TOPIC}")
+BASE=$(git merge-base "${MAINLINE}" "${TOPIC}")
 export TOPIC
 export BASE
 
 echo "Topic branch: $TOPIC"
-echo "Compared against target branch: $MASTER"
+echo "Compared against target branch: $MAINLINE"
 echo "Merge base: $BASE"
 echo ""
 echo ""

specification/Makefile

@@ -44,7 +44,7 @@ ifneq (,$(strip $(VERY_STRICT)))
 ASCIIDOC := $(ASCIIDOC) --failure-level WARN
 endif
 
-SPECREVISION = 1.0.10
+SPECREVISION = 1.0.11
 REVISION_COMPONENTS = $(subst ., ,$(SPECREVISION))
 MAJORMINORVER = $(word 1,$(REVISION_COMPONENTS)).$(word 2,$(REVISION_COMPONENTS))
 

specification/registry/xr.xml

@@ -45,6 +45,7 @@ maintained in the master branch of the Khronos OpenXR GitHub project.
         <tag name="QCOM"       author="Qualcomm Technologies"   contact="Armelle @alaine_qcom, Martin Renschler @martinr"/>
         <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"/>
         <tag name="VALVE"      author="Valve"                   contact="Joe Ludwig @JoeLudwig"/>
         <tag name="VARJO"      author="Varjo"                   contact="Sergiy Dubovik @dubik, Rémi Arnaud @VarjoRemi"/>
     </tags>
@@ -69,7 +70,7 @@ maintained in the master branch of the Khronos OpenXR GitHub project.
         <type requires="GL/glxext.h" name="GLXFBConfig"/>
         <type requires="GL/glxext.h" name="GLXDrawable"/>
         <type requires="GL/glxext.h" name="GLXContext"/>
-        <type requires="GL/wglext.h" name="HGLRC"/>        
+        <type requires="GL/wglext.h" name="HGLRC"/>
         <type requires="unknwn.h" name="IUnknown"/>
         <type requires="wayland-client.h" name="wl_display"/>
         <type requires="windows.h" name="HDC"/>
@@ -103,7 +104,7 @@ maintained in the master 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, 0, 10)</type>
+#define <name>XR_CURRENT_API_VERSION</name> <type>XR_MAKE_VERSION</type>(1, 0, 11)</type>
 
         <!--
         NOTE: For avoidance of ambiguity, there should only be 1 <name> tag immediately in
@@ -1354,6 +1355,7 @@ maintained in the master branch of the Khronos OpenXR GitHub project.
         <enum value="-47"   name="XR_ERROR_ACTIONSETS_ALREADY_ATTACHED" comment="The session already has attached action sets." />
         <enum value="-48"   name="XR_ERROR_LOCALIZED_NAME_DUPLICATED" comment="The localized name provided was a duplicate of an already-existing resource."/>
         <enum value="-49"   name="XR_ERROR_LOCALIZED_NAME_INVALID" comment="The localized name provided was invalid."/>
+        <enum value="-50"   name="XR_ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING" comment="The xrGetGraphicsRequirements* call was not made before calling xrCreateSession."/>
         <unused start="-100"/>
     </enums>
     <enums name="XrObjectType" type="enum" comment="Enums to track objects of various types">
@@ -1638,7 +1640,7 @@ maintained in the master branch of the Khronos OpenXR GitHub project.
             <param><type>XrSystemId</type> <name>systemId</name></param>
             <param><type>XrSystemProperties</type>* <name>properties</name></param>
         </command>
-        <command successcodes="XR_SUCCESS" errorcodes="XR_ERROR_HANDLE_INVALID,XR_ERROR_INSTANCE_LOST,XR_ERROR_RUNTIME_FAILURE,XR_ERROR_OUT_OF_MEMORY,XR_ERROR_LIMIT_REACHED,XR_ERROR_INITIALIZATION_FAILED,XR_ERROR_SYSTEM_INVALID,XR_ERROR_GRAPHICS_DEVICE_INVALID,XR_ERROR_VALIDATION_FAILURE">
+        <command successcodes="XR_SUCCESS" errorcodes="XR_ERROR_HANDLE_INVALID,XR_ERROR_INSTANCE_LOST,XR_ERROR_RUNTIME_FAILURE,XR_ERROR_OUT_OF_MEMORY,XR_ERROR_LIMIT_REACHED,XR_ERROR_INITIALIZATION_FAILED,XR_ERROR_SYSTEM_INVALID,XR_ERROR_GRAPHICS_DEVICE_INVALID,XR_ERROR_VALIDATION_FAILURE,XR_ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING">
             <proto><type>XrResult</type> <name>xrCreateSession</name></proto>
             <param><type>XrInstance</type> <name>instance</name></param>
             <param>const <type>XrSessionCreateInfo</type>* <name>createInfo</name></param>
@@ -2502,7 +2504,7 @@ maintained in the master branch of the Khronos OpenXR GitHub project.
     <!-- OpenGL graphics binding extension -->
     <extension name="XR_KHR_opengl_enable" number="24" type="instance" protect="XR_USE_GRAPHICS_API_OPENGL" supported="openxr">
         <require>
-            <enum value="8" name="XR_KHR_opengl_enable_SPEC_VERSION"/>
+            <enum value="9" name="XR_KHR_opengl_enable_SPEC_VERSION"/>
             <enum value="&quot;XR_KHR_opengl_enable&quot;" name="XR_KHR_OPENGL_ENABLE_EXTENSION_NAME"/>
             <enum offset="0" extends="XrStructureType"     name="XR_TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR"/>
             <enum offset="1" extends="XrStructureType"     name="XR_TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR"/>
@@ -2523,7 +2525,7 @@ maintained in the master branch of the Khronos OpenXR GitHub project.
     <!-- OpenGL ES graphics binding extension -->
     <extension name="XR_KHR_opengl_es_enable" number="25" type="instance" protect="XR_USE_GRAPHICS_API_OPENGL_ES" supported="openxr">
         <require>
-            <enum value="6" name="XR_KHR_opengl_es_enable_SPEC_VERSION"/>
+            <enum value="7" name="XR_KHR_opengl_es_enable_SPEC_VERSION"/>
             <enum value="&quot;XR_KHR_opengl_es_enable&quot;" name="XR_KHR_OPENGL_ES_ENABLE_EXTENSION_NAME"/>
             <enum offset="1" extends="XrStructureType"     name="XR_TYPE_GRAPHICS_BINDING_OPENGL_ES_ANDROID_KHR"/>
             <enum offset="2" extends="XrStructureType"     name="XR_TYPE_SWAPCHAIN_IMAGE_OPENGL_ES_KHR"/>
@@ -2538,7 +2540,7 @@ maintained in the master branch of the Khronos OpenXR GitHub project.
     <!-- Vulkan graphics binding extension -->
     <extension name="XR_KHR_vulkan_enable" number="26" type="instance" protect="XR_USE_GRAPHICS_API_VULKAN" supported="openxr">
         <require>
-            <enum value="6" name="XR_KHR_vulkan_enable_SPEC_VERSION"/>
+            <enum value="7" name="XR_KHR_vulkan_enable_SPEC_VERSION"/>
             <enum value="&quot;XR_KHR_vulkan_enable&quot;" name="XR_KHR_VULKAN_ENABLE_EXTENSION_NAME"/>
             <enum offset="0" extends="XrStructureType"     name="XR_TYPE_GRAPHICS_BINDING_VULKAN_KHR"/>
             <enum offset="1" extends="XrStructureType"     name="XR_TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR"/>
@@ -2564,7 +2566,7 @@ maintained in the master branch of the Khronos OpenXR GitHub project.
     <!-- D3D11 graphics binding extension -->
     <extension name="XR_KHR_D3D11_enable" number="28" type="instance" protect="XR_USE_GRAPHICS_API_D3D11" supported="openxr">
         <require>
-            <enum value="4" name="XR_KHR_D3D11_enable_SPEC_VERSION"/>
+            <enum value="5" name="XR_KHR_D3D11_enable_SPEC_VERSION"/>
             <enum value="&quot;XR_KHR_D3D11_enable&quot;" name="XR_KHR_D3D11_ENABLE_EXTENSION_NAME"/>
             <enum offset="0" extends="XrStructureType"    name="XR_TYPE_GRAPHICS_BINDING_D3D11_KHR"/>
             <enum offset="1" extends="XrStructureType"    name="XR_TYPE_SWAPCHAIN_IMAGE_D3D11_KHR"/>
@@ -2579,7 +2581,7 @@ maintained in the master branch of the Khronos OpenXR GitHub project.
     <!-- D3D12 graphics binding extension -->
     <extension name="XR_KHR_D3D12_enable" number="29" type="instance" protect="XR_USE_GRAPHICS_API_D3D12" supported="openxr">
         <require>
-            <enum value="6" name="XR_KHR_D3D12_enable_SPEC_VERSION"/>
+            <enum value="7" name="XR_KHR_D3D12_enable_SPEC_VERSION"/>
             <enum value="&quot;XR_KHR_D3D12_enable&quot;" name="XR_KHR_D3D12_ENABLE_EXTENSION_NAME"/>
             <enum offset="0" extends="XrStructureType"    name="XR_TYPE_GRAPHICS_BINDING_D3D12_KHR"/>
             <enum offset="1" extends="XrStructureType"    name="XR_TYPE_SWAPCHAIN_IMAGE_D3D12_KHR"/>
@@ -3167,6 +3169,32 @@ maintained in the master branch of the Khronos OpenXR GitHub project.
             <enum bitpos="7" extends="XrSwapchainUsageFlagBits" name="XR_SWAPCHAIN_USAGE_INPUT_ATTACHMENT_BIT_MND" comment="Specifies that the image can: be used as a input attachment."/>
         </require>
     </extension>
+
+    <extension name="XR_MSFT_extension_98" number="98" type="instance" supported="disabled">
+        <require>
+            <enum value="1" name="XR_MSFT_extension_98_SPEC_VERSION"/>
+            <enum value="&quot;XR_MSFT_extension_98&quot;" name="XR_MSFT_extension_98_EXTENSION_NAME"/>
+        </require>
+    </extension>
+    <extension name="XR_MSFT_extension_99" number="99" type="instance" supported="disabled">
+        <require>
+            <enum value="1" name="XR_MSFT_extension_99_SPEC_VERSION"/>
+            <enum value="&quot;XR_MSFT_extension_99&quot;" name="XR_MSFT_extension_99_EXTENSION_NAME"/>
+        </require>
+    </extension>
+    <extension name="XR_MSFT_extension_100" number="100" type="instance" supported="disabled">
+        <require>
+            <enum value="1" name="XR_MSFT_extension_100_SPEC_VERSION"/>
+            <enum value="&quot;XR_MSFT_extension_100&quot;" name="XR_MSFT_extension_100_EXTENSION_NAME"/>
+        </require>
+    </extension>
+    <extension name="XR_MSFT_extension_101" number="101" type="instance" supported="disabled">
+        <require>
+            <enum value="1" name="XR_MSFT_extension_101_SPEC_VERSION"/>
+            <enum value="&quot;XR_MSFT_extension_101&quot;" name="XR_MSFT_extension_101_EXTENSION_NAME"/>
+        </require>
+    </extension>
+
     </extensions>
 
 </registry>

specification/scripts/cgenerator.py

@@ -304,9 +304,9 @@ def typeMayAlias(self, typeName):
                                  if data.elem.get('mayalias') == 'true')
 
             # Every type mentioned in some other type's parentstruct attribute.
-            parent_structs = (otherType.elem.get('parentstruct')
-                              for otherType in self.registry.typedict.values())
-            self.may_alias.update(set(x for x in parent_structs
+            polymorphic_bases = (otherType.elem.get('parentstruct')
+                                 for otherType in self.registry.typedict.values())
+            self.may_alias.update(set(x for x in polymorphic_bases
                                       if x is not None))
         return typeName in self.may_alias
 

specification/scripts/docgenerator.py

@@ -325,7 +325,7 @@ def genEnumTable(self, groupinfo, groupName):
             if comment:
                 got_comment = True
             elif name.endswith('_UNKNOWN') and numVal == 0:
-                # This is a dummy placeholder for 0-initialization to be clearly invalid.
+                # This is a placeholder for 0-initialization to be clearly invalid.
                 # Just skip this silently
                 continue
             else:

specification/scripts/generator.py

@@ -356,7 +356,7 @@ def enumToValue(self, elem, needsNum):
         return [None, None]
 
     def checkDuplicateEnums(self, enums):
-        """Sanity check enumerated values.
+        """Check enumerated values.
 
         -  enums - list of `<enum>` Elements
 

specification/scripts/pdf_chapter_diff.py

@@ -185,7 +185,7 @@ def compute_sections(self,
                              if x.level == level]
 
         sections = []
-        # Add a dummy section taking up all front-matter pages
+        # Add a placeholder section taking up all front-matter pages
         first_bookmark = bookmarks[0]
         if first_bookmark.page_number != 1:
             sections.append(Section(title="0. Front Matter",

specification/scripts/reflow.py

@@ -659,7 +659,7 @@ def reflowFile(filename, args):
     # Cleanup at end of file
     state.endPara(None)
 
-    # Sanity check on block nesting
+    # Check block nesting
     if len(state.blockStack) > 1:
         logWarn('file', filename,
                 'mismatched asciidoc block delimiters at EOF:',

specification/scripts/reg.py

@@ -606,9 +606,10 @@ def parseTree(self):
                 disabled_types.append(type_elem.get('name'))
         for type_elem in self.reg.findall('types/type'):
             if type_elem.get('name') not in disabled_types:
-                parentStructs = type_elem.get('structextends')
-                if parentStructs is not None:
-                    for parent in parentStructs.split(','):
+                # The structure type this may be chained to.
+                struct_extends = type_elem.get('structextends')
+                if struct_extends is not None:
+                    for parent in struct_extends.split(','):
                         # self.gen.logMsg('diag', type.get('name'), 'extends', parent)
                         self.validextensionstructs[parent].append(type_elem.get('name'))
         # Sort the lists so they don't depend on the XML order

src/api_layers/CMakeLists.txt

@@ -50,8 +50,10 @@ set_source_files_properties(
 
 set(GENERATED_OUTPUT)
 set(GENERATED_DEPENDS)
-run_xr_xml_generate(api_dump_generator.py xr_generated_api_dump.hpp)
-run_xr_xml_generate(api_dump_generator.py xr_generated_api_dump.cpp)
+run_xr_xml_generate(api_dump_generator.py xr_generated_api_dump.hpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/../scripts/automatic_source_generator.py)
+run_xr_xml_generate(api_dump_generator.py xr_generated_api_dump.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/../scripts/automatic_source_generator.py)
 
 add_library(XrApiLayer_api_dump SHARED
     api_dump.cpp
@@ -109,8 +111,10 @@ gen_xr_layer_json(
 
 set(GENERATED_OUTPUT)
 set(GENERATED_DEPENDS)
-run_xr_xml_generate(validation_layer_generator.py xr_generated_core_validation.hpp)
-run_xr_xml_generate(validation_layer_generator.py xr_generated_core_validation.cpp)
+run_xr_xml_generate(validation_layer_generator.py xr_generated_core_validation.hpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/../scripts/automatic_source_generator.py)
+run_xr_xml_generate(validation_layer_generator.py xr_generated_core_validation.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/../scripts/automatic_source_generator.py)
 
 add_library(XrApiLayer_core_validation SHARED
     core_validation.cpp

src/api_layers/OpenXR_API_Dump.png.license

@@ -0,0 +1,3 @@
+Copyright (c) 2017, LunarG, Inc.
+
+SPDX-License-Identifier: CC-BY-4.0

src/api_layers/OpenXR_Core_Validation.png.license

@@ -0,0 +1,3 @@
+Copyright (c) 2017, LunarG, Inc.
+
+SPDX-License-Identifier: CC-BY-4.0

src/api_layers/core_validation_html_anchor.png.license

@@ -0,0 +1,3 @@
+Copyright (c) 2017, The Khronos Group Inc.
+
+SPDX-License-Identifier: CC-BY-4.0

src/api_layers/core_validation_message.png.license

@@ -0,0 +1,3 @@
+Copyright (c) 2017, LunarG, Inc.
+
+SPDX-License-Identifier: CC-BY-4.0

src/cmake/StdFilesystemFlags.cmake

@@ -18,7 +18,7 @@ if(MSVC AND MSVC_VERSION GREATER 1890)
 else()
     include(CheckCXXSourceCompiles)
 
-    # This is just dummy code that is known to not compile if std::filesystem isn't working right
+    # This is just example code that is known to not compile if std::filesystem isn't working right
     set(_stdfs_test_source
         "int main() {
         (void)is_regular_file(\"/\");