Skip to content

Releases: KhronosGroup/OpenXR-Docs

OpenXR Specification (Source) 1.1.43

27 Nov 18:22
release-1.1.43
Compare
Choose a tag to compare

OpenXR Specification 1.1.43 (2024-11-27)

This release has a few clarifications and fixes, as well as several new vendor
extensions.

  • Registry
    • Bump version of XR_KHR_vulkan_swapchain_format_list and note that it depends
      on either XR_KHR_vulkan_enable or XR_KHR_vulkan_enable2.
      (internal MR 3418)
    • Fix: Correctly mark XR_FB_touch_controller_pro and
      XR_META_touch_controller_plus as promoted to 1.1.
      (internal MR 3586)
    • Improvement: Small XML formatting/organization cleanups.
      (internal MR 3610)
    • New vendor extension: XR_ML_facial_expression
      (internal MR 3100)
    • New vendor extension: XR_META_passthrough_layer_resumed_event
      (internal MR 3106)
    • New vendor extensions: XR_META_colocation_discovery,
      XR_META_spatial_entity_sharing, and XR_META_spatial_entity_group_sharing
      (internal MR 2782)
    • Reservation: Reserve numbers for spatial extensions.
      (internal MR 3577)
  • Specification
    • Clarify: Improve the Input and Semantic Paths chapters by reducing the number
      of undefined or conflated terms used and improving consistency.
      (internal MR 3443)
    • Fix: Correct extension reference in XR_KHR_vulkan_swapchain_format_list and
      clarify "being used" to not just mean "enabled".
      (internal MR 3418)
    • Fix: The parent of an action space is a XrSession.
      (internal MR 3601,
      OpenXR-Docs issue 178,
      internal issue 2395)
    • Improvement: Clarify XR_EXT_future code example for two-call idiom.
      (internal MR 3578)
    • Improvement: Note the changes made when promoting XR_FB_touch_controller_pro
      and XR_META_touch_controller_plus to OpenXR 1.1.
      (internal MR 3586)
    • New vendor extension: XR_META_passthrough_layer_resumed_event allowing
      applications to receive feedback from XR_FB_passthrough
      (internal MR 3106)
    • New vendor extension specification: XR_META_colocation_discovery - allowing
      advertisement and discovery of other devices, physically colocated, running the
      same app.
      (internal MR 2782,
      internal MR 3604,
      internal MR 3605)
    • New vendor extension specification: XR_ML_facial_expression providing access
      to face tracking on supported devices, with a custom subset of blend shapes
      possible.
      (internal MR 3100)
    • New vendor extension specifications: XR_META_spatial_entity_sharing, and
      XR_META_spatial_entity_group_sharing - an updated way to share vendor-
      specific spatial entities.
      (internal MR 2782,
      internal MR 3605)

OpenXR Specification (Source) 1.1.42

25 Oct 21:48
release-1.1.42
Compare
Choose a tag to compare

OpenXR Specification 1.1.42 (2024-10-25)

