OpenXR SDK 1.0.9 (2020-05-29)

-   Registry
    -   Add an author ID, and reserve a vendor extension for Huawei.
        (OpenXR-Docs/#46)
    -   Reserve vendor extensions for future LunarG overlay and input
        focus functionality. (internal MR 1720)
    -   Reserve vendor extensions for Microsoft. (internal MR 1723)
    -   Add XR_EXT_hand_tracking multi-vendor extension. (internal MR
        1554, internal issue 1266, internal issue 1267, internal issue
        1268, internal issue 1269)
    -   Add XR_HUAWEI_controller_interaction vendor extension.
        (OpenXR-Docs/#47)
    -   Add XR_MNDX_egl_enable provisional vendor extension.
        (OpenXR-Docs/#48)
    -   Add XR_MSFT_spatial_graph_bridge vendor extension. (internal MR
        1730)
    -   Add XR_MSFT_secondary_view_configuration and
        XR_MSFT_first_person_observer vendor extensions. (internal MR
        1731)
    -   Add XR_MSFT_hand_mesh_tracking vendor extension. (internal MR
        1736)
    -   Fix missing space in XML definition of
        XrSpatialAnchorCreateInfoMSFT. (internal MR 1742, internal issue
        1351, OpenXR-SDK-Source/#187)
    -   Update a number of contacts for author/vendor tags. (internal MR
        1788, internal issue 1326)
-   SDK
    -   Replaced usage of the _DEBUG macro with NDEBUG. (internal MR
        1756)
    -   Allow disabling of std::filesystem usage via CMake, and detect
        if it’s available and what its requirements are.
        (OpenXR-SDK-Source/#192, OpenXR-SDK-Source/#188)
    -   CI: Modifications to Azure DevOps build pipeline. Now builds UWP
        loader DLLs in addition to Win32 loader DLLs. No longer builds
        static loader libraries due to linkability concerns. Re-arranged
        release artifact zip to distinguish architecture from 32-bit or
        64-bit.
    -   Loader: Replace global static initializers with functions that
        return static locals. With this change, code that includes
        OpenXR doesn’t have to page in this code and initialize these
        during startup. (OpenXR-SDK-Source/#173)
    -   Loader: Unload runtime when xrCreateInstance fails. (internal MR
        1778)
    -   Loader: Add “info”-level debug messages listing all the places
        that we look for the OpenXR active runtime manifest.
        (OpenXR-SDK-Source/#190)
    -   Validation Layer: Fix crash in dereferencing a nullptr optional
        array handle when the count > 0. (internal MR 1709,
        OpenXR-SDK-Source/#161, internal issue 1322)
    -   Validation Layer: Fix static analysis error and possible loss of
        validation error. (internal MR 1715, OpenXR-SDK-Source/#160,
        internal issue 1321)
    -   Validation Layer: Simplify some generated code, and minor
        performance improvements. (OpenXR-SDK-Source/#176)
    -   API Dump Layer: Fix crash in dereferencing a nullptr while
        constructing a std::string. (internal MR 1712,
        OpenXR-SDK-Source/#162, internal issue 1323)
    -   hello_xr: Fix releasing a swapchain image with the incorrect
        image layout. (internal MR 1755)
    -   hello_xr: Prefer VK_LAYER_KHRONOS_validation over
        VK_LAYER_LUNARG_standard_validation when available. (internal MR
        1755)
    -   hello_xr: Optimizations to D3D12 plugin to avoid GPU pipeline
        stall. (internal MR 1770) (OpenXR-SDK-Source/#175)
    -   hello_xr: Fix build with Vulkan headers 1.2.136.
        (OpenXR-SDK-Source/#181, OpenXR-SDK-Source/#180, internal issue
        1347)
    -   hello_xr: Fix build with Visual Studio 16.6.
        (OpenXR-SDK-Source/#186, OpenXR-SDK-Source/#184)

CHANGELOG.SDK.md

@@ -13,6 +13,94 @@ 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.9 (2020-05-29)
+
+- Registry
+  - Add an author ID, and reserve a vendor extension for Huawei.
+    ([OpenXR-Docs/#46](https://github.com/KhronosGroup/OpenXR-Docs/pull/46))
+  - Reserve vendor extensions for future LunarG overlay and input focus
+    functionality.
+    ([internal MR 1720](https://gitlab.khronos.org/openxr/openxr/merge_requests/1720))
+  - Reserve vendor extensions for Microsoft.
+    ([internal MR 1723](https://gitlab.khronos.org/openxr/openxr/merge_requests/1723))
+  - Add `XR_EXT_hand_tracking` multi-vendor extension.
+    ([internal MR 1554](https://gitlab.khronos.org/openxr/openxr/merge_requests/1554),
+    [internal issue 1266](https://gitlab.khronos.org/openxr/openxr/issues/1266),
+    [internal issue 1267](https://gitlab.khronos.org/openxr/openxr/issues/1267),
+    [internal issue 1268](https://gitlab.khronos.org/openxr/openxr/issues/1268),
+    [internal issue 1269](https://gitlab.khronos.org/openxr/openxr/issues/1269))
+  - Add `XR_HUAWEI_controller_interaction` vendor extension.
+    ([OpenXR-Docs/#47](https://github.com/KhronosGroup/OpenXR-Docs/pull/47))
+  - Add `XR_MNDX_egl_enable` provisional vendor extension.
+    ([OpenXR-Docs/#48](https://github.com/KhronosGroup/OpenXR-Docs/pull/48))
+  - Add `XR_MSFT_spatial_graph_bridge` vendor extension.
+    ([internal MR 1730](https://gitlab.khronos.org/openxr/openxr/merge_requests/1730))
+  - Add `XR_MSFT_secondary_view_configuration` and `XR_MSFT_first_person_observer`
+    vendor extensions.
+    ([internal MR 1731](https://gitlab.khronos.org/openxr/openxr/merge_requests/1731))
+  - Add `XR_MSFT_hand_mesh_tracking` vendor extension.
+    ([internal MR 1736](https://gitlab.khronos.org/openxr/openxr/merge_requests/1736))
+  - Fix missing space in XML definition of `XrSpatialAnchorCreateInfoMSFT`.
+    ([internal MR 1742](https://gitlab.khronos.org/openxr/openxr/merge_requests/1742),
+    [internal issue 1351](https://gitlab.khronos.org/openxr/openxr/issues/1351),
+    [OpenXR-SDK-Source/#187](https://github.com/KhronosGroup/OpenXR-SDK-Source/issues/187))
+  - Update a number of contacts for author/vendor tags.
+    ([internal MR 1788](https://gitlab.khronos.org/openxr/openxr/merge_requests/1788),
+    [internal issue 1326](https://gitlab.khronos.org/openxr/openxr/issues/1326))
+- SDK
+  - Replaced usage of the `_DEBUG` macro with `NDEBUG`.
+    ([internal MR 1756](https://gitlab.khronos.org/openxr/openxr/merge_requests/1756))
+  - Allow disabling of `std::filesystem` usage via CMake, and detect if it's
+    available and what its requirements are.
+    ([OpenXR-SDK-Source/#192](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/192),
+    [OpenXR-SDK-Source/#188](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/188))
+  - CI: Modifications to Azure DevOps build pipeline. Now builds UWP loader DLLs in
+    addition to Win32 loader DLLs. No longer builds static loader libraries due to
+    linkability concerns. Re-arranged release artifact zip to distinguish
+    architecture from 32-bit or 64-bit.
+  - Loader: Replace global static initializers with functions that return static
+    locals. With this change, code that includes OpenXR doesn't have to page in
+    this code and initialize these during startup.
+    ([OpenXR-SDK-Source/#173](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/173))
+  - Loader: Unload runtime when `xrCreateInstance` fails.
+    ([internal MR 1778](https://gitlab.khronos.org/openxr/openxr/merge_requests/1778))
+  - Loader: Add "info"-level debug messages listing all the places that we look for
+    the OpenXR active runtime manifest.
+    ([OpenXR-SDK-Source/#190](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/190))
+  - Validation Layer: Fix crash in dereferencing a nullptr optional array handle
+    when the `count > 0`.
+    ([internal MR 1709](https://gitlab.khronos.org/openxr/openxr/merge_requests/1709),
+    [OpenXR-SDK-Source/#161](https://github.com/KhronosGroup/OpenXR-SDK-Source/issues/161),
+    [internal issue 1322](https://gitlab.khronos.org/openxr/openxr/issues/1322))
+  - Validation Layer: Fix static analysis error and possible loss of validation
+    error.
+    ([internal MR 1715](https://gitlab.khronos.org/openxr/openxr/merge_requests/1715),
+    [OpenXR-SDK-Source/#160](https://github.com/KhronosGroup/OpenXR-SDK-Source/issues/160),
+    [internal issue 1321](https://gitlab.khronos.org/openxr/openxr/issues/1321))
+  - Validation Layer: Simplify some generated code, and minor performance
+    improvements.
+    ([OpenXR-SDK-Source/#176](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/176))
+  - API Dump Layer: Fix crash in dereferencing a `nullptr` while constructing a
+    `std::string`.
+    ([internal MR 1712](https://gitlab.khronos.org/openxr/openxr/merge_requests/1712),
+    [OpenXR-SDK-Source/#162](https://github.com/KhronosGroup/OpenXR-SDK-Source/issues/162),
+    [internal issue 1323](https://gitlab.khronos.org/openxr/openxr/issues/1323))
+  - hello_xr: Fix releasing a swapchain image with the incorrect image layout.
+    ([internal MR 1755](https://gitlab.khronos.org/openxr/openxr/merge_requests/1755))
+  - hello_xr: Prefer `VK_LAYER_KHRONOS_validation` over
+    `VK_LAYER_LUNARG_standard_validation` when available.
+    ([internal MR 1755](https://gitlab.khronos.org/openxr/openxr/merge_requests/1755))
+  - hello_xr: Optimizations to D3D12 plugin to avoid GPU pipeline stall.
+    ([internal MR 1770](https://gitlab.khronos.org/openxr/openxr/merge_requests/1770))
+    ([OpenXR-SDK-Source/#175](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/175))
+  - hello_xr: Fix build with Vulkan headers 1.2.136.
+    ([OpenXR-SDK-Source/#181](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/181),
+    [OpenXR-SDK-Source/#180](https://github.com/KhronosGroup/OpenXR-SDK-Source/issues/180),
+    [internal issue 1347](https://gitlab.khronos.org/openxr/openxr/issues/1347))
+  - hello_xr: Fix build with Visual Studio 16.6.
+    ([OpenXR-SDK-Source/#186](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/186),
+    [OpenXR-SDK-Source/#184](https://github.com/KhronosGroup/OpenXR-SDK-Source/issues/184))
+
 ## OpenXR SDK 1.0.8 (2020-03-27)
 
 Patch release for the 1.0 series.

changes/registry/README.md

@@ -6,3 +6,35 @@ changelogs.
 
 See the README.md in the parent directory for information on the format and
 naming of changelog fragment files.
+
+## Common entries
+
+During a patch release series, the only thing that should happen to the
+registry aside from extensions is "fix" - so include that in your fragment if
+applicable.
+
+The most common entries in the registry changelog involve extensions. Use the
+following as templates.
+
+For adding/enabling a vendor/multi-vendor extension:
+
+> Add `XR_MYVENDOR_myextension` vendor extension.
+
+- Add "provisional" before "vendor" if required.
+- If this is an EXT multi-vendor extension, change "vendor" to "multi-vendor".
+
+For adding/enabling a KHR or KHX extension:
+
+> Add ratified `XR_KHR_myextension` Khronos extension.
+
+- Add "provisional" before "Khronos" if it is a KHX extension.
+- Note that these all require the review period and board ratification!
+
+For reserving one or more extensions:
+
+> Reserve a vendor extension for VendorName.
+
+- Pluralize if reserving multiple extensions
+- May pre-pend "Register author ID and" if applicable.
+- You may optionally provide information about your plans for those extensions,
+  but this is not required, just permitted.

changes/sdk/README.md

@@ -6,3 +6,27 @@ SDK changelog.
 
 See the README.md in the parent directory for information on the format and
 naming of changelog fragment files.
+
+## Format tips
+
+Since there are a variety of components included in the SDK code, it's generally
+helpful to format your fragment as follows:
+
+> Loader: Fix the fooing of the bar.
+
+Note the following aspects:
+
+- Starts with component name ("Loader") and a colon. Skip this if your change
+  affects multiple different components that can't be easily grouped (e.g.
+  Layers can be grouped, but a change affecting hello_xr and the loader can't
+  be.) Component names (formatted correctly) include:
+  - Loader
+  - Layers (use this if your change affects more than one layer)
+  - API Dump Layer
+  - Validation Layer
+  - hello_xr
+- Description of the human-readable change effect, in the "imperative". (That
+  is, as a command/instruction, like a good commit message: "Fix problem" not
+  "Fixes problem" or "Fixed problem".) This may be more than one sentence, if
+  needed.
+- Sentence or sentences end with a period.

checkCodespell

@@ -42,7 +42,8 @@ CODESPELL_IGNORE=${CODESPELL_IGNORE:-${DEFAULT_CODESPELL_IGNORE}}
 # Add to this list when codespell mis-identifies a term actually used as a misspelling
 # (comma-delimited)
 # .Nd is used for a description in a mandoc manpage.
-IGNORE_WORDS="lod,LOD,nd"
+# Wee and Ser are names
+IGNORE_WORDS="lod,LOD,nd,wee,ser"
 
 # Add to this to exclude individual files or directories (comma-delimited)
 # - Skipping external code.

include/CMakeLists.txt

@@ -17,4 +17,4 @@
 # Author:
 #
 
-add_subdirectory(openxr)
+add_subdirectory(openxr)

specification/Makefile

@@ -44,7 +44,7 @@ ifneq (,$(strip $(VERY_STRICT)))
 ASCIIDOC := $(ASCIIDOC) --failure-level WARN
 endif
 
-SPECREVISION = 1.0.8
+SPECREVISION = 1.0.9
 REVISION_COMPONENTS = $(subst ., ,$(SPECREVISION))
 MAJORMINORVER = $(word 1,$(REVISION_COMPONENTS)).$(word 2,$(REVISION_COMPONENTS))
 
@@ -301,7 +301,7 @@ ASCIIDOCTOR_TARGETS += $(PDFSPEC) $(PDFA4SPEC)
 
 # Target-specific variables and deps customizing the AsciiDoctor rule
 $(PDFSPEC) $(PDFA4SPEC): LOGFILE=$(OUTDIR)/adoc_pdf_stderr.txt
-$(PDFSPEC) $(PDFA4SPEC): BACKEND_ARGS=--backend pdf --require asciidoctor-pdf
+$(PDFSPEC) $(PDFA4SPEC): BACKEND_ARGS=--backend pdf --require asciidoctor-pdf -a compress  -r ./scripts/pdf-index-customizer.rb
 $(PDFSPEC): PAGESIZE=LETTER
 $(PDFA4SPEC): PAGESIZE=A4
 $(PDFSPEC) $(PDFA4SPEC): $(COMMONDOCS)