Release Notes. Oculus 5.x Developer Guide

PDF

Documento

Unity | Release Notes | 55

Release Notes

This section describes changes for each version release.

1.3 Oculus Utilities for Unity 5 Release Notes

Oculus Utilities for Unity 5 version 1.3.2

This document provides an overview of new features, improvements, and fixes included in the latest version of the Oculus Utilities for Unity 5. For information on first-party changes to Unity VR support for Oculus, see the

Unity Release Notes for the appropriate version. You will find an updated scripting reference for the included

C# scripts in our Unity Developer Reference .

Unity Versions and OVRPlugin

Oculus Utilities for Unity 5 version 1.3.2 is for use with Unity 5.3 or Unity 5.4. It may only be used with Unity

5.3.3p3 or later, or 5.4.0b11 or later. You must download and install our OVRPlugin for Unity 1.3.2, available

from our Downloads Page, to use these versions. For more information, see Unity 5 and OVRPlugin 1.3.2

page 5.

New Features

• OVRInput may now be used without an OVRManager instance in the scene.

API Changes

• Restored OVRVolumeControl.

Bug Fixes

• OVRManager.instance.usePositionTracking now toggles the head model on Gear VR.

• Fixed incorrect fog interaction with transparent UI shader.

• Fixed crash on start with Unity 5.4.0b14 and b15 on Gear VR.

• Restored OVRVolumeControl, which was accidentally removed in 1.3.0.

Known Issues

• Utilities 1.3.0: Volume control will be missing on mobile applications until the release of Mobile SDK 1.0.2.

OVRVolumeControl is avaialble with Utilities v 0.1.3.0 and earlier. It was also restored in Utilities v 1.3.2.

Oculus Utilities for Unity 5 version 1.3.0

Note: Oculus Utilities for Unity 5 version 1.3.0 is for use with Unity 5.3.4p1 only. To use Unity 5.3.4p1

with the Oculus Rift or Samsung Gear VR, you must download and install our OVRPlugin for Unity

1.3.0, available from our Downloads page

. For more information, see Unity 5.3.4p1 and OVRPlugin

1.3.0

Overview of Major Changes

This public release incorporates all changes from Utilities private releases 0.2.0 through 1.3.0.

56 | Release Notes | Unity

We no longer include the deprecated InputManager.asset file.

Rift Floor-Level Tracking

OVR Manager now includes Tracking Origin Type, which defaults to Eye Level (i.e., tracking origin is handled as in previous releases). When set to Floor Level, tracking origin will be calculated relative to the user’s standing height as specified during Rift setup or with the Oculus app.

Note: Floor-level tracking will often be used with standing experiences, but there may be situations in which eye-level tracking is a better fit for a standing experience, or floor-level tracking is a better fit for a seated experience.

Any application running Unity should now be able to pull the correct height information.

New Features

• Added support for PC SDK 1.3, including support for Rift consumer version hardware.

• Added support for Asynchronous TimeWarp and Phase Sync.

• Added Rift Remote controller support.

• Added application lifecycle management, including VR-initiated backgrounding and exit.

• Exposed proximity sensor.

• Added support for multiple trackers.

• Exposed velocity and acceleration for all tracked nodes.

• Added support for EyeLevel and FloorLevel tracking origins.

• Audio input and output now automatically use the Rift microphone and headphones (if enabled in the

Oculus app).

• Rift’s inter-axial distance slider now affects the distance between Unity’s eye poses.

• Splash screen now uses Asynchronous TimeWarp for smooth tracking during load.

• Added experimental D3D 12 rendering support.

• Added events for focus change.

• Added events for audio device changes requiring sound restart.

• Added ControllerTracked state.

• Reduced head tracking latency on Gear VR by updating on render thread

• Improved performance by reducing lock contention.

• Exposed power management (CPU and GPU levels) on Android.

• Exposed queue-ahead on Android to trade latency for CPU-GPU parallelism.

API Changes

• OVRTracker.GetPose() no longer takes a prediction time. It now takes an optional index specifying the tracker whose pose you want.

• OVRTracker.frustum has been replaced by OVRTracker.GetFrustum(), which takes an optional index specifying the tracker whose frustum you want.

• OVRManager.isUserPresent is true when the proximity sensor detects the user.

• OVRInput.GetControllerLocal[Angular]Velocity/Acceleration exposes the linear and angular velocity and rotation of each Touch controller.

• OVRDisplay.velocity exposes the head’s linear velocity.

• OVRDisplay.angularAcceleration exposes the head’s angular acceleration.

• Removed OVRGamepadController.cs and OVRInputControl.cs scripts, which have been replaced by the new

