Skip to content

Commit

Permalink
OpenXR SDK 1.0.11 (2020-08-14)
Browse files Browse the repository at this point in the history
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)
  • Loading branch information
rpavlik committed Aug 14, 2020
1 parent dd86624 commit e3a4e41
Show file tree
Hide file tree
Showing 12 changed files with 184 additions and 94 deletions.
43 changes: 43 additions & 0 deletions CHANGELOG.SDK.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions doc/loader/OpenXR_loader_design.html
Original file line number Diff line number Diff line change
Expand Up @@ -443,9 +443,9 @@
<h1>OpenXR<sup>&#174;</sup> Loader - Design and Operation [DRAFT] (with all published extensions)</h1>
<div class="details">
<span id="author" class="author">Copyright (c) 2017-2020 The Khronos Group Inc.</span><br>
<span id="revnumber">version 1.0.10,</span>
<span id="revdate">Tue, 28 Jul 2020 19:43:56 +0000</span>
<br><span id="revremark">from git ref release-1.0.10 commit: ebcf879c04fce7c4b519024a72a0edf5a03c32f0</span>
<span id="revnumber">version 1.0.11,</span>
<span id="revdate">Fri, 14 Aug 2020 21:28:55 +0000</span>
<br><span id="revremark">from git ref release-1.0.11 commit: 14c25557ab97779a48e9b93bd40c7879ac3a2e2a</span>
</div>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
Expand Down Expand Up @@ -5556,8 +5556,8 @@ <h3 id="_glossary_of_terms">9.2. Glossary of Terms</h3>
</div>
<div id="footer">
<div id="footer-text">
Version 1.0.10<br>
Last updated 2020-07-28 19:42:05 UTC
Version 1.0.11<br>
Last updated 2020-08-14 21:27:03 UTC
</div>
</div>
<script type="text/x-mathjax-config">
Expand Down
3 changes: 2 additions & 1 deletion include/openxr/openxr.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ extern "C" {
((((major) & 0xffffULL) << 48) | (((minor) & 0xffffULL) << 32) | ((patch) & 0xffffffffULL))

// OpenXR current version number.
#define XR_CURRENT_API_VERSION XR_MAKE_VERSION(1, 0, 10)
#define XR_CURRENT_API_VERSION XR_MAKE_VERSION(1, 0, 11)

#define XR_VERSION_MAJOR(version) (uint16_t)(((uint64_t)(version) >> 48)& 0xffffULL)
#define XR_VERSION_MINOR(version) (uint16_t)(((uint64_t)(version) >> 32) & 0xffffULL)
Expand Down Expand Up @@ -180,6 +180,7 @@ typedef enum XrResult {
XR_ERROR_ACTIONSETS_ALREADY_ATTACHED = -47,
XR_ERROR_LOCALIZED_NAME_DUPLICATED = -48,
XR_ERROR_LOCALIZED_NAME_INVALID = -49,
XR_ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING = -50,
XR_ERROR_ANDROID_THREAD_SETTINGS_ID_INVALID_KHR = -1000003000,
XR_ERROR_ANDROID_THREAD_SETTINGS_FAILURE_KHR = -1000003001,
XR_ERROR_CREATE_SPATIAL_ANCHOR_FAILED_MSFT = -1000039001,
Expand Down
10 changes: 5 additions & 5 deletions include/openxr/openxr_platform.h
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ typedef struct XrVulkanSwapchainFormatListCreateInfoKHR {
#ifdef XR_USE_GRAPHICS_API_OPENGL

#define XR_KHR_opengl_enable 1
#define XR_KHR_opengl_enable_SPEC_VERSION 8
#define XR_KHR_opengl_enable_SPEC_VERSION 9
#define XR_KHR_OPENGL_ENABLE_EXTENSION_NAME "XR_KHR_opengl_enable"
#ifdef XR_USE_PLATFORM_WIN32
typedef struct XrGraphicsBindingOpenGLWin32KHR {
Expand Down Expand Up @@ -159,7 +159,7 @@ XRAPI_ATTR XrResult XRAPI_CALL xrGetOpenGLGraphicsRequirementsKHR(
#ifdef XR_USE_GRAPHICS_API_OPENGL_ES

#define XR_KHR_opengl_es_enable 1
#define XR_KHR_opengl_es_enable_SPEC_VERSION 6
#define XR_KHR_opengl_es_enable_SPEC_VERSION 7
#define XR_KHR_OPENGL_ES_ENABLE_EXTENSION_NAME "XR_KHR_opengl_es_enable"
#ifdef XR_USE_PLATFORM_ANDROID
typedef struct XrGraphicsBindingOpenGLESAndroidKHR {
Expand Down Expand Up @@ -197,7 +197,7 @@ XRAPI_ATTR XrResult XRAPI_CALL xrGetOpenGLESGraphicsRequirementsKHR(
#ifdef XR_USE_GRAPHICS_API_VULKAN

#define XR_KHR_vulkan_enable 1
#define XR_KHR_vulkan_enable_SPEC_VERSION 6
#define XR_KHR_vulkan_enable_SPEC_VERSION 7
#define XR_KHR_VULKAN_ENABLE_EXTENSION_NAME "XR_KHR_vulkan_enable"
typedef struct XrGraphicsBindingVulkanKHR {
XrStructureType type;
Expand Down Expand Up @@ -258,7 +258,7 @@ XRAPI_ATTR XrResult XRAPI_CALL xrGetVulkanGraphicsRequirementsKHR(
#ifdef XR_USE_GRAPHICS_API_D3D11

#define XR_KHR_D3D11_enable 1
#define XR_KHR_D3D11_enable_SPEC_VERSION 4
#define XR_KHR_D3D11_enable_SPEC_VERSION 5
#define XR_KHR_D3D11_ENABLE_EXTENSION_NAME "XR_KHR_D3D11_enable"
typedef struct XrGraphicsBindingD3D11KHR {
XrStructureType type;
Expand Down Expand Up @@ -292,7 +292,7 @@ XRAPI_ATTR XrResult XRAPI_CALL xrGetD3D11GraphicsRequirementsKHR(
#ifdef XR_USE_GRAPHICS_API_D3D12

#define XR_KHR_D3D12_enable 1
#define XR_KHR_D3D12_enable_SPEC_VERSION 6
#define XR_KHR_D3D12_enable_SPEC_VERSION 7
#define XR_KHR_D3D12_ENABLE_EXTENSION_NAME "XR_KHR_D3D12_enable"
typedef struct XrGraphicsBindingD3D12KHR {
XrStructureType type;
Expand Down
61 changes: 31 additions & 30 deletions include/openxr/openxr_reflection.h
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ XR_ENUM_STR(XrResult);
_(XR_ERROR_ACTIONSETS_ALREADY_ATTACHED, -47) \
_(XR_ERROR_LOCALIZED_NAME_DUPLICATED, -48) \
_(XR_ERROR_LOCALIZED_NAME_INVALID, -49) \
_(XR_ERROR_GRAPHICS_REQUIREMENTS_CALL_MISSING, -50) \
_(XR_ERROR_ANDROID_THREAD_SETTINGS_ID_INVALID_KHR, -1000003000) \
_(XR_ERROR_ANDROID_THREAD_SETTINGS_FAILURE_KHR, -1000003001) \
_(XR_ERROR_CREATE_SPATIAL_ANCHOR_FAILED_MSFT, -1000039001) \
Expand Down Expand Up @@ -1407,6 +1408,15 @@ XR_ENUM_STR(XrResult);
#define XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL(_)
#endif

#if defined(XR_USE_GRAPHICS_API_OPENGL) && defined(XR_USE_PLATFORM_WIN32)
#define XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_XR_USE_PLATFORM_WIN32(_) \
_(XrGraphicsBindingOpenGLWin32KHR, XR_TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR) \


#else
#define XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_XR_USE_PLATFORM_WIN32(_)
#endif

#if defined(XR_USE_GRAPHICS_API_OPENGL) && defined(XR_USE_PLATFORM_XCB)
#define XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_XR_USE_PLATFORM_XCB(_) \
_(XrGraphicsBindingOpenGLXcbKHR, XR_TYPE_GRAPHICS_BINDING_OPENGL_XCB_KHR) \
Expand All @@ -1416,23 +1426,23 @@ XR_ENUM_STR(XrResult);
#define XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_XR_USE_PLATFORM_XCB(_)
#endif

#if defined(XR_USE_GRAPHICS_API_OPENGL_ES)
#define XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_ES(_) \
_(XrSwapchainImageOpenGLESKHR, XR_TYPE_SWAPCHAIN_IMAGE_OPENGL_ES_KHR) \
_(XrGraphicsRequirementsOpenGLESKHR, XR_TYPE_GRAPHICS_REQUIREMENTS_OPENGL_ES_KHR) \
#if defined(XR_USE_GRAPHICS_API_OPENGL) && defined(XR_USE_PLATFORM_XLIB)
#define XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_XR_USE_PLATFORM_XLIB(_) \
_(XrGraphicsBindingOpenGLXlibKHR, XR_TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR) \


#else
#define XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_ES(_)
#define XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_XR_USE_PLATFORM_XLIB(_)
#endif

#if defined(XR_USE_GRAPHICS_API_OPENGL_ES) && defined(XR_USE_PLATFORM_ANDROID)
#define XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_ES_XR_USE_PLATFORM_ANDROID(_) \
_(XrGraphicsBindingOpenGLESAndroidKHR, XR_TYPE_GRAPHICS_BINDING_OPENGL_ES_ANDROID_KHR) \
#if defined(XR_USE_GRAPHICS_API_OPENGL_ES)
#define XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_ES(_) \
_(XrSwapchainImageOpenGLESKHR, XR_TYPE_SWAPCHAIN_IMAGE_OPENGL_ES_KHR) \
_(XrGraphicsRequirementsOpenGLESKHR, XR_TYPE_GRAPHICS_REQUIREMENTS_OPENGL_ES_KHR) \


#else
#define XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_ES_XR_USE_PLATFORM_ANDROID(_)
#define XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_ES(_)
#endif

#if defined(XR_USE_GRAPHICS_API_VULKAN)
Expand All @@ -1456,6 +1466,15 @@ XR_ENUM_STR(XrResult);
#define XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_ANDROID(_)
#endif

#if defined(XR_USE_PLATFORM_ANDROID) && defined(XR_USE_GRAPHICS_API_OPENGL_ES)
#define XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_ANDROID_XR_USE_GRAPHICS_API_OPENGL_ES(_) \
_(XrGraphicsBindingOpenGLESAndroidKHR, XR_TYPE_GRAPHICS_BINDING_OPENGL_ES_ANDROID_KHR) \


#else
#define XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_ANDROID_XR_USE_GRAPHICS_API_OPENGL_ES(_)
#endif

#if defined(XR_USE_PLATFORM_EGL)
#define XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_EGL(_) \
_(XrGraphicsBindingEGLMNDX, XR_TYPE_GRAPHICS_BINDING_EGL_MNDX) \
Expand Down Expand Up @@ -1483,39 +1502,21 @@ XR_ENUM_STR(XrResult);
#define XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_WIN32(_)
#endif

#if defined(XR_USE_PLATFORM_WIN32) && defined(XR_USE_GRAPHICS_API_OPENGL)
#define XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_WIN32_XR_USE_GRAPHICS_API_OPENGL(_) \
_(XrGraphicsBindingOpenGLWin32KHR, XR_TYPE_GRAPHICS_BINDING_OPENGL_WIN32_KHR) \


#else
#define XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_WIN32_XR_USE_GRAPHICS_API_OPENGL(_)
#endif

#if defined(XR_USE_PLATFORM_XLIB) && defined(XR_USE_GRAPHICS_API_OPENGL)
#define XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_XLIB_XR_USE_GRAPHICS_API_OPENGL(_) \
_(XrGraphicsBindingOpenGLXlibKHR, XR_TYPE_GRAPHICS_BINDING_OPENGL_XLIB_KHR) \


#else
#define XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_XLIB_XR_USE_GRAPHICS_API_OPENGL(_)
#endif

#define XR_LIST_STRUCTURE_TYPES(_) \
XR_LIST_STRUCTURE_TYPES_CORE(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_D3D11(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_D3D12(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_XR_USE_PLATFORM_WIN32(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_XR_USE_PLATFORM_XCB(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_XR_USE_PLATFORM_XLIB(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_ES(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_OPENGL_ES_XR_USE_PLATFORM_ANDROID(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_GRAPHICS_API_VULKAN(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_ANDROID(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_ANDROID_XR_USE_GRAPHICS_API_OPENGL_ES(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_EGL(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_WAYLAND_XR_USE_GRAPHICS_API_OPENGL(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_WIN32(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_WIN32_XR_USE_GRAPHICS_API_OPENGL(_) \
XR_LIST_STRUCTURE_TYPES_XR_USE_PLATFORM_XLIB_XR_USE_GRAPHICS_API_OPENGL(_) \


#define XR_LIST_EXTENSIONS(_) \
Expand Down
Loading

0 comments on commit e3a4e41

Please sign in to comment.