Releases: KhronosGroup/OpenXR-Docs
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
: 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.
- 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
andXrRect2Di
.
(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 usingreflink:
(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)
- Add note about missing vendor suffix on interaction profile paths to all
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)
- Add missing enum tags for enum-sized array struct members.
- 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
parametersmessageId
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)
- Clarify how prior frame state is reset when a session starts running.
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
(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
- Specification
- Change
PFNEGLGETPROCADDRESSPROC
(foreglGetProcAddress
) 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)
- Change
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
: 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
- Specification
- Added normative language clarifying that
XrViewConfigurationType
usage must
be 'activated' byxrBeginSession
(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 ofXrCompositionLayerFlags
for a more usable ref page
experience.
(internal MR 2813) - Fix markup of a
subpathname:
which was marked as apathname:
.
(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 thexrTryCreateSpatialGraphStaticNodeBindingMSFT
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 forXrRoomLayoutFB
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
byxrGetSpaceBoundingBox2DFB
andxrGetSpaceBoundingBox3DFB
.
(internal MR 2714)XR_FB_scene
: Clarify the behavior ofxrGetSpaceRoomLayoutFB
during the
first call of the two-call idiom when the user retrieves the required buffer
length.
(internal MR 2715)XR_FB_scene
...
- Added normative language clarifying that
OpenXR Specification (Source) 1.0.27
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.
- 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
- Specification
- Add missing "IP Status" data to
XR_FB_display_refresh_rate
.
(internal MR 2439) - Added the function call for
xrPollEvent
to the typical XR app sample.
(internal MR 2605) - Clarify that passing
0
forelementCapacityInput
in two-call idiom functions
is explicitly valid usage, but there may be other reasons that an error is
returned.
(internal MR 2492) - Clarify that system vendor ids match USB vendor ids.
(internal MR 2634) - Clean up markup of various two-call idiom mentions in the core.
(internal MR 2619) - Fix use of normatives in paragraph introducing the concept of extensions.
(internal MR 2466) - Fix a language error in
xrDestroySpace
description language: it destroys a
space, not creates one.
(internal MR 2516) - Fix broken internal links in
XR_FB_triangle_mesh
specification.
(internal MR 2593) - Fix typo in description of function pointer naming in Appendix.
(internal MR 2599) - Fix typos in Fundamentals chapter
(internal MR 2608) - Fixed sample code which was missing specifying the view configuration type to
locate withxrLocateViews
([internal MR 2624](https://gitlab.khronos.org/openxr/openxr/merge_requests...
- Add missing "IP Status" data to
OpenXR Specification (Source) 1.0.26
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
- Add a warning to
XR_COMPOSITION_LAYER_CORRECT_CHROMATIC_ABERRATION_BIT
saying
that it is not in use and planned for deprecation
(internal MR 2378,
internal issue 1751) - Add new
XR_EXT_active_action_set_priority
vendor extension.
(internal MR 2288,
internal issue 1699) - Add new
XR_HTC_passthrough
vendor extension.
(internal MR 2349) - Add new
XR_HTC_foveation
vendor extension.
(internal MR 2377) - Add new
XR_META_headset_id
vendor extension.
(internal MR 2410) - Improve Schematron rules for the registry XML and update the tool version used.
(internal MR 2418,
internal MR 2426,
internal MR 2457,
internal MR 2460,
internal MR 2465) - Register author ID and reserve vendor extensions for ByteDance.
(internal MR 2482,
OpenXR-Docs PR 137) - Register author ID for danwillm and reserve vendor extensions.
(OpenXR-Docs PR 138) - Reserve vendor extensions for Microsoft.
(internal MR 2478) XR_EXTX_overlay
: Fix XML markup to correct generated valid usage for the
event structure.
(internal MR 2307)XR_EXT_performance_settings
: Fix XML markup to correct generated valid usage,
bump revision.
(internal MR 2306)XR_HTCX_vive_tracker_interaction
: Fix XML markup to correct generated valid
usage for the event structure.
(internal MR 2310)XR_HTC_facial_tracking
: Update vendor extension to version 2.
(internal MR 2416)- specification/scripts: Added new functionality in codegen scripts to support
creating single extension headers. Usage:python3 scripts/genxr.py -registry registry/xr.xml -standaloneExtension XR_FB_color_space standalone_header
(internal MR 2417)
- Add a warning to
- 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 toXrSwapchainCreateFlags
, and mark up normative language.
(internal MR 2435) - Move flag bit documentation to the
FlagBit
type ref pages, and move the
typedefs for theFlags
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 fortype
,next
,
andcreateFlags
inXrVulkanInstanceCreateInfoKHR
(internal MR 2435)
- Clarify the valid swapchain face count values for layer types.
OpenXR Specification (Source) 1.0.25
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
: MarkXrSystemColorSpacePropertiesFB
as "returned-only"
for consistency and to correct the implicit valid usage.
(internal MR 2304)XR_FB_display_refresh_rate
: MarkXrEventDataDisplayRefreshRateChangedFB
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
: AddXrSystemPassthroughProperties2FB
and
XR_PASSTHROUGH_LAYER_DEPTH_BIT_FB
, update spec version to 3.
(internal MR 2333)XR_FB_render_model
: MarkXrRenderModelCapabilitiesRequestFB
as "returned-
only" for consistency and to correct the implicit valid usage.
(internal MR 2309)
- Add new
- 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
: MarkXrSystemColorSpacePropertiesFB
as "returned-only"
for consistency and to correct the implicit valid usage, bumping the revision
number.
(internal MR 2304)XR_FB_hand_tracking_mesh
: FixXrHandTrackingMeshFB
two-call-idiom implicit
valid usage, and increment the revision.
(internal MR 2311)XR_FB_passthrough
: AddXrSystemPassthroughProperties2FB
and
XR_PASSTHROUGH_LAYER_DEPTH_BIT_FB
.
(internal MR 2333,
internal MR 2393)XR_FB_render_model
: MarkXrRenderModelCapabilitiesRequestFB
, 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 whenxrDeserializeSceneMSFT
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)
- Clarify that orientation behaves the same as position when tracking loss occurs
OpenXR Specification (Source) 1.0.24
OpenXR Specification 1.0.24 (2022-06-23)
- Registry
- Add new
XR_EXT_palm_pose
multi-vendor extension.
(internal MR 2112) - Add new
XR_FB_scene
vendor extension.
(internal MR 2237) - Fix structure definition in
XR_FB_spatial_entity_container
.
(internal MR 2278) - scripts: Teach xr_conventions that 2D, 3D, etc. are words for the purposes of
structure type enum generation.
(internal MR 2237)
- Add new
- Specification
- Clarify inconsistent specified semantics for array getters/two-call idiom,
resolving ambiguity in favor of the fundamentals section on buffer size
parameters.
(OpenXR-Docs PR 104,
OpenXR-Docs issue 94,
internal issue 1599,
internal issue 1612) - Document new
XR_EXT_palm_pose
multi-vendor extension.
(internal MR 2112) - Document new
XR_FB_scene
vendor extension.
(internal MR 2237) - Fix documentation for
xrApplyHapticFeedback
to specify the correct action
type.
(internal MR 2268) - Fix structure definition in
XR_FB_spatial_entity_container
.
(internal MR 2278)
- Clarify inconsistent specified semantics for array getters/two-call idiom,
OpenXR Specification (Source) 1.0.23
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
andxrEndFrame
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 toXR_UUID_SIZE_EXT
to ensure it is defined
beforeXrUuidEXT
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 correctnext
chain
usage.
(internal MR 2229)XR_FB_hand_tracking_capsules
: UpdateXrHandCapsuleFB
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
: addXrPassthroughBrightnessContrastSaturationFB
, 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
andXR_KHR_D3D12_enable
: Update to describe error
conditions forXR_ERROR_GRAPHICS_DEVICE_INVALID
.
(internal MR 2176,
internal issue 1617)XR_MSFT_spatial_graph_bridge
: Update to revision 2.
(internal MR 2182)
- Add new
- 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
forAndroidManifest.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...
- Add spec language for
OpenXR Specification (Source) 1.0.22
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
- Add new
XR_FB_render_model
vendor extension.
(internal MR 2117,
internal MR 2169) - Add new
XR_HTC_facial_expression
vendor extension.
(internal MR 2120) - Add new
XR_FB_keyboard_tracking
vendor extension.
(internal MR 2128) - Add new
XR_EXT_uuid
multi-vendor extension.
(internal MR 2152) - Add new
XR_FB_passthrough_keyboard_hands
vendor extension.
(internal MR 2162) - Add new
XR_HTC_vive_focus3_controller_interaction
vendor extension.
(internal MR 2178) - Add new
XR_ALMALENCE_digital_lens_control
vendor extension.
(OpenXR-Docs PR 104,
internal issue 1615) - Correct winding order for
XR_MSFT_hand_tracking_mesh
extension to clockwise
to match runtime behavior.
(internal MR 2151) - 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
toXR_HAND_TRACKING_CAPSULE_COUNT_FB
,
providing the old names as compatibility aliases.
(internal MR 1547,
internal issue 1519) - Reserve vendor extensions 208 - 299 for Facebook.
(internal MR 2158) - Reserve extension numbers for anticipated multi-vendor extensions.
(internal MR 2173)
- Add new
- 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
toXR_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
returnsXR_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)
- Clarify that
This release replaces 1.0.21.