OVRInput.cs script. Refer to

OVRInput for more information.

• Added public member Tracking Origin Type to OVR Manager.

Unity | Release Notes | 57

• Added “floor level” reference frame for apps that need accurate floor height.

• Removed OVRVolumeControl in favor of Universal Menu’s built-in volume meter.

• OVRManager.queueAhead now controls Gear VR latency mode, allowing you to trade latency for CPU-GPU parallelism. Queue-ahead is now automatically managed on Rift.

• Events OVRmanager.VrFocusLost and VrFocusAcquired occur when the app loses and regains VR focus (visibility on the HMD).

• Events OVRManager.AudioOutChanged and AudioInChanged occur when audio devices change and make audio playback impossible without a restart.

• OVRManager.cpuLevel controls CPU power-saving vs performance trade-off on Gear VR.

• OVRManager.gpuLevel controls GPU power-saving vs performance trade-off on Gear VR.

• Added ability to hold a named mutex throughout runtime.

Bug Fixes

• Removed redundant axial deadzone handling from Xbox gamepad input.

• Fixed OVRManager.monoscopic to display left eye buffer to both eyes and use center eye pose.

• Application lifetime management now works, even without the Utilities.

• Fixed crash when running VR apps with Rift disconnected.

• OVRManager.isUserPresent now correctly reports proximity sensor output.

• OVRManager.isHMDPresent now correctly reports Gear VR docking state.

• We now prevent AFR SLI on NVIDIA hardware to avoid black screens/flicker.

• Fixed drift between TimeWarp start matrix and view matrix.

• Fixed crash when main monitor is on one adapter and Rift is on another.

• Fixed crash on Mac due to OVRPlugin being uninitialized before first access.

• Increased dead zone on OVRInput stick input to prevent drift.

• Fixed handedness issue with angular head velocity on Rift.

• Fixed handedness issue with rotation of OVROverlay quads.

• Fixed crash in OVROverlay when using D3D 12 and compressed textures.

• Fixed crashes due to thread synchronization checks on Gear VR.

• Fixed loss of input handling while paused.

• Fixed artifact in which bars appeared around mirror image when using occlusion mesh.

• Fixed Android logcat spam about OVR_TW_SetDebugMode.

• Gear VR logs now report VRAPI loader version, not SystemActivites version.

• Statically linking MSVC runtime to avoid missing DLL dependencies.

• Fixed black screen when HMD was reconnected: notifying Unity of display lost.

Known Issues

• Volume control will be missing on mobile applications until the release of Mobile SDK 1.0.2. To restore

OVRVolumeControl, please use an older copy of the Utilities.

0.1 Beta Utilities for Unity Release Notes

This document provides an overview of new features, improvements, and fixes included in the latest version of the Oculus Utilities for Unity.

58 | Release Notes | Unity

Utilities for Unity 0.1.3.0 Beta

Overview of Major Changes

Note: For detailed information about Unity version compatibility, please see

Compatibility and

Requirements .

This document provides an overview of new features, improvements, and fixes included in the latest version of the Utilities for Unity 5.x. For information on first-party changes to Unity VR support for Oculus, see the Unity

Release Notes for the appropriate version.

Utilities for Unity 0.1.3 extends OVRInput support to mobile. OVRInputControl and OVRGamepadController are now deprecated and will be removed in a future release.

Mobile input bindings are now automatically added to InputManager.asset if they do not already exist - it is no longer required to replace InputManager.asset with Oculus’ version. However, this asset is still provided for now to maintain legacy support for the deprecated OVRGamepadController and OVRInputControl scripts.

New Features

• Default mobile input bindings are now programmatically generated when projects are imported if they do not already exist.

• Replacing InputManager.asset is no longer required to enable gamepad support on mobile.

API Changes

• Added mobile support OVRInput.

• Deprecated OVRInputControl and OVRGamepadController.

Bug Fixes

• Fixed mobile gamepad thumbstick deadzone/drift handling and axis scaling.

• Fixed mobile gamepad support when multiple gamepads are paired.

• Fixed mobile gamepad bindings for triggers, D-pad, thumbstick presses, etc.

Utilities for Unity 0.1.2.0 Beta

Overview of Major Changes

This version adds an alpha preview release of OVRInput, which provides a unified input API for accessing

Oculus Touch and Microsoft Xbox controllers.

New Features

• Redesigned input API for Oculus Touch controllers and Xbox gamepads.

• Added h264 hardware-decoder plugin for Gear VR.

• Added “face-locked” layer support to OVROverlay when parented to the camera.

