Changelog

All notable changes to this package will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[1.11.1-exp.1] - 2024-06-12

Fixed

Fixed Metal API initialization.

[1.11.0] - 2024-05-01

Added

Added the XrPerformanceSettings.SetPerformanceLevelHint static method, which lets you send performance level suggestions to the runtime. These hints help an OpenXR runtime to optimize the use of hardware resources according to the application needs. Refer to XR performance settings for more information. This requires the XR_EXT_performance_settings extension is enabled in the OpenXR runtime.
Added the XrPerformanceSettings.OnXrPerformanceChangeNotification event, which provides notifications from the OpenXR runtime when a device's thermal, rendering, or compositor performance state changes. The performance states include: Normal, Warning, and Impaired. Refer to XR performance settings for more information. This requires the XR_EXT_performance_settings extension is enabled in the OpenXR runtime.
Added aQuest 3 option to the Target Devices set in the Meta Quest Support settings. This specifies the application's support for Quest 3 devices within the Android manifest.
Added missing ButtonControl actions pinch_ext, aim_activate_ext and grasp_ext for Hand Interaction Profile.
Added API OpenXRUtility.ComputePoseToWorldSpace to recalculate object position and rotation from tracking-space to world-space. Applicable for use cases such as teleporting.
Added support for using Local Floor Reference Space in the OpenXR runtime. Useful in applications that require the user to be seated or in a standing fixed position.
Added PreInit flags to allow users to disable the main frame buffer and use offscreen swapchain when using Vulkan on Android in the OpenXR settings.
Added functional DX12 mock runtime support to the OpenXR package.
Added RegisterStatsDescriptor method to the OpenXRFeature abstract class, which lets your OpenXR feature to register a new statistic that can be feed into and queried at runtime. This method is not thread safe.
Added SetStatAsFloat method to the OpenXRFeature abstract class, which lets your OpenXR feature to feed a float value into a specific statistic that was previously registered using the RegisterStatsDescriptor. This method is thread safe.
Added SetStatAsUInt method to the OpenXRFeature abstract class, which lets your OpenXR feature to feed an unsigned integer value into a specific statistic that was previously registered using the RegisterStatsDescriptor. This method is thread safe.
Added the OpenXRSettings.RefreshRecenterSpace static method, which lets you regenerate the internal XR space used for recentering, without the need to wait until a recenter event is received by the OpenXR SDK. Note that this method does not perform a recenter event in any way, as this can only be done by the device runtime.
Added Pre-pass Foveated Rendering for both d3d12 and Vulkan. This feature utilizes Fragment Density Mapping on Quest Devices and Fragment Shading Rate on PC to optimize rendering performance. Refer to Foveated Rendering for more information.
Added OpenXRUtility.IsSessionFocused to return if the current session is in the focused state.
Added OpenXRUtility.IsUserPresent to return the change of user presence, such as when the user has taken off or put on an XR headset. If the system does not support user presence sensing, runtime assumes that the user is always present and IsUserPresent always returns True. If the system supports the sensing of user presence, returns true when detected the presence of a user and returns false when detected the absence of a user.

Changed

Changed tracking origin to use Local Floor in place of Floor by default.
Changed delta time calculation to utilize OpenXR for frame estimation. Previously internal Unity mechanisms were used. This feature is currently disabled but will be available in the future.
When retrieving input feature from CommonUsages.userPresence, if XR_EXT_user_presence is supported by the current system, retrieved value will be the same as OpenXRUtility.IsUserPresent. If XR_EXT_user_presence is not supported, retrieved value will be based on OpenXRUtility.IsSessionFocused, which is the default return value before 1.11.0.

Fixed

Fixed Marshal to correctly read the number of bytes for booleans in C++.
Fixed crash that occurs while cleaning up destroyed swapchains in OpenXR.
Fixed Depth Texture flag disparity between the OpenXR and Oculus providers.

Added

Added OpenXRUtility.IsSessionFocused to return if the current session is in the focused state.
Added OpenXRUtility.IsUserPresent to return the change of user presence, such as when the user has taken off or put on an XR headset. If the system does not support user presence sensing, runtime assumes that the user is always present and IsUserPresent always returns True. If the system supports the sensing of user presence, returns true when detected the presence of a user and returns false when detected the absence of a user.

Changed

When retrieving input feature from CommonUsages.userPresence, if XR_EXT_user_presence is supported by the current system, retrieved value will be the same as OpenXRUtility.IsUserPresent. If XR_EXT_user_presence is not supported, retrieved value will be based on OpenXRUtility.IsSessionFocused, which is the default return value before 1.11.0.

