OpenXR Specification (Source) 1.1.38

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

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.

• Registry
  • Addition: New XR_API_VERSION_1_0 and XR_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)
• Specification
  • Addition: Document new XR_API_VERSION_1_0 and XR_API_VERSION_1_1
    macros/defines.
    (internal MR 3354,
    internal issue 2254)
  • Fix: Typo in "Buffer Size Parameters" section.
    (internal MR 3322)
  • Fix: Resolve several diagrams shown cropped in browsers.
    (internal MR 3355)
  • Fix: Correct formatting of versions in some generated spec text.
    (internal MR 3362)
  • Fix: Adjust specification release build process to restore internal links in
    PDF.
    (internal MR 3371,
    OpenXR-Docs issue 170)
  • Improvement: Resize and optimize images to reduce spec page size.
    (internal MR 2833,
    internal MR 3355)
  • Improvement: Add in missing explicit section anchors.
    (internal MR 3322)
  • Improvement: Fix references to Docker container in spec build instructions.
    (internal MR 3352,
    internal issue 2283,
    OpenXR-SDK-Source issue 476)
  • Improvement: Inline several SVG diagrams to support searchable and screen-
    reader-accessible text.
    (internal MR 3355)
  • Improvement: General script cleanups and improvements.
    (internal MR 3362)
  • Update: Bump version of XR_FB_composition_layer_alpha_blend due to spec text
    clarification.
    (internal MR 3317)

OpenXR Specification (Source) 1.1.36

OpenXR Specification 1.1.36 (2024-04-15)

This is a substantial update to the OpenXR specification.

• Major Update
  • New ratified core OpenXR 1.1 specification.
    (internal MR 3053,
    internal MR 3046,
    internal MR 3187,
    internal MR 3199)
  • New ratified Khronos extension specification: XR_KHR_locate_spaces. Promoted
    to core OpenXR 1.1.
    (internal MR 2272,
    internal issue 1706,
    internal MR 3178,
    internal MR 3196,
    internal MR 3300)
  • New ratified Khronos extension specification: XR_KHR_maintenance1. Promoted
    to core OpenXR 1.1.
    (internal MR 3053,
    internal MR 3046,
    internal MR 3187,
    internal MR 3199)
  • Fundamentals chapter: Add assorted structures and values to core OpenXR 1.1.
    Some are versions of structures from existing extensions.
    (internal MR 3046,
    internal MR 3061)
  • Fundamentals chapter: Promote XR_EXT_uuid to core OpenXR 1.1.
    (internal MR 3046)
  • Fundamentals chapter: Rename "Common Object Types" section to "Common Data
    Types" and clarify its introduction.
    (internal MR 3062)
  • Fundamentals chapter: Clarify XrDuration (and related constant)
    specification.
    (internal MR 3062)
  • Fundamentals chapter: Clarify and expand the "buffer size" section about the
    two-call idiom.
    (internal MR 3062)
  • Fundamentals chapter: Improve documentation for convenience macros acting on
    XrResult, and clarify text about common return code name suffixes.
    (internal MR 3062)
  • Fundamentals chapter: Clarify and expand documentation of "offsets" and
    "extents".
    (internal MR 3062)
  • Fundamentals chapter: Clarify description of extension list.
    (internal MR 3062)
  • Fundamentals chapter: Miscellaneous minor cleanup, clarification, and normative
    language fixes.
    (internal MR 3062,
    internal MR 3062,
    internal MR 3210)
  • Fundamentals chapter: Clarify the section on events and event polling.
    (internal MR 3062,
    internal MR 3163,
    internal MR 3276)
  • Semantic Paths chapter: Promote the "grip_surface" pose identifier to core
    OpenXR 1.1, renamed from XR_EXT_palm_pose.
    (internal MR 3050,
    internal MR 3303)
  • Semantic Paths chapter: Promote many interaction profiles from extensions to
    core OpenXR 1.1.
    (internal MR 3051,
    internal MR 3127,
    internal MR 3265,
    internal MR 3279,
    internal MR 3294)
  • Semantic Paths chapter: Add several legacy interaction profiles to represent
    specific controllers shipped under the Oculus/Meta Touch name and previously
    grouped into a single Oculus Touch interaction profile.
    (internal MR 3127,
    internal MR 3299)
  • Spaces chapter: Promote a refined version of XR_EXT_local_floor to core
    OpenXR 1.1.
    (internal MR 3048,
    internal MR 3074,
    internal MR 3134,
    internal MR 3155,
    internal MR 3156,
    internal MR 3157,
    internal MR 3171,
    internal MR 3172,
    internal MR 3175)
  • Spaces chapter: General improvements to the Spaces chapter.
    (internal MR 3169,
    internal MR 3189)
  • View Configurations chapter: Promote
    XR_VIEW_CONFIGURATION_TYPE_PRIMARY_STEREO_WITH_FOVEATED_INSET to core OpenXR
    1.1, renamed and refined from XR_VARJO_quad_views.
    (internal MR 3049,
    internal MR 3173)
  • Rendering chapter: Formally deprecate
    XR_COMPOSITION_LAYER_CORRECT_CHROMATIC_ABERRATION_BIT, previously noted to
    have no effect on any known runtimes and as planned for deprecation.
    (internal MR 3096)
  • Input chapter: Re-organize and clarify the Input chapter.
    (internal MR 3179,
    internal MR 3183,
    internal MR 3185,
    internal MR 3205,
    internal MR 3207)
  • Core Revisions chapter: Add new informative (non-normative) chapter detailing
    substantial core revisions, summarize changes in OpenXR 1.1 core, and
    differences between extensions and the functionality promoted to core.
    (internal MR 3199,
    internal MR 3280)
  • Appendix: Update Contributors section.
    (internal MR 3111)
  • Tooling: Update scripts for 1.1, handling extension promotion, and partially
    synchronize shared scripts with Vulkan.
    (internal MR 3056,
    internal MR 3139,
    internal MR 3188,
    internal MR 3190,
    internal MR 3219,
    internal MR 3226,
    internal MR 3262,
    internal MR 3263,
    internal MR 3260,
    internal MR 3266,
    internal MR 3295)