• Reduced latency in the pose used by the main thread for raycasting, etc.

• Updated to PC SDK 0.7 and Mobile SDK 0.6.2.0.

• Enabled VRSettings.renderScale on Gear VR.

• Several minor performance optimizations.

• SDKExamples

• Restored MoviePlayerSample

Unity | Release Notes | 59

API Changes

• The Utilities package now requires Unity 5.1 or higher.

• Added OVRInput API alpha. Refer to documentation for usage.

• Exposed LeftHand/RightHand anchors for tracked controllers in OVRCameraRig.

Bug Fixes

• Restored ability to toggle settings such as monoscopic rendering and position tracking.

• HSWDismissed event is now correctly raised when the HSW is dismissed.

• Fixed handedness of reported velocity and acceleration values.

• OVRPlayerController now moves at a consistent speed regardless of scale.

Known Issues

• Tearing in OS X: Editor preview and standalone players do not vsync properly, resulting in a vertical tear and/or judder on DK2.

• When switching between a mobile application and System Activities screen, the back button becomes stuck in the "down" state. For more information and workarounds, please see Troubleshooting and Known Issues.

Utilities for Unity 0.1.0.0 Beta

Overview

This is the initial release of Oculus Utilities for Unity, for use with Unity versions 5.1.2 and later. The Utilities extend Unity's built-in virtual reality support with the following features:

• Standard camera rig with head-tracked "anchors".

• Detailed tracking information such as head acceleration, velocity, and latency and the IR tracker pose.

• Control over the tracking method (positional, head model only, rotation-only).

• Information about the current user's IPD, eye relief, and eye height.

• Control over graphics performance/quality features such as monoscopic rendering, queue-ahead (PC-only), and chromatic aberration.

• Experimental overlay support for high-quality text and video on a world-space quad.

• First-person shooter-style locomotion.

• Screen dimming on scene transitions.

• Notification when out of positional tracking range.

• Cross-platform gamepad support.

• Debug overlay with real-time performance and latency graphs.

• (Android only) Access to the Oculus platform UI.

• (Android only) Performance and power management.

The Oculus Utilities for Unity expose largely the same API as the Oculus Unity Integration, but they offer all the benefits of Unity's built-in VR support:

• Improved rendering efficiency with less redundant work performed for each eye.

• Seamless integration with the Unity Editor, including in-Editor preview and direct mode support.

• Improved stability and tighter integration with features like anti-aliasing and shadows.

• Non-distorted monoscopic preview on the main monitor.

• Oculus SDK 0.6.0.1 support (PC and mobile).

60 | Release Notes | Unity

API Changes in 0.1.0 Beta

The following Unity API changes were made:

• Unity 5.1.1p3 or higher is now required.

• Some script functionality was replaced by UnityEngine.VR.

• Added Crescent Bay support.

• Removed Linux support, for now.

• Removed OvrCapi, the low-level C# wrapper for LibOVR.

• Removed Gear VR MediaSurface functionality. Use Mobile Movie Texture or similar.

• The integration now uses a single stereo camera instead of two separate cameras for the left and right eyes.

• Direct mode now works in the Editor.

• To use VR, you must enable Player Settings -> Virtual Reality Supported.

• DirectToRift.exe no longer applies.

• Editor preview is now monoscopic and does not include lens correction.

• The experimental overlay quad script OVROverlay also works on the PC.

Known Issues

• Pitch, roll, and translation are off for the tracking reference frame in Unity 5.1.1, especially in apps with multiple scenes.

• Mac OS X tearing. VSync is currently broken on the Mac, but works when you build for Gear VR.

• Performance loss. CPU utilization may be slightly higher than in previous versions of Unity.

• OVRPlayerController might end up in an unexpected rotation after OVRDisplay.RecenterPose() is called. To fix it, call RecenterPose() again.

0.6 PC Unity Integration Release Notes

This document provides an overview of new features, improvements, and fixes included in the Oculus Unity

Integration that shipped with 0.6 of the Oculus PC SDK.

PC Unity Integration 0.6.0.0

New Features

• Disabled eye texture anti-aliasing when using deferred rendering. This fixes the blackscreen issue.

• Eliminated the need for the DirectToRift.exe in Unity 4.6.3p2 and later.

• Removed the hard dependency from the Oculus runtime. Apps now render in mono without tracking when

VR isn't present.

0.5 Mobile Unity Integration Release Notes

This document provides an overview of new features, improvements, and fixes included in the Oculus Unity

Integration that shipped with version 0.5 of the Oculus Mobile SDK.

Unity | Release Notes | 61

