Oculus Utilities for Unity

1.28.0 | Published 2018-08-16
I have read and agree to the terms of the EULA, Terms of Use and Privacy Policy

Oculus Utilities for Unity 1.28.0

Please see Compatibility and Version Requirements for important known Unity issues and support information.

The Oculus Utilities for Unity package includes includes scripts, prefabs, and other resources to supplement Unity’s built-in support. The package includes an interface for controlling VR camera behavior, a first-person control prefab, a unified input API for controllers, advanced rendering features, object-grabbing and haptics scripts for Touch, debugging tools, and more.

New Features

  • Improved the manifest assist tool which manages VRC required attributes
  • Added support for obtaining the dominant hand the user has specified in device settings
  • Added support for re-centering the HMD when controller is re-centered
  • Added support for sorting OVROverlays according to their composition depth

Integration Changes

Updated the package to PC SDK 1.28.

Bug Fixes

  • N/A

Known Issues

  • Flickering or left/right eye mismatching can occur when you have an input attribute value pass through to a pixel shader directly on Mali GPUs such as those in Samsung phones (used in Gear VR HMDs). This is because the ARM driver specifically targets such "volatile" data and tries to optimize for it, inadvertently creating the issue. A workaround is to try to use a modified version of the original value in some way. For example, instead of passing input value a directly through to shader value b, set b = a + 0.0001; which will prevent the driver from treating b differently.
  • If you experience long UI stalls or poor performance with the Unity Editor when targeting Oculus Rift on Windows 10, please run Windows Update to ensure that you have the latest version of Windows 10.
  • Unity 5 5.6.3p2 - 5.6.4p1, Unity 2017.1 - 2017.1.2p1, 2017.2.0f3 - 2017.2.0p2:
    • The Unity engine uses projection matrix calculations that are at variance with the Oculus SDK, causing VR scenes to have the wrong parallax, which may cause discomfort.
  • All Unity versions with Oculus runtime 1.17+ and Windows 10 + Creators Update
    • This combination results in spurious WM_DEVICECHANGE reports in the Editor, even in non-VR projects. Many users will notice no impact, but users connected to certain USB devices may find the Editor becomes non-responsive and needs to be terminated from Task Manager. To mitigate, please update to the Beta runtime available on our Public Test channel. We are currently working with Unity and Microsoft on a permanent solution.
  • Cubemap VR compositor layers currently do not work in mobile applications, or in Rift applications using Unity versions earlier than 2017.1.
  • Adaptive Resolution currently works only with Unity 2017.1.0f2 and later, you might experience some slightly pixel shaking when resolution is changing, this is a known issue, we are working with Unity to resolve it.
  • Unity 5.6 and later: If you have updated your OVRPlugin version from Utilities, you may see a spurious error message when the Editor first launches saying “Multiple plugins with the same name 'ovrplugin'”. Please disregard.
  • Unity has a known issue such that parenting one VR camera to another will compound tracking twice. As a workaround, make them siblings in the GameObject hierarchy.
  • Guardian System API: ovr_SetBoundaryLookAndFeel currently does not take effect if the HMD is not worn when the call is made (e.g., on Start).
  • Rift
    • All Unity versions prior to 5.4.3p3 leak 5MB/s if you have a Canvas in your scene, enable Run In Background, and dismount the Rift. You can check OVRManager.hasVrFocus in an Update function to disable your Canvases while the HMD is dismounted.
    • Transparent VR Compositor Layers do not currently support multiple layers of occlusion.
    • The following versions of Unity require the Visual C++ Redistributable for Visual Studio 2015 or Rift builds will fail to run in VR, and the error “Security error. This plugin is invalid!” will be reported in output_log.txt:
      • 5.3.6p3-5.3.6p7
      • 5.4.0f1-5.4.2p1
      • 5.5.0b1-5.5.0b8
  • Mobile
    • When building a mobile app using one of the Unity versions listed below, you'll need to export a Gradle project and modify the SigningConfig in the build.gradle file to include v1SigningEnabled=true, v2SigningEnabled=false. The affected versions are:
      • all 2017.3 versions
      • all 2017.4 versions below 2017.4.2f1
      • all 2018.1 versions below 2018.1.0b12
      • and all 2018.2 a types
    • 5.4.6p2 and 2017.3: A Unity issue may cause mobile builds to fail with the error "Failed to Repackage Resources" due to the erroneous insertion of the keyword density into the Android manifest. Until this is fixed in the engine, as a workaround you can install Android Build Tools v.24 or later. Note that Build Tools v24 requires JDK 1.8 or later.
    • Mobile developers should not use Unity versions 5.3.6p1-2 and 5.4.0p1-2 due to incorrect positional movement of the head.
    • Unity 5.3.4-5.3.6p3 and Unity 5.4.0b16-Unity 5.4.0p3: Do not set DSP Buffer Size to Best in Audio Manager in the Inspector for now or you will encounter audio distortion. Set it to Good or Default instead.
    • Gear VR applications built with Unity 5.6.0f2 crash immediately upon launch, and Gear VR applications built with 5.6.0p1 may crash when Multi-View is enabled.
    • A known bug in Unity causes a deterioration of performance in mobile applications when the back button is used to enter the Universal Menu, and then to return to the application. It particularly affects applications that use multi-threading or which use high CPU utilization, and S7 (Europe) and S8 (global) phones. This bug is fixed in 5.6.4p2, 2017.1.2p4 , 2017.3.0b9 , 2017.2.0p3.
    • Do not use Utilities 1.11.0 due to a crash when returning to focus from Universal Menu or Quit to Home dialog.
  • Single-Pass Stereo Rendering
    • When Single Pass is enabled, building mobile projects will fail with the error message “Shader error in 'Mobile/Bumped Detail Diffuse'” in certain cases. For more information, see “Known Issues” in the Single Pass Stereo Rendering section of Advanced Rendering Features.
    • Two graphics driver issues affect mobile applications with Single Pass enabled using some S8 or S8+ phones with Unity 5.6.0p2-3. They can occur when Standard Shader Quality is set to low, or when you are using tree objects. For more information and workarounds, see “Known Issues” in the Single Pass Stereo Rendering section of Advanced Rendering Features.
  • Mixed Reality Capture
    • ZED Camera users should upgrade their SDK version to 2.3.1. All previous versions are not compatible.

Package Description

Unity versions 5.1 and later provide built-in VR support for the Oculus Rift, Samsung Gear VR, and Oculus Go. The optional Utilities Unity package includes prefabs, C# scripts, sample scenes, and more to assist with development. For more information, see our Unity 5 Developer Guide.

The Utilities package includes the most recent version of the Oculus OVRPlugin that is also included in the Unity Editor. When you import the Utilities package into a project, if the OVRPlugin included with Utilities is greater than the version in your Editor, a pop-up dialog will give you the option to update it. We recommend always using the latest-available OVRPlugin version.

For information on which versions of the Unity Editor are compatible with which versions of Utilities for Unity, please see Compatibility and Version Requirements.

Be sure to review our Downloads page for other useful tools to assist development, such as the Unity Sample Framework. For more information on Oculus resources for Unity developers, please see Other Oculus Resources for Unity Developers.

The Oculus Integration, available through the Unity Asset Store, provides several Unity Packages in a single download, including our Utilities for Unity, Oculus Platform SDK Unity plugin, Oculus Avatar SDK Unity Plugin, Oculus Native Spatializer Plugin, and the Unity Sample Framework.