This release contains a collection of specification clarifications, an updated
vendor extension with renamed enumerants, and substantial improvements and fixes
to the XML registry, particularly the description of interaction profiles.

  • Registry
    • Fix: Update schema to reflect that XrPathString_t should allow dash in
      interaction profile paths.
      (internal MR 3493)
    • Fix: XR_VARJO_xr4_controller_interaction did not properly define its
      interaction profile in XML.
      (internal MR 3493,
      internal MR 3548)
    • Fix: Correct XML description of OpenXR 1.1 related additions to the promoted
      Meta Touch Plus, Touch Pro, and Touch (Rift CV1) controller interaction
      profiles.
      (internal MR 3513,
      internal issue 2350,
      internal issue 2375)
    • Fix: Add missing XML description of EXT_hand_interaction additions to several
      interaction profiles, and add comments to clarify where profile additions
      should be located.
      (internal MR 3517,
      internal MR 3541,
      internal MR 3552)
    • Fix: Corrections to the Schema chapter of the style guide.
      (internal MR 3521)
    • Improvement: Small consistency clean-up.
      (internal MR 3512)
    • Improvement: Clean up .rnc schema to improve readability.
      (internal MR 3521)
    • Scripts: Improve update_version.py used in release process.
      (internal MR 3543)
    • Update: Change naming convention in XR_HTC_facial_expression: rename
      XR_LIP_EXPRESSION_MOUTH_SMILE_RIGHT_HTC to
      XR_LIP_EXPRESSION_MOUTH_RAISER_RIGHT_HTC,
      XR_LIP_EXPRESSION_MOUTH_SMILE_LEFT_HTC to
      XR_LIP_EXPRESSION_MOUTH_RAISER_LEFT_HTC,
      XR_LIP_EXPRESSION_MOUTH_SAD_RIGHT_HTC to
      XR_LIP_EXPRESSION_MOUTH_STRETCHER_RIGHT_HTC and
      XR_LIP_EXPRESSION_MOUTH_SAD_LEFT_HTC to
      XR_LIP_EXPRESSION_MOUTH_STRETCHER_LEFT_HTC, providing the old names as
      compatibility aliases.
      (internal MR 3408)
  • Specification
    • Clarify: In "Fundamentals," improve the language regarding forward/backward
      prediction/history time limits, without affecting behavior.
      (internal MR 3063)
    • Clarify: The path(s) returned by xrEnumerateBoundSourcesForAction have no
      inherent semantic meaning nor association with other paths in the
      specification. They are opaque and only suitable for use with
      xrGetInputSourceLocalizedName.
      (internal MR 3495)
    • Fix: Show the correct ratified-specific text in the copyright section for the
      KHR-only spec build.
      (internal MR 3568,
      internal issue 2388)
    • Improvement: Clarify XR_VARJO_xr4_controller_interaction interaction with
      palm pose extension and grip surface.
      (internal MR 3493)
    • Improvement: Clarify text and normatives related to xrGetInstanceProcAddr,
      without changing required behavior.
      (internal MR 3512)
    • Update: Change naming convention in XR_HTC_facial_expression: rename
      XR_LIP_EXPRESSION_MOUTH_SMILE_RIGHT_HTC to
      XR_LIP_EXPRESSION_MOUTH_RAISER_RIGHT_HTC,
      XR_LIP_EXPRESSION_MOUTH_SMILE_LEFT_HTC to
      XR_LIP_EXPRESSION_MOUTH_RAISER_LEFT_HTC,
      XR_LIP_EXPRESSION_MOUTH_SAD_RIGHT_HTC to
      XR_LIP_EXPRESSION_MOUTH_STRETCHER_RIGHT_HTC and
      XR_LIP_EXPRESSION_MOUTH_SAD_LEFT_HTC to
      XR_LIP_EXPRESSION_MOUTH_STRETCHER_LEFT_HTC, providing the old names as
      compatibility aliases.
      (internal MR 3408)

OpenXR Specification (Source) 1.1.41

26 Sep 15:15
release-1.1.41
Compare
Choose a tag to compare

OpenXR Specification 1.1.41 (2024-09-25)

This release features several new vendor extensions, as well as several
clarifications and improvements to existing specifications.

  • Registry
    • Change: Allow structs that can extend multiple other structs in the RelaxNG
      schema, as already permitted by the Vulkan schema.
      (internal MR 2869)
    • New vendor extension: XR_HTC_body_tracking
      (internal MR 2549)
    • New vendor extension: XR_ML_spatial_anchors
      (internal MR 2803)
    • New vendor extension: XR_ML_spatial_anchors_storage
      (internal MR 2804)
    • New vendor extension: XR_ML_system_notifications
      (internal MR 2946)
    • New vendor extension: XR_ML_world_mesh_detection
      (internal MR 2950)
    • New vendor extension: XR_ML_view_configuration_depth_range_change
      (internal MR 3036)
  • Specification
    • New vendor extension specification: XR_HTC_body_tracking provides an
      interface for full-body joint tracking.
      (internal MR 2549)
    • New vendor extension specification: XR_ML_spatial_anchors introduces an API
      to interact with Magic Leap spatial anchors.
      (internal MR 2803)
    • New vendor extension specification: XR_ML_spatial_anchors_storage allows for
      storage and retrieval of Magic Leap spatial anchors in local or cloud storage
      (internal MR 2804)
    • New vendor extension specification: XR_ML_system_notifications provides
      control over suppressing system notifications.
      (internal MR 2946)
    • New vendor extension specification: XR_ML_world_mesh_detection provides
      access to a world mesh.
      (internal MR 2950)
    • New vendor extension specification:
      XR_ML_view_configuration_depth_range_change permits the clipping planes to be
      changed by the runtime during the lifetime of an instance.
      (internal MR 3036)
    • Fix: Corrected swapchain image layout requirements for XR_KHR_D3D12_enable,
      XR_KHR_vulkan_enable, and XR_KHR_vulkan_enable2 so that the runtime's
      guarantees are made after xrWaitSwapchainImage returns XR_SUCCESS, instead
      of after xrAcquireSwapchainImage. (Queue access rules are unchanged.)
      (internal MR 3353,
      internal issue 2269)
    • Fix: references to core specification from
      XR_EXT_composition_layer_inverted_alpha and
      XR_FB_composition_layer_alpha_blend.
      (internal MR 3470)
    • Fix: markup for internal anchors for revision history subsections.
      (internal MR 3470)
    • Fix: remove a normative keyword from XR_META_headset_id version history.
      (internal MR 3470)
    • Improvement: Clean up formatting of source adoc files.
      (internal MR 3461)