Mobile Unity Integration 0.5.1

Overview of Major Changes

The most significant change in 0.5.1 is to System Activities event handling in Unity. The 0.5.0 code for handling

System Activities events in Unity was doing heap allocations each frame. Though this was not a leak, it would cause garbage collection to trigger much more frequently. Even in simple applications, garbage collection routinely takes 1 to 2 milliseconds. In applications that were already close to dropping below 60 Hz, the increased garbage collection frequency could cause notable performance drops. The event handling now uses a single buffer allocated at start up.

As with Mobile SDK v 0.5.0, Unity developers using this SDK version must install the Oculus Runtime for

Windows or OS X. This requirement will be addressed in a future release of the SDK.

Bug Fixes

• Rework System Activities Event handling to prevent any per-frame allocations that could trigger Garbage

Collector.

Known Issues

• For use with the Mobile SDK, we recommend Unity versions 4.6.3. The Mobile SDK is compatible with Unity

5.0.1p2, which addresses a problem with OpenGL ES 3.0, but there is still a known Android ION memory leak. Please check back for updates.

Mobile Unity Integration 0.5.0

Overview of Major Changes

The Mobile Unity Integration is now synced with the Oculus PC SDK 0.5.0.1 Beta. Please ensure you have installed the corresponding 0.5.0.1 Oculus runtime; it can be found at the following location: https:// developer.oculus.com/downloads/

VrPlatform entitlement checking is now disabled by default in Unity; handling for native development is unchanged. If your application requires this feature, please refer to the Mobile SDK Documentation for information on how to enable entitlement checking.

New Features w

• Synced with the Oculus PC SDK 0.5.0.1 Beta.

• VrPlatform entitlement checking is now disabled by default.

Bug Fixes

• Health and Safety Warning no longer displays in editor Play Mode if a DK2 is not attached.

Known Issues

• For use with the Mobile SDK, we recommend Unity versions 4.6.3, which includes Android 5.0 - Lollipop support as well as important Android bug fixes. While the Mobile SDK is compatible with Unity 5.0.0p2

and higher, several issues are still known to exist, including an Android ION memory leak and compatibility issues with OpenGL ES 3.0. Please check back for updates.

62 | Release Notes | Unity

Mobile Unity Integration 0.5.0

Overview of Major Changes

New Features

• Synced with the Oculus PC SDK 0.5.0.1 Beta.

• VrPlatform entitlement checking is now disabled by default.

Bug Fixes

• Health and Safety Warning no longer displays in editor Play Mode if a DK2 is not attached.

Known Issues

and higher, several issues are still known to exist, including an Android ION memory leak and compatibility issues with OpenGL ES 3.0. Please check back for updates.

0.4 Mobile Unity Integration Release Notes

This document provides an overview of new features, improvements, and fixes included in the Oculus Unity

Integration that shipped with version 0.4 of the Oculus Mobile SDK.

Mobile Unity Integration 0.4.3

New Features

• New Mobile Unity Integration Based on Oculus PC SDK 0.4.4

Mobile Unity Integration 0.4.2

Overview of Major Changes

If you are developing with Unity, we recommend updating to Unity 4.6.1, which contains Android 5.0 – Lollipop support.

We would like to highlight the inclusion of the new Mobile Unity Integration with full DK2 support based on the Oculus PC SDK 0.4.4. As this is a significant API refactor, please refer to the Unity Development Guide:

Migrating From Earlier Versions section for information on how to upgrade projects built with previous versions of the Mobile Unity Integration.

API Changes

• Fix for camera height discrepancies between the Editor and Gear VR device.

Unity | Release Notes | 63

• Moonlight Debug Util class names now prefixed with OVR to prevent namespace pollution.

• Provide callback for configuring VR Mode Parms on OVRCameraController; see OVRModeParms.cs for an example.

Mobile Unity Integration 0.4.1

Overview of Major Changes

Added support for Android 5.0 (Lollipop) and Unity Free.

New Features

• Added Unity Free support for Gear VR developers.

Mobile Unity Integration 0.4.0

Overview of Major Changes

First public release of the Oculus Mobile SDK.

Bug Fixes

• Unity vignette rendering updated to match native (slightly increases effective FOV).

• Unity volume pop-up distance to match native.

Migrating From Earlier Versions

The 0.4.3+ Unity Integration’s API is significantly different from prior versions. This section will help you upgrade.

API Changes

The following are changes to Unity components:

Table 3: Unity Components

OVRDevice → OVRManager

OVRCameraController → OVRCameraRig

OVRCamera

The following are changes to helper classes:

Table 4: Helper Classes