• Registry
  • New ratified OpenXR version: XR_VERSION_1_1 - OpenXR 1.1.
    (internal MR 3053)
  • 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 multi-vendor extension: XR_EXT_future
    (internal MR 2610)
  • New vendor extension: XR_META_environment_depth
    (internal MR 2771,
    internal MR 3271)
  • Update the XML schema to change how dependencies are described (replacing
    requiresCore and requires attributes of extension, and feature and
    extension attributes of require, with a new depends attri...

OpenXR Specification (Source) 1.0.34

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
  • 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 and XR_FB_spatial_entity: Drop XR_EXT_uuid dependency,
    they use the data structure but do not require any runtime support specific to
    XR_EXT_uuid
    (internal MR 2577)
• 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

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

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
  • 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 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)
• 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

OpenXR Specification (Source) 1.0.31

OpenXR Specification 1.0.31 (2023-10-18)

This release features two new vendor extensions, some XML revisions to other
vendor extensions, and a substantial amount of fixes to the prose of the core
specification and some extensions. All specially-formatted mentions of a
parameter or field name (that is, names marked up with the pname macro in the
AsciiDoctor source) are now being checked by a script to be sure they are known.
With the fixes in this release, nearly all such name mentions now either (1)
match the function or structure in whose description they are mentioned, or (2)
have been qualified with the function or structure to which they do belong.
Misspellings, missing fields/parameters, and extraneous parameters have been
fixed as well. (Some fixes of this type to vendor extensions are still pending
and will be in an upcoming patch release.) While this has changed the prose, it
has not resulted in substantive changes to the XML, and therefore the code
snippets in the specification as well as the header files remain accurate and
unaffected by these fixes.

• 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: Fix structextends attribute and remove returnedonly
    attribute of XrRenderModelCapabilitiesRequestFB, 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)
