OpenXR SDK 1.0.16 (2021-05-11)

This release contains an update to define a new error code,
XR_ERROR_RUNTIME_UNAVAILABLE, now returned by the loader at
xrCreateInstance and xrEnumerateInstanceProperties when it cannot find
or load a runtime for some reason. This should be more clear for
developers when encountering it, as well as helpful when troubleshooting
errors hit by users. (The previously-returned error was typically
XR_ERROR_INSTANCE_LOST, which is confusing when returned when trying to
create an instance.) This release also includes a new multi-vendor
extension, a new vendor extension, and improved concurrency handling in
the loader, among smaller fixes.

-   Registry
    -   Add new XR_ERROR_RUNTIME_UNAVAILABLE error code, add
        XR_ERROR_RUNTIME_UNAVAILABLE as a supported error code to
        xrCreateInstance and xrEnumerateInstanceProperties, and remove
        XR_ERROR_INSTANCE_LOST as a supported error code from
        xrCreateInstance. (internal MR 2024, internal issue 1552,
        OpenXR-SDK-Source/#177)
    -   Add XR_EXT_hand_joint_motion_range multi-vendor extension.
        (internal MR 1995)
    -   Add XR_FB_swapchain_update_state vendor extension. (internal MR
        1997)
    -   Fix missing XR_ERROR_INSTANCE_LOST return codes for extension
        functions in XR_EXT_performance_settings, XR_EXT_debug_utils,
        XR_EXT_conformance_automation, and XR_EXT_thermal_query.
        (internal MR 2023, OpenXR-Docs/#10, internal issue 1256)
    -   Reserve extension 166 for working group use. (internal MR 2025)
-   SDK
    -   Loader: Change runtime part to return
        XR_ERROR_RUNTIME_UNAVAILABLE when there is an error loading a
        runtime. (internal MR 2024, internal issue 1552,
        OpenXR-SDK-Source/#177)
    -   Loader: Simplify in areas where code paths were dead. (internal
        MR 2024)
    -   Loader: Improved locking around a few areas of the loader that
        aren’t robust against usual concurrent calls.
        (OpenXR-SDK-Source/#252)
    -   validation layer: Fix generated code when a protected extension
        contains a base header type. (internal MR 1997)

Author: rpavlik

.appveyor.yml

@@ -1,4 +1,8 @@
-version: 1.0.5.{build}
+# Copyright (c) 2017-2021 The Khronos Group Inc.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+version: 1.0.16.{build}
 image: Visual Studio 2017
 
 

.azure-pipelines/nuget/NugetTemplate/OpenXR.Loader.nuspec

@@ -1,12 +1,16 @@
 <?xml version="1.0" encoding="utf-8"?>
 <package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
+  <!--
+  Copyright (c) 2020 The Khronos Group Inc.
+  SPDX-License-Identifier: CC-BY-4.0
+  -->
   <metadata>
     <id>OpenXR.Loader</id>
     <version></version>
     <authors>Khronos Group</authors>
     <owners>Khronos Group</owners>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
-    <license type="expression">Apache-2.0</license>
+    <license type="expression">Apache-2.0 OR MIT</license>
     <licenseUrl>https://licenses.nuget.org/Apache-2.0</licenseUrl>
     <projectUrl>https://github.com/KhronosGroup/OpenXR-SDK</projectUrl>
     <description>Khronos OpenXR loader and headers required to build a Win32 or UWP OpenXR application</description>

.azure-pipelines/nuget/NugetTemplate/build/native/OpenXR.Loader.props

@@ -1,4 +1,8 @@
 <Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <!--
+  Copyright (c) 2020 The Khronos Group Inc.
+  SPDX-License-Identifier: CC-BY-4.0
+  -->
   <PropertyGroup>
     <OpenXRPackageRoot>$(MSBuildThisFileDirectory)..\..\</OpenXRPackageRoot>
   </PropertyGroup>

.azure-pipelines/nuget/NugetTemplate/build/native/OpenXR.Loader.targets

@@ -1,4 +1,9 @@
-<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+<Project ToolsVersion="4.0"
+    xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+    <!--
+    Copyright (c) 2020 The Khronos Group Inc.
+    SPDX-License-Identifier: CC-BY-4.0
+    -->
 
     <Choose>
         <When Condition="'$(ApplicationType)|$(ApplicationTypeRevision)' == 'Windows Store|10.0'">

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

@@ -1,4 +1,4 @@
-# Copyright (c) 2019-2020 The Khronos Group Inc.
+# Copyright (c) 2019-2021 The Khronos Group Inc.
 # SPDX-License-Identifier: Apache-2.0
 
 # Main azure-pipelines configuration for the OpenXR-SDK-Sources repo.
@@ -12,16 +12,16 @@ variables:
 stages:
   - stage: Check
     jobs:
-      - template: check_clang_format.yml
+      - template: shared/check_clang_format.yml
 
   - stage: Build
     jobs:
-      - template: build_jobs.yml
+      - template: shared/build_jobs.yml
       # Build the loader documentation
       - job: loader_docs
         pool:
-          vmImage: "ubuntu-16.04"
-        container: khronosgroup/docker-images:openxr-base
+          vmImage: "ubuntu-latest"
+        container: khronosgroup/docker-images:openxr-base.202102
         steps:
           - script: make loader
             workingDirectory: specification
@@ -33,8 +33,8 @@ stages:
     jobs:
       - job: archive
         pool:
-          vmImage: "ubuntu-16.04"
-        container: khronosgroup/docker-images:openxr-base
+          vmImage: "ubuntu-latest"
+        container: khronosgroup/docker-images:openxr-base.202102
         steps:
           - script: make loader
             workingDirectory: specification
@@ -61,14 +61,14 @@ stages:
               buildType: RelWithDebInfo
               presentationBackend: wayland
         pool:
-          vmImage: "ubuntu-16.04"
+          vmImage: "ubuntu-latest"
         container: khronosgroup/docker-images:openxr-sdk
         steps:
           - task: DownloadPipelineArtifact@2
+            displayName: Download archived OpenXR-SDK
             inputs:
               source: current
               artifact: sdk-tarball
-              displayName: Download archived OpenXR-SDK
               path: "$(Pipeline.Workspace)"
           - script: ls -la
             displayName: List files in directory
@@ -80,7 +80,7 @@ stages:
               destinationFolder: $(Pipeline.Workspace)/pregen
               cleanDestinationFolder: true
           - script: ls -la $(Pipeline.Workspace)/pregen
-          - template: build_linux.yml
+          - template: shared/build_linux.yml
             parameters:
               sourceDir: $(Pipeline.Workspace)/pregen
               buildType: RelWithDebInfo
@@ -92,10 +92,10 @@ stages:
           vmImage: "windows-latest"
         steps:
           - task: DownloadPipelineArtifact@2
+            displayName: Download archived OpenXR-SDK
             inputs:
               source: current
               artifact: sdk-tarball
-              displayName: Download archived OpenXR-SDK
               path: "$(Pipeline.Workspace)"
 
           - task: ExtractFiles@1
@@ -104,7 +104,7 @@ stages:
               destinationFolder: $(Pipeline.Workspace)/pregen
               cleanDestinationFolder: true
 
-          - template: build_msvc.yml
+          - template: shared/build_msvc.yml
             parameters:
               sourceDir: $(Pipeline.Workspace)/pregen
               buildType: RelWithDebInfo

.azure-pipelines/openxr-sdk.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2019-2020 The Khronos Group Inc.
+# Copyright (c) 2019-2021 The Khronos Group Inc.
 # SPDX-License-Identifier: Apache-2.0
 
 # Main azure-pipelines configuration for the OpenXR-SDK repo.
@@ -11,4 +11,4 @@ trigger:
 stages:
   - stage: Build
     jobs:
-      - template: build_jobs.yml
+      - template: shared/build_jobs.yml

.azure-pipelines/build_jobs.yml renamed to .azure-pipelines/shared/build_jobs.yml

@@ -1,8 +1,13 @@
-# Copyright (c) 2019-2020 The Khronos Group Inc.
+# Copyright (c) 2019-2021 The Khronos Group Inc.
 # SPDX-License-Identifier: Apache-2.0
 
 parameters:
-  sourceDir: "$(System.DefaultWorkingDirectory)"
+  - name: sourceDir
+    type: string
+    default: "$(System.DefaultWorkingDirectory)"
+  - name: isSdk
+    type: boolean
+    default: true
 
 jobs:
   # Build the loader, API layers, and samples on Linux
@@ -21,7 +26,7 @@ jobs:
           presentationBackend: wayland
     pool:
       vmImage: "ubuntu-latest"
-    container: khronosgroup/docker-images:openxr-sdk
+    container: khronosgroup/docker-images:openxr-sdk.202102
     steps:
       # First build as debug
       - template: build_linux.yml
@@ -43,7 +48,7 @@ jobs:
       - task: PythonScript@0
         name: winmatrix
         inputs:
-          scriptPath: $(System.DefaultWorkingDirectory)/.azure-pipelines/generate_windows_matrix_build.py
+          scriptPath: $(System.DefaultWorkingDirectory)/.azure-pipelines/shared/generate_windows_matrix_build.py
           # argument sets the variable name defined by python script
           arguments: winbuild
 
@@ -91,6 +96,7 @@ jobs:
 
   - job: combine_artifacts
     dependsOn: windows_build
+    condition: ${{ eq(parameters.isSdk, true) }}
     displayName: "Organize artifacts"
     pool:
       vmImage: "windows-latest"
@@ -119,11 +125,11 @@ jobs:
       # Use the specified version of Python from the tool cache
       - task: UsePythonVersion@0
         inputs:
-          versionSpec: '3.9'
+          versionSpec: "3.9"
       - task: PythonScript@0
         displayName: Move artifact contents
         inputs:
-          scriptPath: $(System.DefaultWorkingDirectory)/.azure-pipelines/organize_windows_artifacts.py
+          scriptPath: $(System.DefaultWorkingDirectory)/.azure-pipelines/shared/organize_windows_artifacts.py
           arguments: $(Pipeline.Workspace) $(System.DefaultWorkingDirectory)/openxr_loader
       - task: PublishPipelineArtifact@1
         displayName: Publish combined artifact

.azure-pipelines/build_linux.yml renamed to .azure-pipelines/shared/build_linux.yml

@@ -1,11 +1,19 @@
-# Copyright (c) 2019-2020 The Khronos Group Inc.
+# Copyright (c) 2019-2021 The Khronos Group Inc.
 # SPDX-License-Identifier: Apache-2.0
 
 parameters:
-  buildType: RelWithDebInfo
-  cmakeArgs: ""
-  buildDir: build
-  sourceDir: "$(System.DefaultWorkingDirectory)"
+  - name: buildType
+    type: string
+    default: "RelWithDebInfo"
+  - name: cmakeArgs
+    type: string
+    default: ""
+  - name: sourceDir
+    type: string
+    default: "$(System.DefaultWorkingDirectory)"
+  - name: buildDir
+    type: string
+    default: build
 
 steps:
   - script: |

.azure-pipelines/build_mingw.yml renamed to .azure-pipelines/shared/build_mingw.yml

@@ -1,11 +1,20 @@
-# Copyright (c) 2019-2020 The Khronos Group Inc.
+# Copyright (c) 2019-2021 The Khronos Group Inc.
 # SPDX-License-Identifier: Apache-2.0
 
 parameters:
-  buildType: "Debug"
-  cmakeArgs: ""
-  sourceDir: "$(System.DefaultWorkingDirectory)"
-  useVulkan: "true"
+  - name: buildType
+    type: string
+    default: "Debug"
+  - name: cmakeArgs
+    type: string
+    default: ""
+  - name: sourceDir
+    type: string
+    default: "$(System.DefaultWorkingDirectory)"
+    # TODO should be boolean
+  - name: useVulkan
+    type: string
+    default: "true"
 
 steps:
   # - script: choco install -y ninja
@@ -14,7 +23,7 @@ steps:
   - script: mkdir  $(System.DefaultWorkingDirectory)\\vulkan_sdk
     displayName: "Make Vulkan SDK dir"
 
-  - powershell: ./.azure-pipelines/install_vulkan.ps1
+  - powershell: ./.azure-pipelines/shared/install_vulkan.ps1
     displayName: Install Vulkan SDK
     workingDirectory: "${{ parameters.sourceDir }}"
     condition: eq('${{ parameters.useVulkan}}', 'true')

.azure-pipelines/build_msvc.yml renamed to .azure-pipelines/shared/build_msvc.yml

@@ -1,15 +1,26 @@
-# Copyright (c) 2019-2020 The Khronos Group Inc.
+# Copyright (c) 2019-2021 The Khronos Group Inc.
 # SPDX-License-Identifier: Apache-2.0
 
 parameters:
-  buildType: "Debug"
-  generator: "Visual Studio 16 2019"
-  cmakeArgs: ""
-  sourceDir: "$(System.DefaultWorkingDirectory)"
-  useVulkan: "true"
+  - name: buildType
+    type: string
+    default: "Debug"
+  - name: generator
+    type: string
+    default: "Visual Studio 16 2019"
+  - name: cmakeArgs
+    type: string
+    default: ""
+  - name: sourceDir
+    type: string
+    default: "$(System.DefaultWorkingDirectory)"
+    # TODO should be boolean
+  - name: useVulkan
+    type: string
+    default: "true"
 
 steps:
-  - powershell: ./.azure-pipelines/install_vulkan.ps1
+  - powershell: ./.azure-pipelines/shared/install_vulkan.ps1
     displayName: Install Vulkan SDK
     workingDirectory: "${{ parameters.sourceDir }}"
     condition: eq('${{ parameters.useVulkan}}', 'true')