[1.10.0] - 2024-01-26

Added

Added OpenXRSettings.VulkanAdditionalGraphicsQueue property to request at startup an additional Vulkan graphics queue in devices that require it. The setting can be enabled through the Project settings UI and build code.
Added Optimize Buffer Discards (Vulkan) feature setting option within MetaQuestFeature.
Added a new optional validation rule to switch to use InputSystem.Controls.StickControl instead of Vector2Control for thumbsticks. StickControl allows more input options for thumbstick-based control, such as acting as both a combined 2D vector, two independent axes or a four-way Dpad with 4 independent buttons.

Changed

Updated project validation rule for Meta Quest Feature - "Select Oculus Touch Interaction Profile or Meta Quest Pro Touch Interaction Profile to pair with." from error to warning to allow other interaction profiles to be enabled as well, like eye gaze or palm pose.

Fixed

Fixed Meta XR Space Warp feature crashing issue when trying to access the depth swapchain.
Fixed Meta XR Space Warp depth subimage imageArrayIndex setup wrong issue for multiview render mode.
Fixed a bug where Palm Pose won't work if the Eye Gaze Interaction Profile is added to the project.
Fixed "The type 'AnalyticsResult' is defined in an assembly that is not referenced" error thrown.
Fixed UnitySwapchain destructor to completely destroy swapchains to avoid memory leak.
Fixed OpenXR Settings UI to not render settings on platforms that aren't supported.
Fixed Android manifest entries were added when the feature was not enabled.

[1.9.1] - 2023-10-19

Added

Implemented InputSystem.customBindingPathValidators interface to show UI warnings in the InputAsset Editor when added bindings to a disabled interaction profile and when none of the controller type interaction profiles are enabled, but added bindings using generic XRController.
Added APIs GetInteractionProfileType and GetDeviceLayoutName to support binding path validator feature.
Added API TrySetControllerLateLatchAction to support controller late latching. Also added MarkLateLatchNode.cs in Controller Sample for usages example.
Added support for Meta XR feature Symmetric Projection, Space Warp, and Eye Tracked Foveation.
Added the option to enable Subsampled Layout when creating a Vulkan swapchain.
Added support for recentering Floor tracking origin using new API, OpenXRSettings.SetAllowRecentering. This static method allows the app to recenter the tracking origin space when requested by the runtime. Note that calling the method won't trigger a recenter event.
Added support for Meta XR feature System Splash Screen.
Added public API for MetaQuestFeature.forceRemoveInternetPermission

Changed

Updated Input System package dependency to 1.6.3.
Updated XR management dependency to 4.4.0.
Updated OpenXR loader to 1.0.29.
Changed MockRuntime and its FeatureSet to public.

Fixed

Fixed incorrect XR Validation rules after regenerating the OpenXR package settings asset.
Fixed analytics code being called when disabled.
Fixed latency issue with controller poses.
Fixed an XR_ERROR_SESSION_NOT_RUNNING error if xrRequestExitSession is called when the session is not running.

[1.8.2] - 2023-07-18

Added

Added a new optional validation rule to recommend disabling Screen Space Ambient Occlusion render feature in UniversalRenderer assets to avoid significant performance overhead.

Changed

Removed Windows Mixed Reality feature group from Windows build target.

Fixed

Fixed issue that UWP player tries to initialize XR when "Initialize XR on Startup" is unchecked.
Fixed SetOutput Failed. and SetInput Failed. log spamming issue when audio sources is not available.
Fixed performance drop after headset becomes inactive.
Fixed Hand Common Poses Interaction Profile and Palm Pose feature documentation links broken.
Fixed Mock Runtime option toggles on accidentally after entering Play Mode.
Fixed hand tracking position and rotation not being tracked with XR Hand device.

[1.8.1] - 2023-06-09

Added

Added functionality in OpenXRFeatureBuildHooks exposing the BootConfig for reading/writing.
Added Force Remove Internet Permission setting to the Meta Quest Feature settings, allowing to remove Internet permissions added automatically to the application manifest.
Added class HPReverbG2ControllerProfile.ReverbG2Controller and a new interaction profile to support the HP Reverb G2 controllers.
Added Hand Interaction Profile and added PalmPose and dpad EXT implementations.

Changed

Modified ModifyAndroidManifestMeta class to provide required Android manifest entries using a new internal XR system, instead of manually modifying the manifest file.
Updated the IsTracked and TrackingState Input Features names with a Usage prefix to prevent name collisions.
Updated OpenXR loader to 1.0.27.

Fixed

