Skip to content

Releases: KhronosGroup/OpenXR-Docs

OpenXR Specification (Source) 1.0.27

22 Mar 17:54
release-1.0.27
Compare
Choose a tag to compare

OpenXR Specification 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, several spec cleanups and clarifications, and a wide
variety of new vendor and multi-vendor extensions.

Read more

OpenXR Specification (Source) 1.0.26

19 Nov 03:30
release-1.0.26
Compare
Choose a tag to compare

OpenXR Specification 1.0.26 (2022-11-18)

This release contains some spec clarifications, improvements to tooling, and a
variety of new vendor and multi-vendor extensions.

  • Registry
  • Specification
    • Clarify the valid swapchain face count values for layer types.
      (internal MR 2354,
      internal issue 1750)
    • Clarify error codes returned in vendor extension XR_META_performance_metrics.
      (internal MR 2422)
    • Clarify function xrEnumerateInstanceExtensionProperties by removing
      conflicting and redundant language about two-call idiom.
      (internal MR 2441)
    • Clarify language around swapchain creation format matching usage.
      (internal MR 2446)
    • Document new XR_EXT_active_action_set_priority vendor extension.
      (internal MR 2288,
      internal issue 1699)
    • Document new XR_HTC_passthrough vendor extension.
      (internal MR 2349)
    • Document new XR_HTC_foveation vendor extension.
      (internal MR 2377)
    • Document new XR_META_headset_id vendor extension.
      (internal MR 2410)
    • Fix naming of member descriptions for XrInputSourceLocalizedNameGetInfo.
      (internal MR 2419,
      internal issue 1614,
      OpenXR-Docs issue 106)
    • Loader spec: Update to note that the Android installable broker no longer checks for
      permission. The permission, normally auto-granted, was removed due to causing
      conflicts with installation order.
      (internal MR 2452,
      internal issue 1836)
    • Move the documentation of XrSwapchainUsageFlags/XrSwapchainUsageFlagBits to
      its usage, next to XrSwapchainCreateFlags, and mark up normative language.
      (internal MR 2435)
    • Move flag bit documentation to the FlagBit type ref pages, and move the
      typedefs for the Flags types into new corresponding flag ref pages. This
      resolves an unneeded inconsistency between core and extensions as well as
      between core and other related specifications like Vulkan.
      (internal MR 2435)
    • Optimize images included in the specification.
      (internal MR 2493)
    • XR_EXT_performance_settings: Updated generated valid usage through XML
      change, bump revision accordingly.
      (internal MR 2306)
    • XR_HTC_facial_tracking: Update vendor extension to fix an error in the blink
      blend shape ranges, increasing its revision to 2.
      (internal MR 2416)
    • XR_KHR_vulkan_enable2 - Add missing member documentation for type, next,
      and createFlags in XrVulkanInstanceCreateInfoKHR
      (internal MR 2435)

OpenXR Specification (Source) 1.0.25

03 Sep 02:48
release-1.0.25
Compare
Choose a tag to compare

OpenXR Specification 1.0.25 (2022-09-02)