• Specification
  • Add note about missing vendor suffix on interaction profile paths to all
    extensions introducing interaction profiles that are missing the suffix. These
    would not meet current style guide requirements.
    (internal MR 2921,
    internal issue 2074)
  • Clarify semantics of XrRect2Df and XrRect2Di.
    (internal MR 2760)
  • Fix next chain wording on XrSystemProperties.
    (internal MR 2957)
  • Fix "checkSpecLinks" warnings about member and parameter references in the
    specification. This has changed the documentation of a number of structures and
    functions across the spec, although the C prototypes/definitions in the spec as
    well as the header file contents have stayed constant.
    (internal MR 2960,
    internal MR 2968,
    internal MR 2969,
    internal MR 3001)
  • New vendor extension specification: XR_MSFT_scene_marker
    (internal MR 2601)
  • New vendor extension specification: XR_ML_user_calibration
    (internal MR 2849)
  • Remove unused MathJax script from the HTML spec.
    (internal MR 2125)
  • Replace usages of contractions, and update checkMarkup to ensure they do not
    return.
    (internal MR 2971)
  • Update stylesheet for HTML spec to improve accessibility.
    (internal MR 2125)
  • scripts: Adjust to be able to handle generating "freeform" ref pages for
    Android permission names, linked using reflink:
    (internal MR 2947)
  • scripts: Small fixes and cleanups
    (internal MR 2998,
    internal MR 2894)
  • xml: Fixed a few errors in MSFT extensions discovered by Schematron checks.
    (internal MR 2892)

GitOrigin-RevId: 38114c3ba8eb46d6fafe1761ed08e263ce132237

OpenXR Specification (Source) 1.0.30

OpenXR Specification 1.0.30 (2023-09-20)

This release is primarily a quality improvement release, fixing a range of
issues in the registry and specification, 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)
• Specification
  • Clarify how prior frame state is reset when a session starts running.
    (internal MR 2759,
    internal issue 2029)
  • Clean up normative language in FB vendor extensions.
    (internal MR 2563)
  • Clean up normative language in the Rendering chapter.
    (internal MR 2801)
  • Fix formatting and markup errors in the loader design document.
    (internal MR 2866)
  • Fix generated broken links from valid usage in ref pages to the next chain
    fundamentals.
    (internal MR 2931,
    internal issue 1369)
  • Fix broken links and update URLs in specification, extension process, style
    guide, and loader doc.
    (internal MR 2935)
  • New vendor extension specification: XR_YVR_controller_interaction
    (internal MR 2841)
  • XR_BD_controller_interaction: Add support for G3 devices
    (internal MR 2872)
  • XR_EXT_debug_utils: Fix XML to reflect that
    XrDebugUtilsMessengerCallbackDataEXT parameters messageId and
    functionName are optional.
    (internal MR 2864)
  • scripts: Fix member name lookups in entity_db, enabling numerous spec
    warnings that had been hidden.
    (internal MR 2923)
  • Fix specification errors (core and extension) highlighted by fixed tooling.
    (internal MR 2923)

GitOrigin-RevId: f7a0c0f3691f0c7b0a239cb34e41d01042d5a02a

OpenXR Specification (Source) 1.0.29

OpenXR Specification 1.0.29 (2023-08-25)

This release contains several fixes to the specification, 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 (for eglGetProcAddress) 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)
• Specification
  • Change PFNEGLGETPROCADDRESSPROC (for eglGetProcAddress) to a locally
    defined type to avoid compiler errors.
    (internal MR 2468)
  • Fix specification text mentions of eyeVisibility field in Khronos composition
    layer extensions, to match the XML and headers.
    (internal MR 2878)
  • Improvement: Add note to OpenXR styleguide to discourage use of callback
    functions in OpenXR extensions.
    (internal MR 2734)
  • Loader spec: Clarify and deduplicate the loader specification's listing of
    android manifest search paths.
    (internal MR 2829,
    internal issue 2046)
  • Loader spec: Fix description of <queries> element contents: existing
    description would fail to install.
    (internal MR 2840,
    internal issue 2053)
  • Makefile: Remove obsolete cygwin support in spec building target, no longer
    needed and actually caused it to not work under MSYS2.
    (internal MR 2885)
  • New vendor extension specification: XR_META_passthrough_preferences
    (internal MR 2694)
  • Style guide: Document the XML schema of xr.xml
    (internal MR 2875)
  • XR_HTCX_vive_tracker_interaction: Added new role paths for wrists and ankles.
    (internal MR 2728)
  • XR_OPPO_controller_interaction: Fix formatting of path lists.
    (internal MR 2831,
    OpenXR-Docs issue 156,
    internal issue 2047)
  • scripts: Provide better feedback on interface struct erroneously having a
    values attribute.
    (internal MR 2856)
  • scripts: Update regex in xrconventions to allow words in type naming that
    succeed digits but start with a "D"
    (internal MR 2857)
  • scripts: Fix formatting of "basetype" (generally typedef) names to once again
    be monospace "code".
    (internal MR 2890,
    internal issue 2048)