OpenXR Specification (Source) 1.1.40

22 Aug 16:41
release-1.1.40
Compare
Choose a tag to compare

OpenXR Specification 1.1.40 (2024-08-22)

This release features a new ratified graphics API binding extension,
XR_KHR_metal_enable, as well as an update to the wording about environments
and environment blend modes, making it clear they can be used for physical as
well as synthetic passthrough. There are also an assortment of smaller fixes and
clarifications.

  • Registry
    • Add: New ratified Khronos extension: XR_KHR_metal_enable.
      (internal MR 2721)
    • Chore: Reserve 15 extension id numbers for ByteDance.
      (internal MR 3409)
    • Fix: Clarified that views in XR_VARJO_quad_views needs to have identical
      poses for each eye.
      (internal MR 3396)
    • Fix: Add missing interaction profile extensions for OpenXR 1.1 promoted Meta
      interaction profiles.
      (internal MR 3398)
    • Fix: Correctly mark the Magic Leap home button as a system button in the XML.
      (internal MR 3405)
    • Fix: Add XR_ERROR_VALIDATION_FAILURE to all functions from
      XR_EXT_conformance_automation.
      (internal MR 3417)
  • Specification
    • Add: New ratified Khronos extension specification: XR_KHR_metal_enable.
      (internal MR 2721)
    • Clarify: Clarify the definition of "environment" in the context of "environment
      blend mode".
      (internal MR 3301)
    • Clarify: Devices may use environment blend mode to control passthrough and
      synthentic environments.
      (internal MR 3301)
    • Clarify: Clarified that views in XR_VARJO_quad_views needs to have identical
      poses for each eye.
      (internal MR 3396)
    • Fix: Correct the maximum extension number in the appendix.
      (internal MR 3397)
    • Fix: Add missing interaction profile extensions for OpenXR 1.1 promoted Meta
      interaction profiles.
      (internal MR 3398)
    • Fix: Remove incorrect implicit valid usage from loader interface APIs.
      (internal MR 3416)
    • Fix: Fix a typo in the spec for xrCreateApiLayerInstance.
      (internal MR 3416)

Note: There is no 1.1.39 release: it was skipped to keep the monthly patch
version increment cadence given the lack of a release in July.

OpenXR Specification (Source) 1.1.38

10 Jun 22:07
release-1.1.38
Compare
Choose a tag to compare

OpenXR Specification 1.1.38 (2024-06-09)

This is a fairly small release, with one new extension and a handful of fixes.

  • Registry
    • Addition: New multi-vendor extension: XR_EXT_composition_layer_inverted_alpha
      (internal MR 3085,
      internal MR 3385)
    • Chore: Reserve an extension for Logitech.
      (internal MR 3384)
    • Chore: Register author tag for Deep Mirror.
      (OpenXR-Docs PR 171)
    • Fix: XrCompositionLayerPassthroughFB has a "parentstruct" of
      XrCompositionLayerBaseHeader (it is based on this type), rather than
      "structextends" (in the next chain). Bump extension revision.
      (internal MR 3305)
    • Fix: XR_EXT_plane_detection: Fix extents description and plane axis to match
      CTS and implementations.
      (internal MR 3374,
      internal issue 2281)
    • Fix: Correct typo in XR_FB_keyboard_tracking flag description.
      (internal MR 3393)
  • Specification
    • Addition: New multi-vendor extension specification:
      XR_EXT_composition_layer_inverted_alpha
      (internal MR 3085)
    • Addition: Support emitting more comment attributes/elements from XML, and
      enable it for standalone headers.
      (internal MR 3377)
    • Fix: Note errata regarding third field name in
      XrCompositionLayerPassthroughFB. Bump extension revision due to XML fix.
      (internal MR 3305)
    • Fix: XR_EXT_plane_detection: Fix extents description and plane axis to match
      CTS and implementations.
      (internal MR 3374,
      internal issue 2281)
    • Fix: Correct typo in XR_FB_keyboard_tracking flag description.
      (internal MR 3393)
    • Fix: Correct typo in loader design document.
      (internal MR 3393)

OpenXR Specification (Source) 1.1.37

25 May 02:25
release-1.1.37
Compare
Choose a tag to compare

OpenXR Specification 1.1.37 (2024-05-23)

This release adds new defines for easier use of both OpenXR 1.0 and 1.1 with
up-to-date headers, as well as some minor fixes, cleanups, and clarifications.

OpenXR Specification (Source) 1.1.36

15 Apr 05:42
release-1.1.36
Compare
Choose a tag to compare

OpenXR Specification 1.1.36 (2024-04-15)