This release contains a few specification clarifications and consistency improvements,
as well as some new vendor extensions. The spec generation toolchain scripts have
been synchronized with Vulkan, which adds some additional detail to the generated
spec document. The loader design document has also been updated to correct an error
and document the loader's API layer functionality now available on Android.

  • Registry
    • Add new XR_ML_ml2_controller_interaction vendor extension.
      (internal MR 2344)
    • Clarification: Note that all specialized swapchain image structures are
      "returnedonly", which removes some unneeded generated implicit valid usage.
      (internal MR 2303)
    • Clarification: Note that all event structs are "returnedonly", which removes
      some unneeded generated implicit valid usage.
      (internal MR 2305)
    • Register author ID for Oppo.
      (OpenXR-Docs PR 129)
    • Register author ID for Fred Emmott.
      (OpenXR-Docs PR 131)
    • Register author ID for Acer.
      (OpenXR-Docs PR 132)
    • Reserve extension numbers for anticipated cross-vendor and Khronos extensions.
      (internal MR 2337,
      internal MR 2338,
      internal MR 2389)
    • Reserve a vendor extension for Huawei.
      (internal MR 2356)
    • Reserve vendor extensions for MNDX.
      (OpenXR-Docs PR 133)
    • Update XR_MSFT_scene_understanding and
      XR_MSFT_scene_understanding_serialization vendor extensions to list error
      codes that may be returned by functions.
      (internal MR 2316)
    • XR_FB_color_space: Mark XrSystemColorSpacePropertiesFB as "returned-only"
      for consistency and to correct the implicit valid usage.
      (internal MR 2304)
    • XR_FB_display_refresh_rate: Mark XrEventDataDisplayRefreshRateChangedFB as
      "returned only" for consistency.
      (internal MR 2308)
    • XR_FB_hand_tracking_mesh: Fix two-call-idiom markup for
      XrHandTrackingMeshFB, affecting implicit valid usage, and increment the
      revision.
      (internal MR 2311)
    • XR_FB_passthrough: Add XrSystemPassthroughProperties2FB and
      XR_PASSTHROUGH_LAYER_DEPTH_BIT_FB, update spec version to 3.
      (internal MR 2333)
    • XR_FB_render_model: Mark XrRenderModelCapabilitiesRequestFB as "returned-
      only" for consistency and to correct the implicit valid usage.
      (internal MR 2309)
  • Specification
    • Clarify that orientation behaves the same as position when tracking loss occurs
      for static spaces.
      (internal MR 2235)
    • Clarify the interaction of xrGetInputSourceLocalizedName and
      xrEnumerateBoundSourcesForAction, the paths they operate on, and details of a
      "bound source" for an action.
      (internal MR 2251,
      internal issue 1671)
    • Clarify when pose actions with multiple bindings may change source
      (internal MR 2277)
    • Clarify: Add language to OpenXR patch versions to clarify that it may be used
      to gate runtime implementation changes
      (internal MR 2290,
      internal issue 1713)
    • Document new XR_ML_ml2_controller_interaction vendor extension with the Magic
      Leap 2 controller interaction profile.
      (internal MR 2344)
    • Loader design doc: Correct a wrong description of extension implementation
      chosen by the loader when duplicates.
      (internal MR 2324,
      internal issue 1731)
    • Loader design doc: Add Android support for API Layers in the application APK.
      (internal MR 2350)
    • XR_FB_color_space: Mark XrSystemColorSpacePropertiesFB as "returned-only"
      for consistency and to correct the implicit valid usage, bumping the revision
      number.
      (internal MR 2304)
    • XR_FB_hand_tracking_mesh: Fix XrHandTrackingMeshFB two-call-idiom implicit
      valid usage, and increment the revision.
      (internal MR 2311)
    • XR_FB_passthrough: Add XrSystemPassthroughProperties2FB and
      XR_PASSTHROUGH_LAYER_DEPTH_BIT_FB.
      (internal MR 2333,
      internal MR 2393)
    • XR_FB_render_model: Mark XrRenderModelCapabilitiesRequestFB, as "returned-
      only" for consistency and to correct the implicit valid usage, incrementing the
      revision number.
      (internal MR 2309)
    • XR_MSFT_scene_understanding_serialization: Update vendor extension to
      document when xrDeserializeSceneMSFT must return
      XR_ERROR_COMPUTE_NEW_SCENE_NOT_COMPLETED_MSFT.
      (internal MR 2316)
    • scripts: Synchronize scripts with Vulkan, and move all generated files into a
      single target directory.
      (internal MR 2335,
      internal issue 1693,
      internal MR 2393,
      internal MR 2400)

OpenXR Specification (Source) 1.0.24

23 Jun 18:20
release-1.0.24
Compare
Choose a tag to compare

OpenXR Specification 1.0.24 (2022-06-23)

OpenXR Specification (Source) 1.0.23

28 May 02:44
release-1.0.23
Compare
Choose a tag to compare

OpenXR Specification 1.0.23 (2022-05-27)