Fixed type XrCompositionLayerPassthroughFB not appearing in the runtime debugger.
Fixed crash when deploying to Android on Unity 2023 due to using type Activity over GameActivity.
Fixed issue on Android where screen captures only capture the view on one eye.

[1.7.0] - 2023-02-21

Added

Added API OpenXRRuntime.retryInitializationOnFormFactorErrors to retry xrGetSystem during initialization if xrGetSystem returns a form factor error.
Enable XR_META_performance_metrics. This enables performance stats for Meta Quest devices on OpenXR.
Add class MetaQuestTouchProControllerProfile.QuestProTouchController new interaction profile to support Meta Quest pro controllers.
Added ability for OpenXRFeature derived classes to add Awake() functions.
Added API OpenXRInput.GetActionIsActive to check whether an InputAction has any bindings which are currently active.
Added API OpenXRInput.GetActionHandle to get the action handle of an InputAction and returns 0 if not found.

Changed

Updated documentation for the Meta Quest feature.

Fixed

Fixed - Meta builds now don't include Bluetooth permissions in Android manifest by default when using Microphone class in script code.
Fixed crash in OpenXR runtime debugger when cache size is set to 0.
Fixed OpenXR project validation to check for correct versions of OpenGLES in Unity 2023 and up.
Fixed crash when runtime reports an invalid view configuration from xrWaitFrame.
Fixed - OpenXR plugin will only look up functions from supported and enabled extensions.
Fixed GPU selection in multi-GPU scenarios.

[1.6.0] - 2022-11-29

Added

Added Meta Quest Feature support for Android and deprecated previous Oculus Quest Feature. Also added a new validation rule to support new Meta Quest Feature migration.
Added API MetaQuestFeature.AddTargetDevice to add additional target devices to the devices list in the MetaQuestFeatureEditor.
Added Thumbrest Touch support in Oculus Touch Controller Interaction Profile.
Added a new optional validation rule to switch to use InputSystem.XR.PoseControl instead of OpenXR.Input.PoseControl, which fixed PoseControl conflicts in InputSystem.XR and OpenXR.Input. Note: If opt in to use InputSystem.XR.PoseControl, USE_INPUT_SYSTEM_POSE_CONTROL will be added in Scripting Define Symbols under Player settings.

Changed

Updated Input System dependency to 1.4.4.

Fixed

Fixed issue where game window would show as black in URP.
Fixed InputDevice.TryGetHapticCapabilities always returning True with OpenXR.
Fixed repeated "Failed to restart OpenXR" warnings when no HMD is attached.
Fixed invalid pose values getting populated when tracked flags are invalid.
Fixed XR_SPACE_BOUNDS_UNAVAILABLE return code marked as Error in the log.

[1.5.2] - 2022-09-08

Added

Added support for Android cross-vendor loader.

Changed

Updated Input System dependency to 1.4.2.

Fixed

Fixed XRInputSubsystem.TryGetBoundaryPoints returning inaccurate values. If you have guardian/boundary setup in the headset, TryGetBoundaryPoints will return a List of size 4 representing the four vertices of the Play Area rectangle, which is centered at the origin and edges corresponding to the X and Z axes of the provided space. Not all systems or spaces may support boundaries.
Fixed an issue that controllers position not getting updated and stuck to the floor level when Oculus Integration Asset installed in the project.
Fixed an issue that OpenXR libraries were included in build when OpenXR SDK is not enabled.
Improved domain reload performance by removing unnecessary checks when entering Playmode.

[1.5.1] - 2022-08-11

Added

Added generic Project Validation status in the Project Settings window under XR Plug-in Management if you have XR Core Utilities 2.1.0 or later installed. These results include the checks for all XR plug-ins that provide validation rules.
Added API OpenXRFeature.SetEnvironmentBlendMode to set the current XR Environment Blend Mode if it is supported by the active runtime. If not supported, fall back to the runtime preference.
Added API OpenXRFeature.GetEnvironmentBlendMode to return the current XR Environment Blend Mode.
Added support for XR_MSFT_holographic_windown_attachment extension on UWP so that installing Microsoft Mixed Reality OpenXR Plug-in is no longer required if targeting HoloLens V2 devices. And removed corresponding project validator.
Added support for XR_FB_foveation, XR_FB_foveation_configuration, XR_FB_swapchain_update_state, XR_FB_foveation_vulkan and XR_FB_space_warp extensions.
Added ability to recover the application after Oculus Link was aborted and re-established. Attempt to restart every 5 seconds after Link disconnected.
Added validation rule for duplicate settings in OpenXRPackageSettings.asset.