OpenXR Specification (Source) 1.0.28

OpenXR Specification 1.0.28 (2023-07-10)

This release features a number of new extensions, including several multi-vendor
extensions, among other improvements and clarifications.

• 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: Introduce XrSemanticLabelsSupportInfoFB and bump spec version
    to 3.
    (internal MR 2682)
  • XR_FB_spatial_entity and XR_FB_scene: Add XR_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 the touch_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)
• Specification
  • Added normative language clarifying that XrViewConfigurationType usage must
    be 'activated' by xrBeginSession (or by extensions). This was previously
    described clearly but non-normatively.
    (internal MR 2700)
  • Clarify the behavior of functions which initiate an asynchronous request when
    the function fails immediately.
    (internal MR 2716)
  • Clarify that we do intend to capture most invalid usage with return codes,
    unlike Vulkan, which is where we borrowed some of this language from.
    (internal MR 2762)
  • Corrected the extension enum base to 10^9.
    (internal MR 2693,
    OpenXR-Docs issue 148,
    internal issue 1979)
  • Fix nesting level of "Valid Usage" sections and headings, which resulted in a
    re-numbering of sections between 2.7 and 3.
    (internal MR 2761,
    OpenXR-Docs issue 149,
    internal issue 1989)
  • Fix nesting level of some sections and headings in the Rendering chapter, which
    resulted in a re-numbering of sections between 10.4 and 11.
    (internal MR 2761,
    OpenXR-Docs issue 149,
    internal issue 1989)
  • Fix flags-type boilerplate to mention XrCompositionLayerFlagBits in the body
    of the ref page of XrCompositionLayerFlags for a more usable ref page
    experience.
    (internal MR 2813)
  • Fix markup of a subpathname: which was marked as a pathname:.
    (internal MR 2673)
  • Loader docs: Specify 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)
  • New multi-vendor extension specification: XR_EXT_hand_interaction
    (internal MR 2116)
  • New multi-vendor extension specification: XR_EXT_plane_detection
    (internal MR 2510,
    internal MR 2781,
    internal MR 2791)
  • New multi-vendor extension specification: XR_EXT_hand_tracking_data_source
    (internal MR 2568)
  • New vendor extension specification: XR_META_passthrough_color_lut
    (internal MR 2507)
  • New vendor extension specification: XR_META_virtual_keyboard
    (internal MR 2555)
  • New vendor extension specification: XR_OPPO_controller_interaction
    (OpenXR-Docs PR 146)
  • Refine the spec language for a few MSFT extensions, including a clarification
    for controller model's dependency to an active grip pose action, and a
    correction to the xrTryCreateSpatialGraphStaticNodeBindingMSFT function's
    behavior.
    (internal MR 2600)
  • Remove incorrect/unused exception in the structure type value format rule.
    (internal MR 2762)
  • XR_EXT_debug_utils: Remove erroneous member documentation.
    (internal MR 2763,
    OpenXR-Docs issue 151,
    internal issue 2015)
  • XR_EXT_debug_utils: Clarify requirement on ending label regions.
    (internal MR 2763,
    OpenXR-Docs issue 150,
    internal issue 2014)
  • XR_FB_scene: Introduce XrSemanticLabelsSupportInfoFB and bump spec version to
    3.
    (internal MR 2682)
  • XR_FB_scene: Fixed specification language for XrRoomLayoutFB and
    XrBoundary2DFB which incorrectly described the input capacity parameter as
    referring to the number of bytes when, in fact, it refers to the number of
    elements in the array.
    (internal MR 2713)
  • XR_FB_scene: Clarified the meaning of the 2D and 3D bounding boxes obtained
    by xrGetSpaceBoundingBox2DFB and xrGetSpaceBoundingBox3DFB.
    (internal MR 2714)
  • XR_FB_scene: Clarify the behavior of xrGetSpaceRoomLayoutFB during the
    first call of the two-call idiom when the user retrieves the required buffer
    length.
    (internal MR 2715)
  • XR_FB_scene ...