This release includes a large number of new vendor and multi-vendor extensions,
as well as some updates to existing extensions. It also adds some details about
app manifest requirements on Android.

  • Registry
    • Add new XR_ULTRALEAP_hand_tracking_forearm vendor extension.
      (internal MR 2154)
    • Add new XR_EXT_dpad_binding multi-vendor extension.
      (internal MR 2159)
    • Add "externally synchronized" markup for xrBeginFrame and xrEndFrame so
      they get the matching box and their session parameters are included in the list
      of externally-synchronized parameters in the "Threading" section.
      (internal MR 2179,
      OpenXR-Docs issue 23,
      internal issue 1216)
    • Add new XR_FB_spatial_entity vendor extension.
      (internal MR 2194)
    • Add new XR_FB_spatial_entity_storage vendor extension.
      (internal MR 2194)
    • Add new XR_FB_spatial_entity_query vendor extension.
      (internal MR 2194)
    • Add new XR_FB_composition_layer_settings vendor extension.
      (internal MR 2221)
    • Add new XR_FB_spatial_entity_container vendor extension.
      (internal MR 2236)
    • Add new XR_HTC_vive_wrist_tracker_interaction vendor extension.
      (internal MR 2252)
    • Add XR_HTC_hand_interaction extension.
      (internal MR 2254)
    • Add new XR_VARJO_view_offset vendor extension.
      (internal MR 2255)
    • Add new XR_META_performance_metrics vendor extension.
      (internal MR 2256)
    • Add new XR_META_vulkan_swapchain_create_info vendor extension.
      (internal MR 2257)
    • Change the XML type of XR_MIN_COMPOSITION_LAYERS_SUPPORTED so it outputs an
      includable snippet for the spec text.
      (internal MR 2201,
      internal issue 1652,
      OpenXR-Docs issue 117)
    • Fix registry consistency script and codegen scripts to allow extension of KHR
      and EXT enumerations with vendor-specific members.
      (internal MR 2213,
      internal MR 2243)
    • Fix warning print statement arguments in header generation/validation script.
      (internal MR 2244)
    • Reserve the extension number for multi-vendor hand interaction profile
      extension.
      (internal MR 2206)
    • Reserve vendor extensions 304-317 for Qualcomm
      (internal MR 2258)
    • Reserve vendor extensions 318-370 for HTC.
      (internal MR 2266)
    • KHR_composition_layer_depth: Update spec version to 6 for updated spec text.
      (internal MR 2207,
      internal issue 1651)
    • XR_EXT_eye_gaze_interaction: Update the spec version for spec text change.
      (internal MR 2227)
    • XR_EXT_uuid: Add enum tags to XR_UUID_SIZE_EXT to ensure it is defined
      before XrUuidEXT in generated header
      (internal MR 2234,
      internal issue 1673)
    • XR_FB_hand_aim_tracking, XR_FB_hand_tracking_capsule,
      XR_FB_hand_tracking_mesh: Fix documentation to specify correct next chain
      usage.
      (internal MR 2229)
    • XR_FB_hand_tracking_capsules: Update XrHandCapsuleFB and
      XrHandTrackingCapsulesStateFB to use
      XR_HAND_TRACKING_CAPSULE_POINT_COUNT_FB and
      XR_HAND_TRACKING_CAPSULE_COUNT_FB enums when defining arrays so they match
      the usual practice for vendor extensions
      (internal MR 2216)
    • XR_FB_passthrough_keyboard_hands: Add
      XR_PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_MASKED_HANDS_FB, update spec
      version to 2.
      (internal MR 2270)
    • XR_FB_passthrough: add XrPassthroughBrightnessContrastSaturationFB, update
      spec version to 2
      (internal MR 2222)
    • XR_FB_render_model: Add capability support levels, bump spec version to 2.
      (internal MR 2264)
    • XR_FB_space_warp: Add
      XR_COMPOSITION_LAYER_SPACE_WARP_INFO_FRAME_SKIP_BIT_FB into
      XrCompositionLayerSpaceWarpInfoFlagBitsFB, update spec version to 2.
      (internal MR 2193)
    • XR_HTC_vive_focus3_controller_interaction: Support component path
      "/input/squeeze/value", update spec version to 2.
      (internal MR 2253)
    • XR_KHR_D3D11_enable and XR_KHR_D3D12_enable: Update to describe error
      conditions for XR_ERROR_GRAPHICS_DEVICE_INVALID.
      (internal MR 2176,
      internal issue 1617)
    • XR_MSFT_spatial_graph_bridge: Update to revision 2.
      (internal MR 2182)
  • Specification
    • Add spec language for XR_MIN_COMPOSITION_LAYERS_SUPPORTED.
      (internal MR 2201,
      internal issue 1652,
      OpenXR-Docs issue 117)
    • Add a few level 4 headers so the sub chapters in extensions can be referenced
      with anchors.
      (internal MR 2205)
    • Add text in the appendix describing adding
      org.khronos.openxr.intent.category.IMMERSIVE_HMD category to intent-filter
      for AndroidManifest.xml, to indicate an immersive application.
      (internal MR 2219)
    • Change instances of Samsung Electronics authorship references to only have
      first and last name of author, and to spell out Samsung Electronics instead of
      just Samsung.
      (internal MR 2211)
    • Clarify that XR_SPACE_VELOCITY_LINEAR_VALID_BIT and
      XR_SPACE_VELOCITY_ANGULAR_VALID_BIT work just like
      XR_SPACE_LOCATION_POSITION_VALID_BIT and
      XR_SPACE_LOCATION_ORIENTATION_VALID_BIT: Don't read the corresponding field
      if it's not set.
      (internal MR 2185,
      OpenXR-Docs issue 35,
      internal issue 1264)
    • Document new XR_HTC_hand_interaction extension.
      (internal MR 2254)
    • Document new XR_ULTRALEAP_hand_tracking_forearm vendor extension.
      (internal MR 2154)
    • Document new XR_EXT_dpad_binding multi-vendor extension.
      (internal MR 2159)
    • Document new XR_FB_spatial_entity vendor extension.
      (internal MR 2194)
    • Document new XR_FB_spatial_entity_storage vendor extension.
      (internal MR 2194)
    • Document new XR_FB_spatial_entity_query vendor extension.
      (internal MR 2194)
    • Document out of range XrSwapchainSubImage imageArrayIndex
      (internal MR 2220)
    • Document new XR_FB_composition_layer_settings vendor extension.
      (internal MR 2221)
    • Document new XR_FB_spatial_entity_container vendor extension.
      (internal MR 2236)
    • Document new XR_HTC_vive_wrist_tracker_interaction vendor extension.
      (internal MR 2252)
    • Document new XR_VARJO_view_offset vendor extension.
      (internal MR 2255)
    • Document new XR_META_performance_metrics vendor extension.
      ([internal MR 2256](https://gitl...
Read more

OpenXR Specification (Source) 1.0.22

12 Jan 23:04
release-1.0.22
Compare
Choose a tag to compare

OpenXR Specification 1.0.22 (2022-01-12)

This release features a number of new vendor and multi-vendor extensions, plus a
few extension corrections. There are a few small core specification fixes as
well, including a clarification that going forward, xrBeginFrame is not a
blocking function (which was implied but not explicitly stated).

  • Registry
  • Specification
    • Clarify that xrBeginFrame is not a blocking function for frame
      synchronization purposes.
      (internal MR 2145)
    • Correct winding order for XR_MSFT_hand_tracking_mesh extension to clockwise
      to match runtime behavior.
      (internal MR 2151)
    • Document new XR_FB_render_model vendor extension.
      (internal MR 2117,
      internal MR 2169)
    • Document new XR_HTC_facial_tracker vendor extension.
      (internal MR 2120)
    • Document new XR_FB_keyboard_tracking vendor extension.
      (internal MR 2128)
    • Document new XR_EXT_uuid multi-vendor extension.
      (internal MR 2152)
    • Document new XR_FB_passthrough_keyboard_hands vendor extension.
      (internal MR 2162)
    • Document new XR_HTC_vive_focus3_controller_interaction vendor extension.
      (internal MR 2178)
    • Document new XR_ALMALENCE_digital_lens_control vendor extension.
      (OpenXR-Docs PR 104,
      internal issue 1615)
    • Fix typos/naming convention errors in XR_FB_hand_tracking_capsules: rename
      XR_FB_HAND_TRACKING_CAPSULE_POINT_COUNT to
      XR_HAND_TRACKING_CAPSULE_POINT_COUNT_FB and
      XR_FB_HAND_TRACKING_CAPSULE_COUNT to XR_HAND_TRACKING_CAPSULE_COUNT_FB,
      providing the old names as compatibility aliases.
      (internal MR 1547,
      internal issue 1519)
    • Semantic paths: Note that "back" (as a button) is an acceptable standard
      identifier: the core specification already includes interaction profiles using
      it, but it was inadvertently omitted from the standard identifier list.
      (internal MR 2166)
    • Update xml consistency script to verify correct application of vendor naming
      rules.
      (internal MR 1547,
      internal issue 1618)
    • Update docs for XR_TYPE_EVENT_DATA_INSTANCE_LOSS_PENDING to specify that
      xrCreateInstance returns XR_ERROR_RUNTIME_UNAVAILABLE as long as it is
      unable to create the instance.
      (internal MR 2149)
    • Update docs for XR_FB_color_space to correct preferred color space for Oculus
      HMDs.
      (internal MR 2155)

This release replaces 1.0.21.

OpenXR Specification (Source) 1.0.21

12 Jan 20:04
release-1.0.21
Compare
Choose a tag to compare
Pre-release

This release was withdrawn due to a typo noticed after initial publication.
All changes are now listed under 1.0.22.

OpenXR Specification (Source) 1.0.20

04 Oct 22:31
release-1.0.20
Compare
Choose a tag to compare

OpenXR Specification 1.0.20 (2021-10-04)

This release includes a number of new vendor extensions and a few minor clarifications.

OpenXR Specification (Source) 1.0.19

24 Aug 17:08
release-1.0.19
Compare
Choose a tag to compare

OpenXR Specification 1.0.19 (2021-08-24)

This release features a number of new or updated vendor extensions, as well as
some minor spec clarifications.

OpenXR Specification (Source) 1.0.18

02 Aug 14:47
release-1.0.18
Compare
Choose a tag to compare

OpenXR Specification 1.0.18 (2021-07-30)

The main changes in this release include clarifications to the Session chapter
of the specification, plus the addition of diagrams to the text describing grip
and aim pose. The release also adds one new ratified KHR extension (promoted
from a vendor extension), and a number of new vendor extensions.