Changed

Updated Oculus Android manifest with focusAware, supportedDevices and headTracking tags added. Also added a new validation rule to check if Oculus target devices are selected.
Updated OpenXR Loader to 1.0.23.
Updated Input System dependency to 1.4.1.

Fixed

Fixed compilation errors on Game Core platforms where ENABLE_VR is not currently defined. Requires Input System 1.4.0 or newer.
Fixed an issue that was causing Oculus Android Vulkan builds rendering broken after sleep / awake HMD.
Fixed Oculus controllers tracking issues when both OpenXR package and Oculus package are installed in the project.
Fixed an issue in Play Mode OpenXR Runtime selection that Other option would be reverted to System Default after entering and exiting playmode.
Fixed a bug in XR_VARJO_quad_views support.

[1.4.2] - 2022-05-12

Fixed

Fixed unnecessary destroying session on pause and resume.

[1.4.1] - 2022-04-13

Added

Added runtime failures handling to completely shut down OpenXR when runtime error occurred.
Added support to dynamically discover runtimes by registry key.
Added logging for no MainCamera tag detected when depthSubmission mode enabled.
Added console error logging if entering playmode on unsupported platforms.
Added support to automatically open OpenXR project validator if any issues detected after package update.
Added API OpenXRFeature.GetViewConfigurationTypeForRenderPass, which returns viewConfigurationType for the given renderPass index.
Added pre-init support for UWP / WSA platform. Note: OpenXR got unchecked by upgrading to this version (only on UWP), but options chosen under Features remained as they were.

Changed

Updated OpenXR Loader to 1.0.20.
Updated Render Mode naming to Single Pass Instanced / Multiview for Android platform.
Updated Input System dependency to 1.3.0.
Updated XR mirror view to be based on the occlusion mesh line loop data obtained from xrGetVisibilityMaskKHR.

Fixed

Fixed an issue that would cause failure to load OpenXR loader when non-ascii characters in project path.
Fixed an editor crash issue when updating OpenXR package version and then enter Playmode.
Fixed EyeGaze functionality not working in the Controller sample.
Fixed Oculus MenuButton not being recognized in script.
Fixed an issue that some OpenXR Editor settings not being serialized properly.
Fixed Failed to suggest bindings for interaction profile console error spamming when a runtime doesn't support a certain interaction profile.

[1.3.1] - 2021-11-17

Changed

Updated documentation link to 1.3.
Updated Oculus Android manifest with intent-filter.

Fixed

Fixed an issue in OpenXRRestarter that would prevent a subsequent restart.
Fixed an issue in OpenXRRestarter that would cause a restart to fail depending on where it was initiated in the stack.
Fixed an issue in UWP that would prevent the main window from being rendered to when using remoting.
Fixed incorrect negative values on controller linear velocities.
Fixed a bug in HMD trackingState that would cause tracking state to flip back and forth between two states every frame.

[1.3.0] - 2021-10-20

Added

Added API OpenXRInput.SendHapticImpulse
Added API OpenXRInput.StopHaptics
Added API OpenXRInput.TryGetInputSourceName
Added event OpenXRRuntime.wantsToRestart
Added event OpenXRRuntime.wantsToQuit
Added support for XR_OCULUS_audio_device_guid extension.
Added Haptic control to OpenXR Controller Profile layouts that can be bound to an action and used to trigger haptics using the new OpenXRInput.SendHapticImpulse API.

Changed

Improved OpenXRFeatureSetManager.SetFeaturesFromEnabledFeatureSets so that no internal methods are required after calling this.
Updated Controller sample to improve the visuals and use the new APIs

Fixed

Fixed ARM32 crash when OpenXR API layers were present
- ISSUE-1355859
Fixed issue that would cause console errors if OpenXRFeature.enable was changed while the OpenXR Projects Settings windows was open.
Fixed potential Android crash when shutting down.
Fixed potential crash with XR_MSFT_SECONDARY_VIEW_CONFIGURATION_EXTENSION_NAME
Fixed issue with alpha channel on Projection layer causing visual artifacts.
Fixed bug that caused Vulkan support on Oculus to stop working.
Fixed missing usages on HoloLensHand layout.
Fixed vulkan shared depth buffer on versions 2021.2.0b15 and 2022.1.0a8 or higher.

[1.2.8] - 2021-07-29

Fixed

Fixed an issue that was causing Oculus Android OpenGL builds to stop working after v31 of the oculus software was installed.
Fixed a bug that would cause Asset Bundles to fail building in some circumstances when OpenXR was included in the project.
Fixed a crash that would occur if XR was shut down from within a Feature callback.
Fixed a bug that was causing duplicate entries in the OpenXR Package Settings file.
Fixed a bug causing angular velocities on both the HMD and controllers to have the wrong sign when compared to the other Unity XR plugins

