Releases: KhronosGroup/OpenXR-SDK-Source
OpenXR SDK (Source) 1.1.37
OpenXR SDK 1.1.37 (2024-05-23)
This release primarily adds new defines for easier use of both OpenXR 1.0 and
1.1 with up-to-date headers, some documentation improvements, and improvements
for Android, including support for using the "API Dump" and "Validation" API
layers in your own APK during the development process.
- Registry
- Addition: New
XR_API_VERSION_1_0
andXR_API_VERSION_1_1
defines to allow
applications to easily specify OpenXR "major" and "minor" version while passing
through the "patch" version.
(internal MR 3329,
internal MR 3354,
internal issue 2254) - Addition: Register Razer vendor ID.
(internal MR 3340) - Fix: Add "palm_pose" to "touch_controller_pro" and "touch_controller_plus" in
XML.
(internal MR 3363) - Improvement: Add Schematron rule to avoid triggering edge cases of vendor tags
ending with X.
(internal MR 3341) - Reservation: Reserve extension numbers for a few new EXT extensions.
(internal MR 3285,
internal MR 3292) - Update: Bump version of
XR_FB_composition_layer_alpha_blend
due to spec text
clarification.
(internal MR 3317)
- Addition: New
- SDK
- Addition: Ship
open-in-docker.sh
script for use building the loader design
doc.
(internal MR 3352,
internal issue 2283,
OpenXR-SDK-Source issue 476) - Fix: Fix references to Docker container in spec build instructions and clarify
that most parts do not apply to the SDK-Source repo.
(internal MR 3352,
internal issue 2283,
OpenXR-SDK-Source issue 476) - Fix: Do not load all Android app-supplied layers as explicit, but rather as
their actual type.
(OpenXR-SDK-Source PR 475,
internal issue 2284) - Improvement: Use new
XR_API_VERSION_1_0
andXR_API_VERSION_1_1
defines.
(internal MR 3329,
internal issue 2254) - Improvement: Add Android support to "api_dump" and "core_validation" API
layers.
(internal MR 3330)
- Addition: Ship
The Android loader can be found on Maven Central, by adding the following line to your Android app's build.gradle dependencies section:
implementation 'org.khronos.openxr:openxr_loader_for_android:1.1.37'
(There may be a delay of a few hours after release before artifacts are accessible on Maven Central.)
Alternately, the AAR file (plus signature by the dedicated spec editor key and associated POM) are attached to this release.
Other release files are signed by specification editor Rylie Pavlik's key, with key fingerprint 45207B2B1E53E1F2755FF63CC5A2D593A61DBC9D. Link goes to full public key.
OpenXR SDK (Source) 1.1.36
OpenXR SDK 1.1.36 (2024-04-15)
This is a substantial update to the OpenXR specification. The OpenXR loader in
this release supports both OpenXR 1.0 and 1.1, and sample applications such as
hello_xr continue to only require OpenXR 1.0. The schema associated with the
xr.xml
description of OpenXR has received a small but breaking change, so
software that parses it may need an update accordingly. Additionally, the
protocol for the OpenXR loader on Android to communicate with system or
installable runtime brokers has been extended for improvfed backward- and
forward-compatibility; see the changes to the loader design document for more
information.
- Registry
- New ratified Khronos extension:
XR_KHR_locate_spaces
(internal MR 2272,
internal issue 1706) - New ratified Khronos extension:
XR_KHR_maintenance1
(internal MR 3053) - New ratified OpenXR version:
XR_VERSION_1_1
- OpenXR 1.1.
(internal MR 3053) - New multi-vendor extension:
XR_EXT_future
(internal MR 2610) - New vendor extension:
XR_META_environment_depth
(internal MR 2771,
internal MR 3271) - Mark
XR_OCULUS_android_session_state_enable
as deprecated.
(internal MR 3255) - Update the XML schema to change how dependencies are described (replacing
requiresCore
andrequires
attributes ofextension
, andfeature
and
extension
attributes ofrequire
, with a newdepends
attribute.). This is
a breaking change of the XML schema, though in an infrequently processed
attribute. This corresponds to the change made in Vulkan 1.3.241.
(internal MR 3260)
- New ratified Khronos extension:
- SDK
- API dump layer: Handle opaque futures defined by
XR_EXT_future
.
(internal MR 2610) - API dump layer: Zero initialize out-param in calls to
xrResultToString
and
xrStructureTypeToString
.
(internal MR 3284) - Android loader: Build using NDK 23.2.
(internal MR 2992) - Android loader: Allow the loader to check multiple records from the broker, for
backward- and forward-compatibility
(internal MR 3269,
internal issue 2226) - Loader: Improve error logging in the case that the Windows registry
ActiveRuntime
path cannot be parsed or found.
(internal MR 3015,
internal issue 2125) - Loader: Remove path separator parsing from Windows registry
ActiveRuntime
path to fix bug.
(internal MR 3015) - Loader: Fix build issue for ARMv6 architectures, and note architecture naming
quirk of Raspberry Pi OS in the architecture table in the loader documentation.
(OpenXR-SDK-Source PR 464,
OpenXR-SDK-Source issue 463) - Reduce duplication of environment variable getters and setters.
(internal MR 3039) - Updates to scripts and software to handle aliases and promoted functionality in
XR_KHR_maintenance1
andXR_VERSION_1_1
(internal MR 3053) - hello_xr: Fix Windows mirror window acquire, wait, present loop.
(internal MR 3289) - hello_xr and other samples: Update Android compile SDK version (to 33), NDK
version (to 23.2), and build tools version (to 34.0.0).
(internal MR 2992) - hello_xr and runtime list: Request an OpenXR 1.0 instance by default.
(internal MR 3320) - loader_test: Build fixes to allow loader_test to compile / run on Android.
(internal MR 3153)
- API dump layer: Handle opaque futures defined by
The Android loader can be found on Maven Central, by adding the following line to your Android app's build.gradle dependencies section:
implementation 'org.khronos.openxr:openxr_loader_for_android:1.1.36'
(There may be a delay of a few hours after release before artifacts are accessible on Maven Central.)
Alternately, the AAR file (plus signature by the dedicated spec editor key and associated POM) are attached to this release.
Other release files are signed by specification editor Rylie Pavlik's key, with key fingerprint 45207B2B1E53E1F2755FF63CC5A2D593A61DBC9D. Link goes to full public key.
OpenXR SDK (Source) 1.0.34
OpenXR SDK 1.0.34 (2024-02-16)
This release features a number of new multi-vendor and vendor extensions,
additional functionality in the reflection header, as well as compatibility
improvements for the loader on Android.
- Registry
- Extension reservation: Register author ID and reserve extensions for Leia.
(internal MR 3203) - Fix: Remove erroneous interaction profile component additions from extensions.
(internal MR 3223) - New multi-vendor extension:
XR_EXT_user_presence
(internal MR 2706,
internal issue 1585) - New vendor extension:
XR_META_recommended_layer_resolution
(internal MR 2570) - New vendor extension:
XR_META_automatic_layer_filter
(internal MR 2696) - New vendor extension:
XR_META_spatial_entity_mesh
(internal MR 2773) - New vendor extension:
XR_FB_face_tracking2
(internal MR 2811) - New vendor extension:
XR_VARJO_xr4_controller_interaction
(internal MR 3078) XR_FB_scene
: Update to spec version 4.
(internal MR 2774)XR_META_headset_id
andXR_FB_spatial_entity
: DropXR_EXT_uuid
dependency,
they use the data structure but do not require any runtime support specific to
XR_EXT_uuid
(internal MR 2577)
- Extension reservation: Register author ID and reserve extensions for Leia.
- SDK
- API Layers: Add version-script for linking API Layers on Linux and Android.
(internal MR 3112) - Fix typo in
gfxwrapper_opengl
that did not affect the use in this repository
directly, but may affect downstream users of this code.
(internal MR 3215) - Loader: fix to Android Loader so that the
/<path_to_apk>/my_apk_file.apk!/libs/libstuff.so
will not get blocked
(internal MR 3054) - Loader: Add missing ifdef guards for
XR_KHR_LOADER_INIT_SUPPORT
.
(internal MR 3152,
internal MR 3159) - Loader: Fix crash in case of calling
xrEnumerateInstanceExtensionProperties
before callingxrInitializeLoaderKHR
on Android.
(internal MR 3159) - Loader design: Add a note about environment variables being ignored when run on
Windows as admin.
(internal MR 3214) openxr_reflection.h
: Add macros to list functions provided by each feature /
extension.
(internal MR 3129)- external: Update Jinja2 Python module shipped with repository (for source code
generation) to 2.11.3.
(internal MR 3221,
internal MR 3237)
- API Layers: Add version-script for linking API Layers on Linux and Android.
The Android loader can be found on Maven Central, by adding the following line to your Android app's build.gradle dependencies section:
implementation 'org.khronos.openxr:openxr_loader_for_android:1.0.34'
(There may be a delay of a few hours after release before artifacts are accessible on Maven Central.)
Alternately, the AAR file (plus signature by the dedicated spec editor key and associated POM) are attached to this release.
Other release files are signed by specification editor Rylie Pavlik's key, with key fingerprint 45207B2B1E53E1F2755FF63CC5A2D593A61DBC9D. Link goes to full public key.
OpenXR SDK (Source) 1.0.33
OpenXR SDK 1.0.33 (2024-01-03)
This release primarily adds new ratified functionality describing the loader
interaction with runtimes and API layers. Corresponding definitions are now in
the official openxr_loader_negotiation.h
generated header, rather than the
loader_interfaces.h
header previously shipped only with the OpenXR-SDK-Source
repository. This change only affects vendors of runtimes and API layers as well
as contributors to the OpenXR loader: applications do not directly use this API,
the loader uses it on their behalf. A number of other small fixes are also
included.
- Registry
- Extension reservation: Update author ID and reserve extensions for Varjo.
(internal MR 3083) - Extension reservation: Reserve 10 extension ids each for
ANDROIDX
&
ANDROIDSYS
.
(internal MR 3086) - Khronos ratified addition: Specify the existing loader negotiation functions
(without modification) in the XML, moving fromloader_interfaces.h
to a new
generated headeropenxr_loader_negotiation.h
.
(internal MR 2807,
internal issue 1953) XR_KHR_android_thread_settings
: Fix the description of
XrAndroidThreadTypeKHR
enum values - they were swapped relative to their
implicit meaning from their name.
(internal MR 3077)XR_MNDX_egl_enable
: Update version to 2 to reflect function pointer type
change released in 1.0.29.
(OpenXR-Docs PR 159)
- Extension reservation: Update author ID and reserve extensions for Varjo.
- SDK
- Loader: Fix loader build on Universal Windows Platform: build-system-only
change. (Included in SDK hotfix 1.0.32.1.)
(internal MR 3071) - Loader: Correctly destroy the LoaderInstance when loader is done.
(internal MR 3041) - Remove obsolete
loader_interfaces.h
header, migrating uses (in loader and
layers) to use the newly specified and ratifiedopenxr_loader_negotiation.h
,
and adjust scripts for the addition of the loader negotiation APIs.
(internal MR 2807,
internal issue 1953,
internal MR 3122)
- Loader: Fix loader build on Universal Windows Platform: build-system-only
- Misc
- Update/correct names.
- Ship a
.mailmap
file in the public repositories, maintained separately
from the larger one used in the private monorepo, to correct names/emails
and unify contributor identities. - Update Khronos Group copyright dates.
GitOrigin-RevId: a561c5898b72f59965790790a28bbc3b7e9bcf13
The Android loader can be found on Maven Central, by adding the following line to your Android app's build.gradle dependencies section:
implementation 'org.khronos.openxr:openxr_loader_for_android:1.0.33'
(There may be a delay of a few hours after release before artifacts are accessible on Maven Central.)
Alternately, the AAR file (plus signature by the dedicated spec editor key and associated POM) are attached to this release.
Other release files are signed by specification editor Rylie Pavlik's key, with key fingerprint 45207B2B1E53E1F2755FF63CC5A2D593A61DBC9D. Link goes to full public key.
(Note that this is a new signing key for the specification editor: see https://ryliepavlik.com/work-key-transition-2023-11-17.txt for key transition statement.)
OpenXR SDK (Source) 1.0.32 with 1.0.32.1 SDK hotfix
OpenXR SDK 1.0.32 (2023-11-29)
NOTE: Binary artifacts for Windows attached to this release correspond to the hotfix release release-1.0.32.1 tag, to fix an issue with building for the Universal Windows Platform (UWP). See below for details on this SDK hotfix release.
This release contains a number of vendor extensions, plus a new ratified
revision to the XR_KHR_loader_init
extension that specifies forwarding the
init calls to API layers. Vendors of API layers, primarily on Android, must
verify they can handle being passed XR_NULL_HANDLE
for the instance parameter
of xrGetInstanceProcAddr
, to avoid bugs when using the updated loader. This
release also contains a number of build system cleanups and fixes. Users of the
Android Gradle Plugin and our official loader AAR file can now use the
OpenXR::headers
target just like on desktop: there is now metadata for the
"prefab" tool to generate for CMake both this header/include-only target and the
normal OpenXR::openxr_loader
imported library target. The shipped AAR is much
smaller due to stripping debug data from the binaries, which helps in case
application build systems do not automatically strip native binaries. A bug in
the loader Android manifest as shipped in 1.0.31 has also been fixed.
- OpenXR SDK 1.0.32.1 hotfix release includes the following fix.
- Loader: Fix loader build on Universal Windows Platform: build-system-only
change.
(internal MR 3071) - Internal CI fix to archive the source JAR for the Android loader.
- Loader: Fix loader build on Universal Windows Platform: build-system-only
- Registry
- Extension reservation: Reserve extension id for
XR_KHR_maintenance1
(internal MR 3010) - Extension reservation: Reserve extension id for
XR_KHR_game_controller
(internal MR 3019) - New vendor extension:
XR_HTC_anchor
(internal MR 2667) - New vendor extension:
XR_META_touch_controller_plus
(internal MR 2702) - New vendor extension:
XR_ML_marker_understanding
(internal MR 2750) - New vendor extension:
XR_ML_localization_map
(internal MR 2802,
internal MR 3045,
internal MR 3047) XR_KHR_loader_init
: New Khronos ratified revision, adds support for
forwarding loader init calls to API layers
(internal MR 2703)
- Extension reservation: Reserve extension id for
- SDK
- Loader: Pass
xrInitializeLoaderKHR
calls to enabled API layers if
XR_KHR_loader_init
is enabled, per ratified update to that extension.
(internal MR 2703) - Loader: Partial fix for the loader not honoring
BUILD_LOADER_WITH_EXCEPTION_HANDLING
on Android.
(internal MR 2870,
OpenXR-SDK-Source PR 405,
internal issue 1999) - Loader Android AAR: Strip binaries before inclusion in AAR, as loader is stable
(and mostly shared with all platforms) and size difference is substantial. - Loader Android AAR: Expose
OpenXR::headers
prefab imported target just as on
desktop builds
(internal MR 2886) - Loader Android AAR: Generate a source jar file for completeness.
(internal MR 2886) - Loader Android AAR: Add
<uses-sdk>
elements to Android loader AAR manifest,
to prevent the manifest merger from assuming a version < 4 and adding unneeded
permissions accordingly.
(internal MR 3029)
(internal MR 3032) - Clean up our CMake build substantially, correcting dependencies and narrowing
the scope of includes.
(internal MR 2886,
OpenXR-SDK-Source issue 344,
internal issue 1872,
OpenXR-SDK-Source issue 419,
internal issue 2071,
internal MR 2987) - Fix build in directories containing spaces.
(internal MR 2886,
OpenXR-SDK-Source issue 344,
internal issue 1872,
OpenXR-SDK-Source issue 419,
internal issue 2071,
internal MR 2987) - Fix linking to GLX when glvnd is not found on the system
(internal MR 3000) - Fix use of
OpenXR::headers
target when not building the loader.
(internal MR 2886,
OpenXR-SDK-Source issue 344,
internal issue 1872,
OpenXR-SDK-Source issue 419,
internal issue 2071,
internal MR 2987) - scripts: Migrate
namedtuple
usage to dataclass, and expose the definitions
for reuse.
(internal MR 2183) - scripts: Clean up formatting, clean up some issues found by type-aware Python
editors, and improve the experience of editing Python scripts in some editors
by adding a.env
file.
(internal MR 2183) - scripts: Support base header types with no derived types defined yet.
(internal MR 2802)
- Loader: Pass
GitOrigin-RevId: 0a6bbc30cf10fdec436dfa81abf27747251a0821
The Android loader can be found on Maven Central, by adding the following line to your Android app's build.gradle dependencies section:
implementation 'org.khronos.openxr:openxr_loader_for_android:1.0.32'
(or, equivalently, but with a source JAR published as well:
implementation 'org.khronos.openxr:openxr_loader_for_android:1.0.32.1'
)
Alternately, the AAR file (plus signature by the spec editor key and associated POM) are attached to this release.
Other release files are signed by Ryan Pavlik's key, key fingerprint F029455EAB70F520FF4A03BD7F534CD56F00321E.
OpenXR SDK (Source) 1.0.31
OpenXR SDK 1.0.31 (2023-10-18)
This release features two new vendor extensions and minor extension XML
revisions, in addition to compatibility and logging improvements in the
software.
- Registry
- Extension reservation: Reserve extensions for NVIDIA.
(internal MR 2952) - Extension reservation: Reserve extensions for Meta.
(internal MR 2959) - Extension reservation: Reserve extensions for Android.
(internal MR 2966) - Extension reservation: Reserve an extension for
XR_KHR_egl_enable
.
(internal MR 2982) - New vendor extension:
XR_MSFT_scene_marker
(internal MR 2601) - New vendor extension:
XR_ML_user_calibration
(internal MR 2849) - Schematron: Allow chained structs that extend a two-call-idiom struct to carry
only a*CapacityInput
member.
(internal MR 2892,
internal issue 2059) XR_FB_render_model
: Fixstructextends
attribute and removereturnedonly
attribute ofXrRenderModelCapabilitiesRequestFB
, to match the specification
prose.
(internal MR 2765,
OpenXR-Docs issue 153,
internal issue 2017)- xml: Fixed a few errors in MSFT extensions discovered by Schematron checks.
(internal MR 2892)
- Extension reservation: Reserve extensions for NVIDIA.
- SDK
- API Layers: Add logging on API layer negotiation failure.
(internal MR 2926) - Fix: Enable build with clang-cl on Windows through Visual Studio.
(internal MR 2948) - Fix: Remove unused pthread prototypes declaration in
_USE_GNU
ifdef, fixing
builds on some systems.
(internal MR 2981) - Fix comment typo in platform utils header.
(internal MR 2991) - gfxwrapper: Add OpenGL 3.3 functions to an internal utility library used by
hello_xr, shared with the CTS.
(internal MR 2941) - loader: Modify
jnipp
, used by the loader on Android, to no longer use
basic_string<>
with types that are technically not in the C++ specification
as permissible, to fix compatibility with an upcominglibc++
update.
(internal MR 2974,
internal issue 2094,
OpenXR-SDK-Source PR 426) - loader_test: Refactor to use existing macros for all test to avoid repetition.
(internal MR 2922) - scripts: Small fixes and cleanups
(internal MR 2998,
internal MR 2894,
internal MR 2896)
- API Layers: Add logging on API layer negotiation failure.
GitOrigin-RevId: 38114c3ba8eb46d6fafe1761ed08e263ce132237
The Android loader can be found on Maven Central, by adding the following line to your Android app's build.gradle dependencies section:
implementation 'org.khronos.openxr:openxr_loader_for_android:1.0.31'
Alternately, the AAR file (plus signature by the spec editor key and associated POM) are attached to this release.
Other release files are signed by Ryan Pavlik's key, key fingerprint F029455EAB70F520FF4A03BD7F534CD56F00321E.
OpenXR SDK (Source) 1.0.30
OpenXR SDK 1.0.30 (2023-09-20)
This release is primarily a quality improvement release, fixing a range of
issues in the registry and SDK, including fixing a loader bug related to layers,
in addition to a new vendor extension and an updated vendor extension.
- Registry
- Add missing enum tags for enum-sized array struct members.
(internal MR 2731) - Fix EGL "get proc addr" function pointer typedef.
(internal MR 2939) - New vendor extension:
XR_YVR_controller_interaction
(internal MR 2841) XR_BD_controller_interaction
: Add support for G3 devices
(internal MR 2872)- Fix specification errors highlighted by fixed tooling.
(internal MR 2923)
- Add missing enum tags for enum-sized array struct members.
- SDK
- Add installable manual page for
openxr_runtime_list_json
.
(internal MR 2899) - Remove unused diagram exports from loader directory.
(internal MR 2907) - Update URLs in manual pages.
(internal MR 2935) - Validation Layer: Remove conditional
XR_KHR_headless
support as the extension
is not part of OpenXR 1.0.
(internal MR 2901) - build system: Add CTest support for running the loader test.
(internal MR 2289,
OpenXR-SDK-Source issue 309,
internal issue 1733) - hello_xr: Clean up how we specify the default graphics plugin on Android.
(internal MR 2917) - list_json: Add missing return statement for exit code.
(internal MR 2936) - loader: fix for implicit/explicit api layer loading logic
(OpenXR-SDK-Source PR 421,
internal issue 2079)
- Add installable manual page for
GitOrigin-RevId: f7a0c0f3691f0c7b0a239cb34e41d01042d5a02a
The Android loader can be found on Maven Central, by adding the following line to your Android app's build.gradle dependencies section:
implementation 'org.khronos.openxr:openxr_loader_for_android:1.0.30'
Alternately, the AAR file (plus signature by the spec editor key and associated POM) are attached to this release.
Other release files are signed by Ryan Pavlik's key, key fingerprint F029455EAB70F520FF4A03BD7F534CD56F00321E.
OpenXR SDK (Source) 1.0.29
OpenXR SDK 1.0.29 (2023-08-25)
This release contains several fixes to the specification registry, improvements
to the loader, layers, and loader test, as well as enhancements to the loader
documentation/specification to support architecture and ABI specific active
runtime manifest names on Linux and Android.
- Registry
- Change
PFNEGLGETPROCADDRESSPROC
(foreglGetProcAddress
) to a locally
defined type to avoid compiler errors.
(internal MR 2468) - Extension reservation: Register author ID and reserve vendor extensions for
YVR.
(internal MR 2832) - New vendor extension:
XR_META_passthrough_preferences
(internal MR 2694) XR_HTCX_vive_tracker_interaction
: Added new role paths for wrists and ankles.
(internal MR 2728)
- Change
- SDK
- Changes also included in 1.0.28.1 SDK hotfix release
- layers: Build with
/bigobj
or equivalent on Windows due to increased number
of generated functions with spec growth.
(internal MR 2837,
internal issue 2051,
OpenXR-SDK-Source PR 414)
- layers: Build with
- Changes also included in 1.0.28.2 SDK hotfix release
- Android AAR artifacts (loader) and hello_xr: Fix
<queries>
element contents.
(internal MR 2840,
internal issue 2053) - Android AAR artifacts: Fix C++ standard library selection for Android artifacts
inbuild-aar.sh
(internal MR 2836,
internal issue 2052) - Android AAR artifacts: Use
jar
instead of 7-zip to perform archiving, and
document requirements inbuild-aar.sh
(internal MR 2836,
OpenXR-SDK-Source issue 303,
internal issue 1711) - build system: Support SDK hotfix versions (fourth version component).
(internal MR 2836)
- Android AAR artifacts (loader) and hello_xr: Fix
- Add XrVector2f length function to
xr_linear.h
(internal MR 2876) - Add build.gradle files for list_json, c_compile_test.
(internal MR 2908) - Change
PFNEGLGETPROCADDRESSPROC
(foreglGetProcAddress
) to a locally
defined type to avoid compiler errors.
(internal MR 2468) - Enable
loader_test
tests which require a valid extension
(internal MR 2790) - Fix building hello_xr with mingw compiler.
(internal MR 2850) - Improvement: Reduce size of dispatch table in OpenXR loader. (Full size table
still shipped in OpenXR-SDK even though it is not used by the loader anymore.)
(internal MR 2810,
internal MR 2842) - Maintenance script updates.
(internal MR 2900) - loader: Add support for architecture-specific active runtime manifests for
Linux, macOS, and Android.
(internal MR 2450,
internal issue 2066,
internal MR 2871) - loader: refactor to use jnipp on Android
(internal MR 2812) - loader: disable
loader_test
if api layer building is disabled
(internal MR 2843) - loader_test: Replace session test with action test to make test more
maintainable.
(internal MR 2786) - validation layer: Fix deadlock when calling
XR_EXT_debug_utils
functions.
(internal MR 2865)
- Changes also included in 1.0.28.1 SDK hotfix release
The Android loader can be found on Maven Central, by adding the following line to your Android app's build.gradle dependencies section:
implementation 'org.khronos.openxr:openxr_loader_for_android:1.0.29'
Alternately, the AAR file (plus signature by the spec editor key and associated POM) are attached to this release.
Other release files are signed by Ryan Pavlik's key, key fingerprint F029455EAB70F520FF4A03BD7F534CD56F00321E.
OpenXR SDK (Source) 1.0.28 (with 1.0.28.2 hotfix)
OpenXR SDK 1.0.28 (2023-07-10)
NOTE: Binary artifacts for Windows attached to this release correspond to the hotfix release release-1.0.28.1
tag, and binary artifacts for Android correspond to the hotfix release release-1.0.28.2
tag (the 1.0.28 artifacts have been removed as they were defective). See below for the contents of these SDK hotfix releases.
This release contains improved compatibility and code quality fixes for the
loader, support for loading certain API layers on Android-based devices, and a
number of other improvements, in addition to the new extensions. Additionally,
the loader documentation now describes how OpenXR handles compatibility with
Android API levels of 30 and above: runtimes may need to update accordingly to
support this compatibility solution.
- OpenXR SDK 1.0.28.2 hotfix release includes the following fixes
- Loader spec: Fix description of
<queries>
element contents: existing
description would fail to install.
(internal MR 2840,
internal issue 2053) - Android AAR artifacts (loader) and hello_xr: Fix
<queries>
element contents.
(internal MR 2840,
internal issue 2053) - Android AAR artifacts: Fix C++ standard library selection for Android artifacts
inbuild-aar.sh
(internal MR 2836,
internal issue 2052) - Android AAR artifacts: Use
jar
instead of 7-zip to perform archiving, and
document requirements inbuild-aar.sh
(internal MR 2836,
OpenXR-SDK-Source issue 303,
internal issue 1711) - build system: Support SDK hotfix versions (fourth version component).
(internal MR 2836)
- Loader spec: Fix description of
- OpenXR SDK 1.0.28.1 hotfix release includes the following fix
- API dump layer: Fix build on Windows on ARM64.
(OpenXR-SDK-Source PR 414)
- API dump layer: Fix build on Windows on ARM64.
- Registry
- Added defines to
xr.xml
for extension enum base and enum stride.
(internal MR 2693,
OpenXR-Docs issue 148,
internal issue 1979) - Extension reservation: Reserve an extension for
XR_EXT_future
(internal MR 2631) - Extension reservation: Register
ANDROID
author ID and reserve 15 extensions
for it.
(internal MR 2690) - Extension reservation: Reserve extensions for "user presence" and "locate
spaces"
(internal MR 2705) - Extension reservation: Reserve 25 extensions for Magic Leap.
(internal MR 2778) - Extension reservation: Reserve extension for
XR_KHR_extendable_action_binding
(internal MR 2779) - Fix spelling.
(internal MR 2766) - Fixed the error code specification for
xrGetControllerModelPropertiesMSFT
function.
(internal MR 2600) - New multi-vendor extension:
XR_EXT_hand_interaction
(internal MR 2116) - New multi-vendor extension:
XR_EXT_plane_detection
(internal MR 2510,
internal MR 2791) - New multi-vendor extension:
XR_EXT_hand_tracking_data_source
(internal MR 2568) - New vendor extension:
XR_META_passthrough_color_lut
(internal MR 2507) - New vendor extension:
XR_META_virtual_keyboard
(internal MR 2555) - New vendor extension:
XR_OPPO_controller_interaction
(OpenXR-Docs PR 146) - Update Magic Leap contact
(internal MR 2699) XR_FB_face_tracking
: Non-functional registry change, fixing a problem with
standalone headers.
(internal MR 2663)XR_FB_scene
: IntroduceXrSemanticLabelsSupportInfoFB
and bump spec version
to 3.
(internal MR 2682)XR_FB_spatial_entity
andXR_FB_scene
: AddXR_ERROR_SIZE_INSUFFICIENT
return code to functions which use the two-call idiom.
(internal MR 2718)XR_FB_touch_controller_pro
: Fix XML to require thetouch_controller_pro
interaction profile for the extension
(internal MR 2806)- registry: Remove extraneous whitespace from some commands.
(OpenXR-SDK-Source PR 397) - schematron: Improve self tests.
(internal MR 2680) - schematron: Require vendor tag on interaction profile paths introduced by
extensions.
(internal MR 2684) - scripts: Allow schematron to check an alternate XML file.
(internal MR 2670)
- Added defines to
- SDK
- Allow compilation of OpenXR SDK on Mac
(internal MR 2788,
internal MR 2789,
internal MR 2790,
internal MR 2800) - Common: Add
stdint.h
include toplatform_utils.hpp
for GCC 13+
(OpenXR-SDK-Source PR 406) - Describe building OpenXR SDK on macOS with Xcode
(internal MR 2768) - Handle clang-format-16 in
runClangFormat.sh
, and adjust source files so its
output matches the earlier version used on CI.
(internal MR 2666,
internal MR 2814) - Improvement: Fix clang warning
-Wundef
.
(internal MR 2717) - Improvement: Fix leftover warnings when building with
-Wall
.
(internal MR 2754,
OpenXR-SDK-Source PR 410) - Loader: On Android, use a single logcat tag for all parts of the loader.
(internal MR 2688) - Loader: Update the required
queries
elements for an OpenXR application on
Android, so that runtime and layer components loaded in the application process
may access their own package in API >29.
(internal MR 2708) - Loader: Search system directories for API layer manifests on Android
(internal MR 2709) - Loader: Add Product and OEM partition to active runtime search path on Android
(internal MR 2709) - Loader: Improve casting to
uint32_t
edge case handling.
(internal MR 2745) - Loader: Clear possible dangling
next
pointers inXR_EXT_debug_utils
label
structures.
(internal MR 2764) - Validation Layer: Fix the validation_layer_generator to not check static array
addresses.
(OpenXR-SDK-Source PR 399) - api_layers: Update API Layers spec section in README.md
(internal MR 2753) - cmake: Set up alias targets
OpenXR::openxr_loader
andOpenXR::headers
so
that the loader and headers may be used the same whether you used
find_package(OpenXR)
on binaries or have included the source tree as a
subproject.
(internal MR 2793) - gradle: Add license for gradlew and gradlew.bat
(internal MR 2725) - gradle: General cleanup and updates of Android build system.
(internal MR 2796) - hello_xr:...
- Allow compilation of OpenXR SDK on Mac
OpenXR SDK (Source) 1.0.27
OpenXR SDK 1.0.27 (2023-03-21)
This release contains a large list of improvements, including interaction
profile definitions in machine-readable format in the XML, consistent tool-based
formatting of the XML, a new list_json
tool to ease updates to
OpenXR-Inventory, and a wide variety of new vendor and multi-vendor
extensions, in addition to a collection of smaller improvements.
- Registry
- Add interaction profile definitions to
xr.xml
(internal MR 2485) - Chore: Format the full XML API registry with
PrettyRegistryXML, making some
small changes by hand to clean up.
(internal MR 2540,
internal MR 2329,
OpenXR-SDK-Source PR 373,
OpenXR-Docs PR 14,
OpenXR-CTS PR 50,
OpenXR-SDK PR 12) - Document how to generate a standalone header file for an extension.
(internal MR 2627) - Extension reservation: Register author ID and reserve vendor extensions for
Logitech.
(internal MR 2504) - Extension reservation: Reserve an extension number for a multi-vendor
extension.
(internal MR 2520) - Extension reservation: Reserve an extension for
XR_EXT_hand_tracking_usage
(internal MR 2550) - Extension reservation: Reserve extension id 430 for
XR_EXT_plane_detection
(internal MR 2565) - Extension reservation: Reserve vendor extensions for Monado.
(internal MR 2613) - Extension reservation: Reserve vendor extensions for ACER.
(OpenXR-Docs PR 142) - Extension reservation: Reserve a vendor extension for OPPO.
(OpenXR-Docs PR 145) - New vendor extension:
XR_FB_composition_layer_depth_test
(internal MR 2208,
internal issue 1657) - New vendor extension:
XR_META_foveation_eye_tracked
(internal MR 2239,
internal MR 2273,
internal MR 2332) - New vendor extension:
XR_QCOM_tracking_optimization_settings
(internal MR 2261,
internal issue 1703) - New vendor extension:
XR_META_local_dimming
(internal MR 2267,
internal MR 2595) - New vendor extension:
XR_FB_spatial_entity_sharing
(internal MR 2274) - New vendor extension:
XR_FB_scene_capture
(internal MR 2286) - New vendor extension:
XR_FB_spatial_entity_storage_batch
(internal MR 2312) - New vendor extension:
XR_FB_haptic_amplitude_envelope
(internal MR 2326) - New vendor extension:
XR_FB_touch_controller_pro
(internal MR 2327,
internal issue 1916) - New vendor extension:
XR_FB_haptic_pcm
(internal MR 2329) - New vendor extension:
FB_face_tracking
(internal MR 2334,
internal MR 2539) - New vendor extension:
XR_FB_eye_tracking_social
(internal MR 2336,
internal MR 2576) - New vendor extension:
XR_FB_body_tracking
(internal MR 2339,
internal MR 2575) - New vendor extension:
XR_OCULUS_external_camera
(internal MR 2397,
internal MR 2344) - New vendor extension:
XR_FB_spatial_entity_user
(internal MR 2407) - New vendor extension:
XR_FB_touch_controller_proximity
(internal MR 2412) - New vendor extension:
XR_ML_global_dimmer
(internal MR 2461) - New vendor extension:
XR_ML_frame_end_info
(internal MR 2462,
internal MR 2536) - New vendor extension:
XR_ML_compat
(internal MR 2473) - New vendor extension:
XR_EXT_local_floor
(internal MR 2503,
internal issue 746,
internal issue 1606,
OpenXR-Docs issue 103) - New vendor extension:
XR_BD_controller_interaction
(internal MR 2527) - New vendor extension:
XR_MNDX_force_feedback_curl
(OpenXR-Docs PR 136) - Register author ID for Matthieu Bucchianeri.
(OpenXR-Docs PR 143) - Rename tag name to a short one for ByteDance.
(internal MR 2502) - Schema: Add initial tests for Schematron rules.
(internal MR 2512) - Schema: Add author ID schematron checks and change duplicate name/number report
to an assert
(internal MR 2514) - Schema: Fix Relax-NG checks of naming convention, and add naming convention
checks to Schematron.
(internal MR 2538) - Schematron: Update extension naming rule to allow for vendor tags to be
followed by an X for experimental and a version number
(internal MR 2518) - scripts: Let
deprecated
overrideprovisional
when choosing extension table
of contents section.
(internal MR 2547) - scripts: Fix leftover exclusion of
extensions/meta
fromcheckMarkup
now
that it no longer generated files.
(internal MR 2560)
- Add interaction profile definitions to
- SDK
- Experimental Extension Naming: Allow vendor tags to be followed by an "X" for
experimental and an optional version number (e.g. XR_EXTX2_hand_tracking).
Update source generator vendor checks accordingly
(internal MR 2518) - Fix typo in API Dump generation script
(internal MR 2608) - Loader: Fix dynamic build on MinGW.
(OpenXR-SDK-Source PR 362,
OpenXR-SDK-Source issue 367) - Loader and layers: In debug builds, log when non-empty environment variables
are being ignored due to executing with elevated privilege.
(OpenXR-SDK-Source PR 336) - Loader doc: Minor cleanups to API layer section.
(internal MR 2581) - Loader doc: Fix incorrect markup/dead links.
(internal MR 2598) - Remove third-party dependencies in
external/include/utils
.
(internal MR 2528) - Update all XrStructureType initialization to use standard OpenXR style.
(internal MR 2557) - Update URLs with branch names in manpages.
(internal MR 2648) - Validation layer: Fix function signature for xrNegotiateLoaderApiLayerInterface
in core validation api layer
...
- Experimental Extension Naming: Allow vendor tags to be followed by an "X" for