OVRDisplay

OVRTracker

OVR.Hmd → Ovr.Hmd

The following are changes to events:

Table 5: Events

HMD added/removed

Unity foundation singleton.

Performs tracking and stereo rendering.

Removed. Use eye anchor Transforms instead.

HMD pose and rendering status.

Infrared tracking camera pose and status.

Pure C# wrapper for LibOVR.

Fired from OVRCameraRig.Update() on HMD connect and disconnect.

64 | Release Notes | Unity

Tracking acquired/lost

HSWDismissed

Get/Set*(ref *) methods

Fired from OVRCameraRig.Update() when entering and exiting camera view.

Fired from OVRCameraRig.Update() when the Health and Safety Warning is no longer visible.

Replaced by properties.

Behavior Changes

• OVRCameraRig’s position is always the initial center eye position.

• Eye anchor Transforms are tracked in OVRCameraRig’s local space.

• OVRPlayerController’s position is always at the user’s feet.

• IPD and FOV are fully determined by profile (PC only).

• Layered rendering: multiple OVRCameraRigs are fully supported (not advised for mobile).

• OVRCameraRig.*EyeAnchor Transforms give the relevant poses.

Upgrade Procedure

To upgrade, follow these steps:

1. Ensure you didn’t modify the structure of the OVRCameraController prefab. If your eye cameras are on

GameObjects named “CameraLeft” and “CameraRight” which are children of the OVRCameraController

GameObject (the default), then the prefab should cleanly upgrade to OVRCameraRig and continue to work properly with the new integration.

2. Write down or take a screenshot of your settings from the inspectors for OVRCameraController,

OVRPlayerController, and OVRDevice. You will have to re-apply them later.

3. Remove the old integration by deleting the following from your project:

• OVR folder

• OVR Internal folder (if applicable)

• Moonlight folder (if applicable)

• Any file in the Plugins folder with “Oculus” or “OVR” in the name

• Android-specific assets in the Plugins/Android folder, including: vrlib.jar, libOculusPlugin.so, res/raw and res/values folders

4. Import the new integration.

5. Click Assets -> Import Package -> Custom Package…

6. Open OculusUnityIntegration.unitypackage

7. Click Import All.

8. Fix any compiler errors in your scripts. Refer to the API changes described above. Note that the substitution of prefabs does not take place until after all script compile errors have been fixed.

9. Re-apply your previous settings to OVRCameraRig, OVRPlayerController, and OVRManager. Note that the runtime camera positions have been adjusted to better match the camera positions set in the Unity editor. If this is undesired, you can get back to the previous positions by adding a small offset to your camera: a.

Adjust the camera's y-position.

a. If you previously used an OVRCameraController without an OVRPlayerController, add 0.15 to the camera y-position.

b. If you previously used an OVRPlayerController with Use Player Eye Height checked on its

OVRCameraContoller, then you have two options. You may either (1) rely on the new default player eye-height (which has changed from 1.85 to 1.675); or (2) uncheck Use Profile Data on the converted

OVRPlayerController and then manually set the height of the OVRCameraRig to 1.85 by setting its y-

Unity | Release Notes | 65 position. Note that if you decide to go with (1), then this height should be expected to change when profile customization is added with a later release.

c. If you previously used an OVRPlayerController with Use Player Eye Height unchecked on its

OVRCameraContoller, then be sure uncheck Use Profile Data on your converted OVRPlayerController.

Then, add 0.15 to the y-position of the converted OVRCameraController.

Adjust the camera's x/z-position. If you previously used an OVRCameraController without an

OVRPlayerController, add 0.09 to the camera z-position relative to its y rotation (i.e. +0.09 to z if it has

0 y-rotation, -0.09 to z if it has 180 y-rotation, +0.09 to x if it has 90 y-rotation, -0.09 to x if it has 270 yrotation). If you previously used an OVRPlayerController, no action is needed.

10.Re-start Unity

Common Script Conversions

OVRCameraController -> OVRCameraRig

cameraController.GetCameraPosition() -> cameraRig.rightEyeAnchor.position

cameraController.GetCameraOrientation() -> cameraRig.rightEyeAnchor.rotation

cameraController.NearClipPlane -> cameraRig.rightEyeCamera.nearClipPlane

cameraController.FarClipPlane -> cameraRig.rightEyeCamera.farClipPlane

cameraController.GetCamera() -> cameraRig.rightEyeCamera

----------------------------------------------------------------------

if ( cameraController.GetCameraForward( ref cameraForward ) &&

cameraController.GetCameraPosition( ref cameraPosition ) )

{