[1.2.3] - 2021-06-17

Added

Ensured a deterministic order of features within the OpenXR Settings

Changed

Updated OpenXR Loader to 1.0.17
Changed feature set text to feature group in the top level XR-Management list

Fixed

Fixed missing haptic output on HTC Vive controller profile
Fixed bug that caused ThumbstickTouched binding on the ValveIndex controller profile to not work.
Fixed issue that would cause the app to not exit when closed by the runtime

[1.2.2] - 2021-06-01

Added

Editor runtime override will no longer change the runtime for standalone builds executed using Build and Run.

Changed

Renamed Feature Sets to Feature Groups in the UI.

Removed

Removed unnecessary build hook for EyeGaze that was causing incorrect capabilities to be set on HoloLens2.

Fixed

Fixed a bug when using SteamVR runtime that would cause the view to stop rendering and input to stop tracking if the main thread stalled for too long.
Fixed bug with feature sets that could cause the XR Management check box to be out of sync with the checkbox on the OpenXR Settings page.
Fixed bug with HTC Vive controller profile that caused the aim and grip poses to be identical.

[1.2.0] - 2021-05-06

Added

Enabled Android build target for Oculus Quest via the Oculus Quest Support feature.
OpenXR Settings UI reworked to make managing features and interaction profiles easier.
Added menu item to open Project Validation window (Window > XR > OpenXR > Project Validation).
Project validation window now supports manual fixes for an issue.
Project validation window now supports optional help links for an issue.
Added OpenXRFeature.OnEnableChanged method to give features a chance to handle their enabled state changing.
Added IPackageSettings.GetFeatures method that returns all features of a given type from all build targets.

Removed

Removed experimental text from OpenXR plugin help icon.
Removed Linear color space restriction for all build targets and graphics apis except OpenGLES.

Fixed

Fixed bug with haptics that caused XRControllerWithRumble.SendImpulse to not work with OpenXR.
Fixed bug that could cause some interaction profile device layouts to not be registered on startup.

[1.1.1] - 2021-04-06

Added

Oculus controller profile now exposes both grip and aim poses.
Added support for XR_VARJO_QUAD_VIEWS extension
Added XR_COMPOSITION_LAYER_UNPREMULTIPLIED_ALPHA_BIT and XR_COMPOSITION_LAYER_BLEND_TEXTURE_SOURCE_ALPHA_BIT bits to the composition layer flags
Added XrSecondaryViewConfigurationSwapchainCreateInfoMSFT to to XrSwapchainCreateInfo when using a secondary view
MockRuntime First Person Observer View support
MockRuntime input support
MockRuntime vulkan_enable2 support
MockRuntime d3d11_enable support

Changed

OpenXRSettings.renderMode and OpenXrSettings.depthSubmissionMode can now be changed via script outside of play mode.

Fixed

Fixed issue where OpenXR layouts were not visible in the InputSystem bindings dialog.
Fix for managed stripping levels of Medium and High
Fixed bugs in XR_KHR_VULKAN_ENABLE2 extension support

[1.0.2] - 2021-02-04

Fixed

Resolve further release verification issues.

[1.0.1] - 2021-02-03

Fixed

Resolve release verification issues.

[1.0.0] - 2021-01-27

Added

Runtime Debugger to allow for the inspection of OpenXR calls that occur while OpenXR is actively running.
XR Plug-In Management dependency update to 4.0.1
Input System dependency updated to 1.0.2

[0.1.2-preview.3] - 2021-01-19

Added

Implemented XR_KHR_loader_init and XR_KHR_loader_init_android.
Added support for XR_KHR_vulkan_enable2 alongside XR_KHR_vulkan_enable.

Changed

Updated dependency of com.unity.xr.management from 4.0.0-pre.2 to 4.0.0-pre.3.

[0.1.2-preview.2] - 2021-01-05

Fixed

Fix publishing pipeline.

[0.1.2-preview.1] - 2020-12-18

Changed

Minor documentation getting started tweaks.
Minor diagnostic logging tweaks.

Fixed

Fixed package errors when Analytics package is absent (case 1300418).
Fixed tracking origin issue which was causing wrong camera height (case 1300457).
Fixed issue where large portions of the world were incorrectly culled at certain camera orientations.
Fixed potential error message when clicking Fix All in OpenXR Project Validation window.
Fixed an issue with sample importing.