This is a substantial update to the OpenXR specification.

Read more

OpenXR Specification (Source) 1.0.34

17 Feb 20:58
release-1.0.34
Compare
Choose a tag to compare

OpenXR Specification 1.0.34 (2024-02-16)

This release features clarifications to the specification, as well as a number
of new multi-vendor and vendor extensions, and additional functionality in the
reflection header.

  • Registry
  • Specification
    • Clarification: Change normative "should" statements to "may" for the
      interaction of user engagement sensors and the session lifecycle, in order to
      represent the intended and actual optionality of that behavior. Specifically,
      it is valid but completely optional for runtimes to use the user engagement
      sensor (if it exists) to move to XR_SESSION_STATE_STOPPING.
      (internal MR 3022)
    • Clarification: Swapchain usage flags errors should return
      XR_ERROR_FEATURE_UNSUPPORTED as well.
      (internal MR 3194)
    • New multi-vendor extension specification: XR_EXT_user_presence
      (internal MR 2706,
      internal issue 1585)
    • New vendor extension specification: XR_META_recommended_layer_resolution
      (internal MR 2570)
    • New vendor extension specification: XR_META_automatic_layer_filter
      (internal MR 2696)
    • New vendor extension specification: XR_META_spatial_entity_mesh
      (internal MR 2773)
    • New vendor extension specification: XR_FB_face_tracking2
      (internal MR 2811)
    • New vendor extension specification: XR_VARJO_xr4_controller_interaction
      (internal MR 3078)
    • Spec: Move originals of images to separate folder.
      (internal MR 3218)
    • Spec: Fix issue where some comments before defines were missing a newline.
      (internal MR 3227)
    • Style guide: Fix several leftover references to Vk/Vulkan.
      (internal MR 2967)
    • XR_FB_scene: Update to spec version 4.
      (internal MR 2774)
    • XR_META_headset_id and XR_FB_spatial_entity: Bump spec versions to drop
      XR_EXT_uuid dependency from spec.
      (internal MR 2577)
    • external: Update Jinja2 Python module shipped with repository (for spec/header
      generation) to 2.11.3.
      (internal MR 3221,
      internal MR 3237)

OpenXR Specification (Source) 1.0.33

04 Jan 23:31
release-1.0.33
Compare
Choose a tag to compare

OpenXR Specification 1.0.33 (2024-01-03)

This release primarily adds new ratified functionality to the specification
describing the loader interaction with runtimes and API layers. This
functionality was previously described in non-normative text in the loader
design document, but was universally adopted for compatibility. It is now part
of the normative, ratified core specification. 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 from loader_interfaces.h to a new
      generated header openxr_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)
  • Specification
    • Khronos ratified specification addition: move loader negotiation functions into
      the specification proper (from the loader design doc), moving corresponding
      functions from loader_interfaces.h to openxr_loader_negotiation.h. (The
      exact ratified core specification text is 1.0.29 with these changes added,
      available internally. Non-substantive core specification updates/fixes have
      occurred since then.)
      (internal MR 2807,
      internal issue 1953,
      internal MR 3101)
    • Scripts: Adjust Makefile so we now error on any checkSpecLinks warning when
      running that target.
      (internal MR 3072)
    • XR_HTC_anchor: Fix parameter name error in prose description.
      (internal MR 3072)
    • 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 revision info and version to 2 to reflect function
      pointer type change released in 1.0.29.
      (OpenXR-Docs PR 159)
    • loader design doc: Fix minor typos.
      (internal MR 3065,
      internal MR 3103)
  • 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

OpenXR Specification (Source) 1.0.32

29 Nov 22:00
release-1.0.32
Compare
Choose a tag to compare

OpenXR Specification 1.0.32 (2023-11-29)

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 features the remaining "checkSpecLinks" consistency warning fixes
in the manually-written specification text in extensions.

  • Registry
  • Specification
    • XR_KHR_loader_init: New Khronos ratified revision, now additionally specifies
      forwarding loader init calls to API layers
      (internal MR 2703)
    • Fix "checkSpecLinks" warnings about member and parameter references in
      extensions to the specification. This has changed the documentation of a number
      of structures and functions across several extensions, although the C
      prototypes/definitions in the spec as well as the header file contents have
      stayed constant.
      (internal MR 2970)
    • New vendor extension specification: XR_HTC_anchor
      (internal MR 2667)
    • New vendor extension specification: XR_META_touch_controller_plus
      (internal MR 2702)
    • New vendor extension specification: XR_ML_marker_understanding
      (internal MR 2750)
    • New vendor extension specification: XR_ML_localization_map
      (internal MR 2802,
      internal MR 3045,
      internal MR 3047)

GitOrigin-RevId: 0a6bbc30cf10fdec436dfa81abf27747251a0821