Release Notes¶

Release 6.2.0¶

SDK

Added

Added WVR_GetSceneObjects API. (See WVR Scene).

Changes

For Lip Expression, change occurences of the text “smile” to “raiser” and “sad” to “stretcher” in the header file (see WVR Lip) and in the sample code (see WVR_GetLipExpData).

Unity

Added

Added APIs with timestamp for Hand and Eye Tracking.

Changes

Optimize the collision detection radius.

Direct Preview supports hand pinch.

Update controller and hand default models.

Update hand root pose at beforeRender.

Replace emotion-related texts with non-emotion descriptors.

Bug fixes

Fixed tearing problem of spectator camera recording.

Fixed the eye & lip expressions don’t work after device reconnection.

Unreal

Added

Added refined hand tracking models. The new model provides a more accurate representation and behavior, closely matching the movements and gestures of a real hand.

Added support for SceneObject to obtain the pose, mesh and external dimensions of perdefined objects in the Scene Perception feature. (See Unreal Scene Perception And Anchor)

Changes

Replaced emotion related texts with non-emotion ones. (See Lip Expression)

Known Issues

[UE5.0 Only] UE5.0 apps may encounter crash when launching on Focus Vision. Please use UE5.1 or above to avoid this issue. [Unreal issue]

FoveatedRendering is ineffective when Mobile Multi-View is enabled. Please disable Mobile Multi-View to use FoveatedRendering feature.

Release 6.1.0¶

SDK

Added

Added clamp mesh when passthrough is showing to reduce GPU loading.

Changes

Move eye tracking foveation from WVR_FoveationMode_Default to WVR_FoveationMode_Dynamic. (See WVR_RenderFoveationMode)

Upgrade android minSDKVersion to 29.

Bug fixes

Fixed WVR_GetEyeTracking crash due to accessing already free native buffer.

Unity

Changes

Added constraint and throw features in RHI.

Update facial expression mapping configuration value for mouth sad expression.

Upgrade android minSDKVersion to 29.

Unreal

Changes

Added limitation for android minSDKVersion. Please set android minSDKVersion to 29 or greater. (See Unreal Plugin Getting Started)

Known Issues

[UE5.0 Only] The apps built in UE5.0 will encounter crash when launching in some devices which have higher Android version. Please use the SDK for the UE version greater or equal to UE5.1 to avoid the crash issue. [Unreal issue]

FoveatedRendering is ineffective when Mobile Multi-View is enabled. Please disable Mobile Multi-View to avoid this issue if you would like to use FoveatedRendering feature.

Release 6.0.0¶

Unity

Added

Added debugging shortcut on SpectatorCameraManager.

Added the grabbing feature of Realistic Hand Interaction (Beta).

[Beta] FacialExpressionMaker: Add tool and sample for facial expression make. (This is an experimental feature.) (See FacialExpressionMaker)

Changes

Support mipmap on compositor layer.

When import ScenePerception’s demo, XRSDK Samples will be imported too.

Foveation added Dynamic mode in settings.

TrackableMarker add new API ClearTrackableMarker. (See Trackable Marker page)

Supports the self-tracker in Input System.

Supports Tracker Grip key, Menu touch and Trigger Touch (See Wave Tracker Interface).

Added API to check if the eye tracking device is connected.

Added WaveEssence APIs to get tracking information for WVR_DeviceType.

Added Tracker’s swipe event API.

Anchor added samples and helper functions for world alignment. (See Concept for Using Persisted Anchor in Multiplayer MR Games page)

When building apk, it will pop up a dialog to use newer gradle version.

Supports Tracker Menu Touch and Trigger Touch.

Bug fixes

Fixed the misnaming of the pinch area.

Fixed the controller render model showed in inverted direction.

Fixed ScenePerception’s demo cause compile error if no import XRSDK Samples.

Fixed Dynamic Resolution’s list value in settings will set to infinite if cannot get XRSettings.eyeTextureWidth.

Fixed Direct Preview hand tracking issue.

Fixed the issue that while using Input System, the controller sometimes will become unavailable after suspend/resume.

Removed

Body Tracking feature removed.

Unreal

Added

Support UE5.3.

Added new API ClearTrackableMarkers (beta version). (See Unreal Marker)

Support Unreal Engine API HMDWornState to detect if user is wearing the HMD or not.

Support Tracker Touchpad and Grip key. (See Tracker)

Bug fixes

Fixed “DirectPreview crash when using HandTrackingData” issue. (See DirectPreview)

Fixed “StereoLayer cannot be moved” issue. (Multi-Layer)

Fixed “Crash while using Transform of Anchor” issue. (See Unreal Scene Perception And Anchor)

Known Issues

FoveatedRendering is ineffective when Mobile Multi-View is enabled. Please disable Mobile Multi-View to avoid this issue if you would like to use FoveatedRendering feature.

Release 5.6.0¶

SDK

Added

Added WVR_HandGraspState in WVR_HandJointData. (See WVR_GetHandTrackingData)
Requests Wave Runtime 5.6.0+ (for API Level 16+) to support.

Added WVR_ClearTrackableMarkers API. (See WVR Marker)

Changes

Added WVR_SemanticLabelName inside WVR_ScenePlane data structure. (See WVR_GetScenePlanes)

Unity

Added

Added APIs for Hand Grasp. (See Hand Tracking)

Changes

Spectator feature: added FOV visualization, image stabilization feature, and tracker mode. (See Spectator page)

Spectator feature: supports “multi-scene” scenario and abandons “Controller” and “Custom” mode. (See Spectator page)

Added pinch area for Hand raycast. (See Raycast)

In the Scene Perception Feature, certain APIs that previously returned OpenGL data have been duplicated. Instead, please use the new APIs, which now provide data in Unity’s coordinate system and format.

[Important] Please set gradle version to 6.9.2 when using Unity version 2019.

Unreal

Added

Added APIs for Hand Grasp. (See Hand)

Added APIs to set/get focused tracker. (See Tracker)

Added APIs to check if the tracker pose is 6DoF. (See Tracker)

Changes

Support Java SE 11 only. (See Unreal Plugin Getting Started)

Change a variable name in the anchor’s blueprint function ‘GetFilesInFolder’.

Known Issues

FoveatedRendering is ineffective when Mobile Multi-View is enabled. Please disable Mobile Multi-View to avoid this issue if you would like to use FoveatedRendering feature.

Release 5.5.0¶

SDK

Added

Added isPinching to explicitly express pinch or not. (sample code in WVR_GetHandTrackingData)
Requests Runtime with API Level 16+ to support.

Added new API WVR_SetPassthroughImageRate. (See WVR System)

Only supported 64-bit in WAVE SDK 5.5.0 and later.

Changes

No longer support 32-bits from WAVE SDK 5.5.0

Unity

Added

Added Passthrough image frame rate API. (See WVR System)

Supported MRTK 2.8.3 and 3.0.0 including controller, hand tracking and hand interaction.

Added checkbox to skip auto update package.

Provided new APIs of “Hand is pinching state” and “Hand Pinch Off Threshold”. (See Hand Tracking)

Supported Unity InputFeatureUsage<bool>(“TriggerTouch”).

Added TrackersXR demo scene.

Changes

[Important] Wave SDK No Longer Support 32-bit after Version 5.5.0.

Put dynamic change tracking origin in WaveRig back.

Refactored Direct Preview to support URP single-pass and improve stability.

Bug fixes

Fixed spectator kept increasing the depth value of Camera.main.

Removed duplicated event generator.

Unreal

Added

Added PassthroughImageRate blueprint API. (See Passthrough Quality, Performance, and Aligment)

Added Hand Tracking blueprint APIs of “Hand is pinching state” and “Hand Pinch Off Threshold”. (See Hand)

Bug fixes

Fixed “Direct Preview did not work without installing Visual Studio (MSVCP140D.dll)” issue. (See DirectPreview)

Fixed “Package failed when the IncludeOrderVersion is not EngineIncludeOrderVersion.Latest.” issue. The blueprint project, for example Virtual Reality Template, would encounter this problem because the default value of IncludeOrderVersion is Unreal5_0 in Unreal Engine 5.2.

Fixed “Anchor helper function GetFilesInFolder acturally output filenames but not filePathnames.” and ducument modification.

Known Issues

FoveatedRendering is ineffective when Mobile Multi-View is enabled. Please disable Mobile Multi-View to avoid this issue if you would like to use FoveatedRendering feature.

Release 5.4.0¶

SDK

Added

Added cached and persisted anchor APIs.

Added three new events WVR_EventType_SpatialAnchor_Changed / WVR_EventType_CachedAnchor_Changed / WVR_EventType_PersistedAnchor_Changed. (See WVR Scene)

Unity

Added

Added body Tracking feature. (See Body Tracking)

Added persisted spatial anchor, cached spatial anchor and updated the samples. (See Unity Spatial Anchor )

Added Spectator Feature Pack. (See Spectator Camera)

Added acceleration of Tracker.

Added PoseState of ViveWaveWristTracker(Input System).

Added Hand Pinch selection for GazeRayCasting.

Changes

New feature package of Essence: URPMaterial package provides hand materials for URP environment.

If runtime RenderModel is not set, the default controller render model is changed from Focus’ controllers to Focus 3’s controllers.

Refine the memory usage of the controller render model.

Hide the raycast beam/pointer by default. (See Raycast)

Bug fixes

Fixed controller buttons texture is missing.

Fixed controller render model is not shown in some cases.

Fixed Direct Preview apk install failed issue.

Unreal

Added

Support UE5.2.

Cached/Persisted anchor APIs and the sample. (See Unreal Spatial Anchor)

Hand pinch for WaveVRGazePointer. (See Interaction)

Changes

The server process window for DirectPreview will be minimized in the taskbar. (See DirectPreview)

Set HMD pose to invalid when AP suspends.

Bug fixes

Fixed “The rendered frame in HMD looks laggy after the device is suspended and resumed in DirectPreview” issue.

Known Issues

[UE5.0/5.1/5.2] FoveatedRendering is ineffective when Mobile Multi-View is enabled. Please disable Mobile Multi-View to avoid this issue if you would like to use FoveatedRendering feature.

[UE5.0] MSAA is not supported currently when Mobile Multi-View is enabled. Android application will crash when launched. Please set MSAA Sample Count as No MSAA or disable Mobile Multi-View in project settings to avoid this issue.

[UE5.0] There is a chance that the texture set on a StereoLayer component is invalid when a level is loaded. This may lead to the disappearance of the StereoLayer as it cannot be rendered correctly. [Unreal Issue]

[UE4.27] Alpha blending with translucent foreground objects is incorrect for StereoLayers when the “Supports Depth” option is enabled.

[UE4.27] Selecting 32-bit builds may encounter an issue that abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

Release 5.3.2¶

SDK

Changes

When the overlay pops up, the tracker pose will be invalid and tracker button feature will be disabled.

Unity

Added

Added an interface for prioritizing Game / Render / JobWorker thread.

Changes

Reduced the time of getting battery level of RenderModel.

Bug fixes

Fixed HMD tracking is sometimes abnormal after suspending/resuming when using Input System.

Unreal

Bug fixes

[UE5.0/5.1] Fixed “The controller pointer may be occluded by translucent GUI widgets” issue.

Known Issues

[UE5.0] MSAA is not supported currently when Mobile Multi-View is enabled. The android application will crash when launched. Please set MSAA Sample Count as No MSAA or disable Mobile Multi-View in project settings to avoid this issue.

[UE5.0/5.1] FoveatedRendering is ineffective when Mobile Multi-View is enabled. Please disable Mobile Multi-View to avoid this issue if you would like to use FoveatedRendering feature.

[UE5.0] There is a chance where the texture set on a StereoLayer component is invalid when a level is loaded. This may lead to the disappearance of the StereoLayer as it cannot be rendered correctly. [Unreal Issue]

[UE4.27] Alpha blending with translucent foreground objects is wrong for StereoLayers with the “Supports Depth” option enabled.

[UE4.27] 32-bit builds may encounter an issue where abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

Release 5.3.1¶

SDK

Bug fixes

Fixed memory leakage for the app built with SDK 5.3.0 is under casting or recording.

Release 5.3.0¶

SDK

Added

Supports Marker SDK (beta version). (See WVR Marker)

Extend the definition of tracker role for function WVR_GetTrackerRole. (See WVR Tracker)

Add new event WVR_EventType_TrackerRoleChanged. (See WVR Tracker)

Changes

VR application renders with slow FPS instead of stopping rendering completely when the HMD’s display off.

Known Issues

The app built with SDK 5.3.0 has memory leakage is under casting or recording. It is strongly recommended to upgrade to SDK 5.3.1.

Unity

Added

Added support for Marker feature (beta version). (See Unity Marker)

Added URP support for DirectPreview.

Added New Tracker IDs and Roles.

Added Supports Pinch release strength and default Pinch Threshold in HandRaycastPointer.

Added Supports the Tracker name in XRSDK package.

Added Support for Unity 2022.

Changes

userPresence is NOT supported to checks the proximity sensor status.

Bug fixes

Fixed DirectPreview Dll not found issue on some PCs.

Fixed Dynamic Resolution List index out of bounds error.

If the controller is disconnected, the controller pose mode will be incorrected after AP resumes.

The RenderModel will not appear sometimes.

Cannot retrieve the correct tracker role when changing the role in runtime.

Fixed an issue where the Marker Setting option is duplicated in Wave XR Settings.

Solve SDK hand tracking low performance and GC.Alloc() problems.

Unreal

Added

Support UE5.1.

Supports Marker feature (beta version). (See Unreal Marker)

Added New Tracker IDs and Roles. (See Tracker)

Changes

Re-architect DirectPreview. (See DirectPreview)

Bug fixes

[UE5.0] Fixed “VRPreview rendered abnormal when enlarged New Viewport Resolution in Editor Preferences” issue. (Used in DirectPreview)

Fixed “Color deviation occurred on StereoLayer if adding any oculus device in project settings Package for Oculus Mobile devices issue.

Known Issues

[UE5.0] MSAA is not supported currently when Mobile Multi-View is enabled. The android application will crash when launched. Please set MSAA Sample Count as No MSAA or disable Mobile Multi-View in project settings to avoid this issue.

[UE5.0/5.1] FoveatedRendering is ineffective when Mobile Multi-View is enabled. Please disable Mobile Multi-View to avoid this issue if you would like to use FoveatedRendering feature.

[UE5.0] There is a chance where the texture set on a StereoLayer component is invalid when a level is loaded. This may lead to the disappearance of the StereoLayer as it cannot be rendered correctly. [Unreal Issue]

[UE4.27] Alpha blending with translucent foreground objects is wrong for StereoLayers with the “Supports Depth” option enabled.

[UE4.27] 32-bit builds may encounter an issue where abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

Release 5.2.1¶

SDK

Changes

Improve controller, wrist tracker and hand pose alignment with passthrough image.

Change the default mode of passthrough focus mode from SCALE to VIEW.

Re-enable HUD showing when HUD setting tool installed and enabled.

Unity

Added

Added legacy controller sample in XRSDK.

Added Velocity and Angular Velocity APIs of Controller and Tracker.

Added Wave SDK and Unity version information in AndroidManifest.xml.

Removed

Removed Essence Input System scripts.

Bug fixes

Fixed CommonUsages.trackingState is incorrect when a controller lost tracking.

Fixed wvr_plugins_directpreview DllNotFoundException on some PCs.

Release 5.2.0¶

SDK

Added

Add new parameter timestamp to function WVR_GetTrackerExtendedData. (See WVR Tracker)

Add new API WVR_GetTrackerDeviceName for tracker device. (See WVR Tracker)

Add new API WVR_SetPassthroughImageQuality. (See WVR System)

Add new API WVR_SetPassthroughImageFocus. (See WVR System)

Add new API WVR_SetFrameRate to set the render target frame rate.

Add new API WVR_GetFrameRate to get the render target frame rate.

Add new API WVR_GetAvailableFrameRates to get available frame rates.

Add WVR_FoveationMode_Dynamic Foveation Mode. (See WVR_RenderFoveationMode)

Changes

Watchdog enhancement on android main thread.

System overlay rendering moves to OverlayCompositor process.

Controller model/Hand model UX refinement in system overlay.

Known Issues

Disable HUD showing when HUD setting tool installed and enabled.

Unity

Added

New option to modify AndroidManifest.xml to enable Scene Perception.(See Unity Scene Perception)

Integrates all AndroidManifest.xml related settings. (See Configure AndroidManifest.xml)

New Tracker API: GetTrackerDeviceName and GetTrackerExtData with timestamp.

Added API to change Passthrough image quality, and sample in passthrough test.

Added API to change Passthrough image focus, and sample in passthrough test.

Added APIs to set/get target frame rate, and sample in passthrough test.

Changes

Default Controller Pose Mode is changed to RAW instead of PANEL. (See Controller Orientation)

Supports new foveation mode - Dynamic mode. (See WVR_RenderFoveationMode)

Re-architect DirectPreview. (See DirectPreview)

Unreal

Added

Supports new foveation mode - Dynamic mode. (See FoveatedRendering)

Supports APIs for passthrough performance adjustment. (See Passthrough Quality, Performance, and Aligment)

Supports APIs for setting target frame rate. (See Target Frame Rate)

Added Scene Perception Auto Run map to demonstrate dynamic update.

Supports Palm condition of Custom Gesture. (See Hand).

Adds new Tracker APIs: GetTrackerExtendedDataTimestamp and GetTrackerDeviceName in UWaveVRTrackerBPLibrary. (See Tracker).

Changes

To use Scene Perception, allowing feature in WaveVR project settings is required. (See Unreal Scene Perception And Anchor)

To use Scene Mesh, request permission is required. (See Unreal Scene Perception And Anchor)

Known Issues

[UE5.0] MSAA is not supported currently when Mobile Multi-View is enabled. The android application will crash when launched. Please set MSAA Sample Count as No MSAA or disable Mobile Multi-View in project settings to avoid this issue.

[UE5.0] FoveatedRendering is ineffective when Mobile Multi-View is enabled. Please disable Mobile Multi-View to avoid this issue if you would like to use FoveatedRendering feature.

[UE5.0] There is a chance where the texture set on a StereoLayer component is invalid when a level is loaded. This may lead to the disappearance of the StereoLayer as it cannot be rendered correctly. [Unreal Issue]

[UE4.27] Alpha blending with translucent foreground objects is wrong for StereoLayers with the “Supports Depth” option enabled.

[UE4.27] 32-bit builds may encounter an issue where abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

Release 5.1.1¶

Note

This version has a known issue NOT working on Vive Focus(+) and Vive Flow. Please use the previous version(5.0.3 or former) on these Vive devices. We are fixing this compatibility issue and target to fix in next SDK release.

SDK

Changes

Fixed passthrough color abnormal if app uses linear color space.

Supported passthrough auto resume mechanism after app pause and resume.

Unity

Added

Supports Input System with Eye Gaze and Wrist Tracker.

Changes

Decoupled Unity focusLost state with Wave input focus state.

Unreal

Added

Supports GetDeviceErrorState blueprint function for retriving specified device error such as lost tracking status. (See Overview)

Changes

Scene Perception API refinement. (See Unreal Scene Perception And Anchor)

Known Issues

[UE5.0] MSAA is not supported currently when Mobile Multi-View is enabled. The android application will crash when launched. Please set MSAA Sample Count as No MSAA or disable Mobile Multi-View in project settings to avoid this issue.

[UE5.0] FoveatedRendering is ineffective when Mobile Multi-View is enabled. Please disable Mobile Multi-View to avoid this issue if you would like to use FoveatedRendering feature.

[UE5.0] There is a chance where the texture set on a StereoLayer component is invalid when a level is loaded. This may lead to the disappearance of the StereoLayer as it cannot be rendered correctly. [Unreal Issue]

[UE4.27] Alpha blending with translucent foreground objects is wrong for StereoLayers with the “Supports Depth” option enabled.

[UE4.27] 32-bit builds may encounter an issue where abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

Release 5.1.0¶

Note

This version has a known issue NOT working on Vive Focus(+) and Vive Flow. Please use the previous version(5.0.3 or former) on these Vive devices. We are fixing this compatibility issue and target to fix in next SDK release.

SDK

Added

Supports Scene SDK (beta version). (See WVR Scene)

Changes

Improve the performance and quality for the system and SDK passthrough.

Refine algorithm about auto mode in Timewarp Stabilized Mode.

Unity

Added

Supports Scene Perception feature (beta version). (See Unity Scene Perception)

Supports UnityEngine.XR.Eyes. (See Unity XR InputDevice - Eye Tracking)

Supports Input System and Interaction Toolkit (Action-based) which needs Input System 1.4.3 or newer version.

Added the InputDevice of Hand.

Changes

Compositor Layers now support runtime layer size adjustments for both Quad and Cylinder layers.

Fixed incorrect cylinder meshes generated by Compositor Layer.

Removed

Removed in-Editor Underlay and Fallback Mesh generation. Underlay and Fallback Meshes will be generated during runtime instead.

Removed the “Use XR Device” option from the Inspector of TrackerManager. (See Tracker)

Removed the “Use XR Device” option from the Inspector of HandManager. (See UnityXR/UnityXRHand)

Unreal

Added

Supports Scene Perception And Anchor feature (beta version). (See Unreal Scene Perception And Anchor)

Bug fixes

[UE5.0] Fixed “Passthrough Underlay rendered abnormally.” issue when there is any Oculus devices added in “Package for Oculus Mobile devices” in project settings.

Known Issues

[UE5.0] MSAA is not supported currently when Mobile Multi-View is enabled. The android application will crash when launched. Please set MSAA Sample Count as No MSAA or disable Mobile Multi-View in project settings to avoid this issue.

[UE5.0] FoveatedRendering is ineffective when Mobile Multi-View is enabled. Please disable Mobile Multi-View to avoid this issue if you would like to use FoveatedRendering feature.

[UE5.0] There is a chance where the texture set on a StereoLayer component is invalid when a level is loaded. This may lead to the disappearance of the StereoLayer as it cannot be rendered correctly. [Unreal Issue]

[UE4.27] Alpha blending with translucent foreground objects is wrong for StereoLayers with the “Supports Depth” option enabled.

[UE4.27] 32-bit builds may encounter an issue where abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

Does not support IME in the current version.

Release 5.0.3¶

SDK

Added

Supports EyeExpression SDK (See WVR Eye).

Changes

Fixed Hand Gesture without init value when no update (ex. in controller mode)

Fixed Lip Expression memory leak in WVR_GetLipExpData

Unity

Added

Added Eye Expression feature. (See Eye Expression)

Removed

Set the “Use XR Device” option to obsolete and will remove the option in next release.

Unreal

Added

Added Eye Expression feature. (See Eye Expression)

Added Passthrough Underlay feature. (See Passthrough Underlay)

Support multiple trackers.

Bug fixes

Fixed “The batttery icon did not show when battery is 100%” issue.

Fixed “Supports Depth option is not supported in UE5” issue. (Multi-Layer)

Removed

shouldGrantPermission is deprecated, please use isPermissionGranted instead, the return value of shouldGrantPermission is the negative of the return value of isPermissionGranted. (Runtime Permission)

requestUsbPermission is deprecated and will be removed in the next version.

Known Issues

[UE5.0] MSAA is not supported currently when Mobile Multi-View is enabled. The android application will crash when launched. Please set MSAA Sample Count as No MSAA or disable Mobile Multi-View in project settings to avoid this issue.

[UE5.0] FoveatedRendering is ineffective when Mobile Multi-View is enabled. Please disable Mobile Multi-View to avoid this issue if you would like to use FoveatedRendering feature.

[UE5.0] There is a chance where the texture set on a StereoLayer component is invalid when a level is loaded. This may lead to the disappearance of the StereoLayer as it cannot be rendered correctly. [Unreal Issue]

[UE4.27] Alpha blending with translucent foreground objects is wrong for StereoLayers with the “Supports Depth” option enabled.

[UE4.27] 32-bit builds may encounter an issue where abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

Does not support IME in the current version.

Release 5.0.2¶

SDK

Added

Supports EyeTracking SDK (See WVR Eye).

Support Lip Expression SDK (See WVR Lip)

Support wvr_notifydeviceinfo SDK, Let AP can inform Device event (See WVR Notify DeviceInfo).

Support Tracker new APIs. Via these three APIs, AP can receive the information which will be sent from tracker device. (See Tracker Info Notification)

Introduce shading rate (GL_QCOM_shading_rate if chipset support) in ATW warp render pipeline to enhance GPU performance.

Add Projected Passthrough APIs (See WVR System)

Unity

Added

Added Eye Tracking feature. (See Eye Tracking)

Added Lip Expression feature. (See Lip Expression)

Added Projected Passthrough APIs (See WVR System)

Unreal

Added

Support UE5.0.

Added Eye Tracking Gaze (RaycastEyeTracking) feature. (See Eye Tracking)

Added Lip Expression feature. (See Lip Expression)

Added Projected Passthrough feature. (See ProjectPassthroughComponent)

Added option Position in InAppRecenter blueprint function to recenter position of tracking space only. (See Pose Manager)

Changes

Calling Show Passthrough Overlay with DelaySubmit=true will hide indicators no matter what ShowIndicator is in previous version. Now the indicators will show if ShowIndicator is true. (See Passthrough Overlay)

The ResetOrientationAndPosition implemented by InAppRecenter. (See Teleport)

Removed

Removed deprecated APIs and blueprint class Assets. Such as WaveVR_Pawn/Controller Loader/WaveVR_ControllerInstanceManager/Wave_AdaptiveController/WaveVR_RenderModel/WaveVR_LinePointer/WaveVRInputModuleGaze/WaveVRInputModuleManager/Interaction_Interface.

Known Issues

[UE5.0] Did not support MSAA for now. The android application will crash while launching. Please set MSAA Sample Count as No MSAA in project settings to avoid this issue.

[UE5.0] FoveatedRendering will take no effect when Mobile Multi-View is enabled. Please disable Mobile Multi-View to avoid this issue if you would like to use FoveatedRendering feature.

[UE5.0] The Multi-Layer “Supports Depth” option is not supported in UE5.

[UE4.26/27] Alpha blending with translucent foreground objects is wrong for StereoLayers with the “Supports Depth” option enabled.

[UE4.26/27] 32-bit builds may encounter an issue where abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

Does not support IME in the current version.

Release 4.5.0¶

SDK

Added

Add WVR_SetPassthroughOverlayAlpha which allows to set passthrough overlay alpha value (See WVR_SetPassthroughOverlayAlpha).

Supports feature of using hand and controller simultaneously (Early Access) (See WVR Hand).

Supports new device state to know user put down or picked up controller (See WVR_IsDeviceTableStatic).

Supports compatibility checker tool (See Compatibility Guide).

Changes

Change API bool WVR_ShowPassthroughOverlay(bool show, bool delaySubmit = false) to bool WVR_ShowPassthroughOverlay(bool show, bool delaySubmit = false, bool showIndicator = false).

Removed

Removed WVR_EnableAutoPassthrough API.

Unity

Added

Supports compatibility checker tool (See Compatibility Guide).

Added WVR_SetPassthroughOverlayAlpha which allows to set passthrough overlay alpha value.

Supports Simultaneous Interaction (Early Access) (See Interaction).

Changes

Change API bool WVR_ShowPassthroughOverlay(bool show, bool delaySubmit = false) to bool WVR_ShowPassthroughOverlay(bool show, bool delaySubmit = false, bool showIndicator = false).

Unreal

Added

Supports Custom Gesture (See Hand ActorComponent).

Supports Simultaneous Interaction (Early Access) (See Interaction).

Supports Passthrough Overlay (See Passthrough Overlay).

Supports compatibility checker tool (See Compatibility Guide).

Known Issues

Does not support IME in the current version.

[UE4.26/27] Alpha blending with translucent foreground objects is wrong for StereoLayers with the “Supports Depth” option enabled.

[UE4.26/27] 32-bit builds may encounter an issue where abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

[UE4.25] Build with Android Target 29 and 64bit will crash because ensure will cause crash. [Unreal Issue]

[UE4.25] In 32-bit shipping builds, using Stereo Layers may cause the application to crash.

[UE4.24/25] There is an issue where the background color of UMG may not be rendered properly in UE4.24 and UE4.25 due to an OpenGL ES libraries conflict. We strongly recommend you to use UE4.26 instead. According to the Release Notes of UE4.26, the OpenGL ES implementation has already been cleaned up based it on the ES3.1 spec. [Unreal Issue]

[UE4.24/25] On devices that do not support Multi-Layers, content rendered by DefaultStereoLayers is wrong in shipping builds. [Unreal Issue]

[UE4.24] MotionController is deprecated. Please replace them with our Input Blueprint. For more details, see Controller Buttons.

[UE4.24] Crash while open level many times in shipping build. The workaround for this is to select Source Type of Light in SkyLight as SLS_Specified_Cubemap and avoid selecting SLS_Capture_Scene.

Release 4.4.0¶

SDK

Added

Separate the flags (WVR_RenderConfig_Initialize_FadeOut, WVR_RenderConfig_Initialize_UMC, WVR_RenderConfig_Initialize_PMC) of WVR_RenderConfig to improve GPU performance (See WVR_RenderInit).

Introduce Frame Sharpness Enhancement (FSE, See Frame Sharpness Enhancement(FSE)) for content layer only.

Supply hand wrist pose with linear velocity and angular velocity.

Supports prediction feature of function WVR_GetTrackerPoseState.

Bug fixes

Fixed device error state mistake while multiple errors happened.

Unity

Added

Support the Hand Gesture “Yeah”.

Support the wrist linear/angular velocity.

Added Frame Sharpness Enhancement feature (See Frame Sharpness Enhancement).

DirectPreview added controller haptics and hand tracking supports.

Changes

Added a project setting for Fade-Out. Disable it for better GPU performance if you do not use Fade-Out Effect feature. Because this setting is disabled by default, if you are using Fade-Out Effect and want to upgrade from older Wave VR version, please remember to select it manually or the Fade-Out will take no effect.

Bug fixes

Fixed controller model has black texture.

Unreal

Added

Supports the Hand Gesture “Yeah”.

Supports the wrist linear/angular velocity.

[UE4.26/27] Added Frame Sharpness Enhancement feature (See Frame Sharpness Enhancement).

Changes

[UE4.26/27] Added a project setting for Fade-Out. Disable it for better GPU performance if you do not use Fade-Out Effect feature. Because this setting is disabled by default, if you are using Fade-Out Effect and want to upgrade from older Wave VR version, please remember to select it manually or the Fade-Out will take no effect (See FadeOut Effect).

Bug fixes

Fixed “Crash when the battery level is changing” issue.

[UE4.26/27] Fixed an issue where using StereoLayer will crash the app after a few minutes.

Known Issues

Does not support IME in the current version.

[UE4.26/27] Alpha blending with translucent foreground objects is wrong for StereoLayers with the “Supports Depth” option enabled.

[UE4.26/27] 32-bit builds may encounter an issue where abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

[UE4.25] Build with Android Target 29 and 64bit will crash because ensure will cause crash. [Unreal Issue]

[UE4.25] In 32-bit shipping builds, using Stereo Layers may cause the application to crash.

[UE4.24/25] There is an issue where the background color of UMG may not be rendered properly in UE4.24 and UE4.25 due to an OpenGL ES libraries conflict. We strongly recommend you to use UE4.26 instead. According to the Release Notes of UE4.26, the OpenGL ES implementation has already been cleaned up based it on the ES3.1 spec. [Unreal Issue]

[UE4.24/25] On devices that do not support Multi-Layers, content rendered by DefaultStereoLayers is wrong in shipping builds. [Unreal Issue]

[UE4.24] MotionController is deprecated. Please replace them with our Input Blueprint. For more details, see Controller Buttons.

[UE4.24] Crash while open level many times in shipping build. The workaround for this is to select Source Type of Light in SkyLight as SLS_Specified_Cubemap and avoid selecting SLS_Capture_Scene.

Release 4.3.0¶

SDK

Added

Supports Tracker SDK (See WVR Tracker).

Show virtual wall boundary effect when using hand tracking as like using controller.

Draw the different appearance of hand according to the hand stability (WVR_IsEnhanceHandStable).

Adds new APIs WVR_EnhanceHandStable() and WVR_IsEnhanceHandStable(), also the correspondent event WVR_EventType_Hand_EnhanceStable to notify if Hand Stability is enhanced with WAVE Wrist Tracker.

Supports Hand Gesture Palm Pinch. Right Hand Palm Pinch is reserved for System and Left Hand Palm Pinch is for Content Developers, See Palm_Pinch.

Bug fixes

Fixed “There is slight blue edges are on the right and bottom of the display.” issue.

Fixed “The partial texture layout can’t work in multi-layer and the API WVR_SubmitFrameLayers.” issue.

Fixed the ray is focused on wrong controller when only one controller connected and the role is left.

Unity

Added

Supports gestures in Hand Tracking.

Supports Tracker component.

Provides Hand and Tracker XR InputDevices.

Added a new component “CompositorLayerUICanvas” for rendering UI Canvases with Compositor Layers.

Changes

Rename the term “Inverse” to “Palm_Pinch” in enum WVR_HandGestureType in wvr.cs.(Native package)

Removed

Removed enum WVR_DeviceErrorState from wvr.cs. (Native package)

Bug fixes

Fixed Direct Preview stability issues.

Unreal

Added

Supports Gestures in Hand Tracking.

Supports Tracker component.

Added a Sample and Actor Template that demonstrates how to render Widgets with Stereolayers.

[UE4.26 Only] Added StereoLayer Depth Support.

Bug fixes

Fixed “Direct Preview picture in HMD will flicker while choosing Wi-Fi type” issue.

Fixed Direct Preview stability issues.

Fixed an issue regarding the initialization process of StereoLayers.

Known Issues

[UE4.24/25] There is an issue where the background color of UMG may not be rendered properly in UE4.24 and UE4.25 due to an OpenGL ES libraries conflict. We strongly recommend you to use UE4.26 instead. According to the Release Notes of UE4.26, the OpenGL ES implementation has already been cleaned up based it on the ES3.1 spec. [Unreal Issue]

[UE4.25] Build with Android Target 29 and 64bit will crash because ensure will cause crash. [Unreal Issue]

Does not support IME in the current version.

[UE4.24/25] On devices that do not support Multi-Layers, content rendered by DefaultStereoLayers is wrong in shipping builds. [Unreal Issue]

[UE4.26] Alpha blending with translucent foreground objects is wrong for StereoLayers with the “Supports Depth” option enabled.

[UE4.25] In 32-bit shipping builds, using Stereo Layers may cause the application to crash.

[UE4.24] MotionController is deprecated. Please replace them with our Input Blueprint. For more details, see Controller Buttons.

[UE4.24] Crash while open level many times in shipping build. The workaround for this is to select Source Type of Light in SkyLight as SLS_Specified_Cubemap and avoid selecting SLS_Capture_Scene.

[UE4.26] 32-bit builds may encounter an issue where abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

Release 4.2.0¶

SDK

Added

Light weight render pipeline for performance enhancement.

Support controller center alignment function for 3DoF controller device case.

Added hand hold motion. There are two hand poses now: Pinch & Hold. Each hand has its role and you can retrieve the holding object type while holding.

Wave SDK API Level set to 8 see Wave VR Version List.

Bug fixes

Fixed possible stability issue while suspend and resume.

Fix the casting/recording icon becomes narrower.

Decreases black border when surrounding passthrough showing.

Fix hand ray will jitter when passthrougth showing.

Fix “When apply WVR_SetOverfillRatio with higher ratio, the more decline of quality on overlay” issue.

Content hands hide while Overlay hands show.

Known Issues

The partial texture layout can’t work in multi-layer and the API WVR_SubmitFrameLayers.

There is slight blue edges are on the right and bottom of the display.

Unity

Added

Added Multi-Layer Auto Fallback.

Added tracker interface.

Added hand hold motion. There are two hand poses now: Pinch & Hold. Each hand has its role and you can retrieve the holding object type while holding.

Changes

Refine the static gesture APIs.

Reduce the response time when switching from hand to controller model.

Unreal

Added

Added outline effects of buttons.

Added tracker interface.

Added hand hold motion. There are two hand poses now: Pinch & Hold. Each hand has its role and you can retrieve the holding object type while holding.

Changes

Refine the name of device keys to follow the naming rule of UE4.

Apply hand scale to model. The hand model will adjust to fit the user’s hand.

Refine controller’s animation.

Refine the project settings of Direct Preview.

Rename the plugin name “WaveVR Plugin” with “Wave VR”.

Bug fixes

Fixed “Controller button effects/animations were not working after resume” issue.

Fixed “The controller beams will keep switching when pressing two trigger buttons concurrently” issue.

Fixed “Device button states were not correct after using the quick menu” issude.

Fixed “Build failed while using Visual Studio 2019” issue.

Known Issues

[UE4.25] Build with Android Target 29 and 64bit will crash because ensure will cause crash. [Issue of Unreal]

Does not support IME in the current version.

[UE4.24/25] On devices that do not support Multi-Layers, content rendered by DefaultStereoLayers is wrong in shipping builds. [Unreal Issue]

[UE4.25] In 32-bit shipping builds, using Stereo Layers may cause the application to crash.

[UE4.24] MotionController is deprecated. Please replace them with our Input Blueprint. For more details, see Controller Buttons.

[UE4.24] Crash while open level many times in shipping build. The workaround for this is to select Source Type of Light in SkyLight as SLS_Specified_Cubemap and avoid selecting SLS_Capture_Scene.

[UE4.26] 32-bit builds may encounter an issue where abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

Release 4.1.1¶

r.3.2¶

Unity

Added

Added static hand gesture support.

r.3.1¶

SDK

Added

Controller Animation API.

Hand Model API.

Add 2 new WVR event (WVR_EventType_RenderingToBePaused, WVR_EventType_RenderingToBeResumed) to notify the developer to handle or not in their game logic.

Support more Passthrough feature (WVR_ShowPassthroughOverlay, WVR_ShowPassthroughUnderlay) for generic apps.

Introduce the 2 stage pipeline in ATW. Improve render pipeline to balance overall performance/CAC/quality, especially while there are multi-layers shown.

Bug fixes

Fix “UMC feature (experimental) disable while PTW is off” issue.

Known Issues

The 2 stage pipeline will not be applied if running on device is based on 4.1.0 or older runtime.

The scale of WVR_HandJointData_t is always fixed to 1, but not custmizable or dynamic, until next runtime update.

When apply WVR_SetOverfillRatio with higher ratio, the more decline of quality on overlay.

The partial texture layout can’t work in multi-layer and the API WVR_SubmitFrameLayers.

There is slight blue edges are on the right and bottom of the display.

Unity

Added

Supports WVR_TriggerVibrationScale.

Added controller animation.

Added rendering on/off events.

Added scale of hand model.

Unreal

Added

Added TriggerVibrationScale.

Added controller animation.

Added rendering on/off events.

Added scale of hand model.

Known Issues

[UE4.25] Build with Android Target 29 and 64bit will crash because ensure will cause crash. [Issue of Unreal]

Does not support IME in the current version.

[UE4.24/25] On devices that do not support Multi-Layers, content rendered by DefaultStereoLayers is wrong in shipping builds. [Unreal Issue]

[UE4.25] In 32-bit shipping builds, using Stereo Layers may cause the application to crash.

[UE4.24] MotionController is deprecated. Please replace them with our Input Blueprint. For more details, see Controller Buttons.

[UE4.24] Crash while open level many times in shipping build. The workaround for this is to select Source Type of Light in SkyLight as SLS_Specified_Cubemap and avoid selecting SLS_Capture_Scene.

[UE4.26] 32-bit builds may encounter an issue where abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

Release 4.1.0¶

SDK

Added

Added Hand Tracking/Interaction support.

Added new API WVR_TriggerVibrationScale.

Changes

Support Arena Changed event on app side.

Bug fixes

Fixed “Screenshot/Recording/Casting happens black rarely” issue.

Known Issues

When apply WVR_SetOverfillRatio with higher ratio, the more decline of quality on overlay.

The partial texture layout can’t work in multi-layer and the API WVR_SubmitFrameLayers.

Unity

Added

Added new menu item for enabling hand tracking feature.

Unreal

Added

Added new project setting “Enable Hand Tracking”.

Known Issues

[UE4.25] Build with Android Target 29 and 64bit will crash because ensure will cause crash. [Issue of Unreal]

Does not support IME in the current version.

[UE4.24/25] On devices that do not support Multi-Layers, content rendered by DefaultStereoLayers is wrong in shipping builds. [Unreal Issue]

[UE4.25] In 32-bit shipping builds, using Stereo Layers may cause the application to crash.

[UE4.24] MotionController is deprecated. Please replace them with our Input Blueprint. For more details, see Controller Buttons.

[UE4.24] Crash while open level many times in shipping build. The workaround for this is to select Source Type of Light in SkyLight as SLS_Specified_Cubemap and avoid selecting SLS_Capture_Scene.

[UE4.26] 32-bit builds may encounter an issue where abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

Release 4.0.0¶

r.39¶

SDK

Changes

Reduced passthrough latency.

Bug fixes

Fixed an edge case where boundary of virtual wall disappears.

Known Issues

When apply WVR_SetOverfillRatio with higher ratio, the more decline of quality on overlay.

The partial texture layout can’t work in multi-layer and the API WVR_SubmitFrameLayers.

Unity

Removed

Removed function wrappers of deprecated APIs.

Bug fixes

Fixed Direct Preview server installation failure.

Fixed Occlusion Separation Sphere issue.

Fixed Multi-Layer Preview null reference issue.

Unreal Engine

Bug fixes

Fixed Multi-Layer crash issue on UE 4.25 (32-bit, Shipping Build).

r.28¶

SDK

Added

New feature Adaptive Quality 3.0 which can be configured in Unity/Unreal.

New feature multi-layer and the new API WVR_SubmitFrameLayers.

New feature TimeWarp Stabilization Mode and the new API WVR_EnableTimeWarpStabilizedMode.

New feature Performance HUD 2.0 and the new setting tool.

New API WVR_GetPredictedDisplayTime.

Added new InputId_Alias1_X, InputId_Alias1_Y and InputId_Alias1_Parking in WVR_InputId definition.

Add WVR_EventType_InputDevMappingChanged in WVR_EventType when input device mapping changed.

Added three new APIs (WVR_SetControllerPoseMode, WVR_GetControllerPoseMode, WVR_GetControllerPoseModeOffset) and Controller configuration (Controller Pose Mode) for Controller Orientation feature.

Add new event WVR_EventType_ArenaChanged to inform play area range was changed

Removed

Removed WVR_SetArena API.

Removed WVR_SetInteractionMode API.

Removed Camera SDK.

Known Issues

When apply WVR_SetOverfillRatio with higher ratio, the more decline of quality on overlay.

The partial texture layout can’t work in multi-layer and the API WVR_SubmitFrameLayers.

Unity

Changes

Change the dependency in the development environment, ap will not encounter build problem when ap and wave sdk use the same library with different version.

Refine the Interaction Mode related features.

Provides the XR plugin pinch origin/direction temporary achievement.

Enable Adaptive Quality Mode.

ControllerTips Improvement.

Added Bundle Preview for Unity XR SDK.

Added

[Important] Added Controller Orientation feature. Pose mode is set to panel oriented mode by default, and is different from the raw pose provided previously.

Added Direct Preview support to XR Plugin.

Added the AMC which is an experimental feature. Wave provide the Adaptive Motion Compensation to help present smoothly within low FPS condition.

Supports the com.unity.inputsystem.

Added Wave Loader feature.

Added DynamicFR sample and documentation to demonstrate a special use case that combines FoveatedRendering with HMD motion, which can help balance quality and performance.

Added feature TimeWarpStabilizedMode.

Support the Parking button.

Added Multi-Layer support (CompositorLayer feature pack).

Removed

Removed WVR_SetInteractionMode API.

Removed Camera Texture APIs and removed related samples.

Known Issues

The device list retrieved from InputDevices.GetDevices may be incorrect when a device disconnected. Please use CommonUsages.isTracked instead to check a device’s connection.

Cylinder shaped Multi-Layer have an aliasing effect when camera is located inside the arc.

Unreal Engine

Added

[Important] Added Controller Orientation feature. Pose mode is set to panel oriented mode by default, and is different from the raw pose provided previously.

[Important] Added WaveVRInputManager in C++ and Blueprint.

Added feature TimeWarpStabilizedMode.

Support RenderDoc

Support the Parking button.

Support Pixel Density. Please use it just for initial settings. Don’t change it many times or you might encounter crash due to memory leak.

Added Wave Loader feature.

Added Stereo Layer support through Multi-Layer.

Added WaveVRControllerModel.

Added AMC feature (experimental). Wave provide the Adaptive Motion Compensation to help present smoothly within low FPS condition.

Added DynamicFR sample and documentation to demonstrate a special use case that combines FoveatedRendering with HMD motion, which can help balance quality and performance.

Support Android SDK API level 29.

DirectPreview support multiple devices’ render model.

Added UE 4.26 support.

Changes

Enable Adaptive Quality Mode. FoveatedRendering will be overridden if AutoFoveation is set.

Declare AdaptiveController, AdaptiveControllerLoader, WaveVRJson as Deprecated.

Debug canvas can be displayed when Mobile Multi-View is enabled with the device which support Multi-Layer.

Adjust shading model to unlit for button effect.

Apply IWYU which will increase build speed.

Set the default interaction button of WaveVR_Pawn to Touchpad + Trigger + Thumbstick.

Rename input modules.

WaveVRGazeInput -> WaveVRGazePointer

WaveVRControllerInput -> WaveVRControllerPointer

Removed

[Important] Removed the WVR_SetInteractionMode function.

Removed Camera Texture APIs and removed related samples.

Bug fixes

Fixed “DoF of Controller will show 3Dof while connecting 6Dof device” issue.

Fixed “The debug canvas shows in upside down manner” issue.

Known Issues

[UE4.25] Build with Android Target 29 and 64bit will crash because ensure will cause crash. [Issue of Unreal]

Does not support IME in the current version.

[UE4.24/25] On devices that do not support Multi-Layers, content rendered by DefaultStereoLayers is wrong in shipping builds. [Unreal Issue]

[UE4.25] In 32-bit shipping builds, using Stereo Layers may cause the application to crash.

[UE4.24] MotionController is deprecated. Please replace them with our Input Blueprint. For more details, see Controller Buttons.

[UE4.24] Crash while open level many times in shipping build. The workaround for this is to select Source Type of Light in SkyLight as SLS_Specified_Cubemap and avoid selecting SLS_Capture_Scene.

[UE4.26] 32-bit builds may encounter an issue where abnormal black shadows are rendered and the application may crash when encountering this issue. Choose 64-bit to avoid this issue.

Release 3.2.0¶

SDK

Changes

The feature Adaptive Quality and Foveated Rendering are enabled by default.

API WVR_EnableAdaptiveQuality interface changed. A new optional parameter is added for setting the strategies.

Renamed WVR_InputId_9 alias mapping from WVR_InputId_Alias1_Digital_Trigger to WVR_InputId_Alias1_Bumper.

Import library method changes to import repository, To see details Import repository

Added

Added new InputId_Alias1_A and InputId_Alias1_B in WVR_InputId definition.

Add hand tracking and gesture API. (Next release version may change API, if change API developer need to rebuild AP and Hand DeviceService.)

A new strategy Auto-Foveation of Adaptive Quality is added. please check WVR_EnableAdaptiveQuality .

Deprected WVR_RenderFoveation , please use new API WVR_RenderFoveationMode instead.

Add WVR_IsRenderFoveationDefaultOn , WVR_IsRenderFoveationEnabled , WVR_SetFoveationConfig and WVR_GetFoveationDefaultConfig for flexible usage.

Add new API WVR Supported Features to get device supported features.

Add Pass-Through feature by providing new APIs WVR_ShowPassthroughOverlay and WVR_EnableAutoPassthrough . Be sure to check first if this platform support Pass-Through by calling WVR Supported Features .

The Overlay supports right and left eye with different Overlay contents.

The native developer can use self-created context and SurfaceView by using WVR_GraphicsParams_t in WVR_RenderInit and hookNativeSurface in VRActivity .

The Native developer can get current used controller model. Please check wvr_ctrller_render_model header WVR Controller Model .

Removed

Remove unused enmeration of WVR_AppType_NonVRContent.

Bug fixes

Fix 6DoF controller auto role change issue that application does controller role change without check controllers poses ready. Before do auto role change, check both hmd, two controllers are connected and supported 6DoF.

Fix the bug that android camera image doesn’t handle the image has stride part.

Fix memory leakage on WVR_GetInputButtonState, WVR_GetInputTouchState, WVR_GetInputAnalogAxis and WVR_GetInputDeviceState.

Fix WVR_SetInputRequest failed in Arabic and Hindi.

Pluginkit SDK

Changes

Import library method changes to import repository, To see details Import repository

Added

Added new InputId_Alias1_A and InputId_Alias1_B in WVR_InputId definition for controller device.

Added thumbstick features, only the pluginkit SDK which version is equal or greater than 3.2.0 supports the thumbsticks.

Added swipe motion thresholds “maxSwipePoint”, “minSwipeLength” and “edgeTriggerArea” for two-dimensional components.

Added InputId_Alias1_Bumper definition

Removed

Remove three classes “VRCameraInterface”, “VRCameraData” and “VRCameraHandle” related to camera pluginkit implementation.

Remove class “ControllerRoleListener” and controller role change related function in ControllerDevice.

Remove InputId_Alias1_Digital_Trigger definition

Component SDK

Added

Add hand tracker and hand gesture related classes for hand detection developer. (Next release version may change API, if change API developer need to rebuild AP and Hand DeviceService.)

Unity

Added

Added Gesture feature.

Added new API WVR_GetSupportedFeatures.

Added new Enum WVR_SupportedFeature.

Added new API “GetVectorFromGL” in WaveVR_Utils.cs.

Added “V3Velocity” and “V3AngularVelocity” for the Unity coordinate information.

Added supporting for bumper key.

Added WaveVR_AutoLayout feature.

Added Bundle Preview feature.

Added Shader Stripping feature.

Added Unity XR Plug-in Framework support.

Changes

Changed the behavior of connection status & pose state update. To handle the duplicated events once.

[Important] Replace all “internal” type variables with “private” type in WaveVR_Controller.cs.

Only the “public” type variable should be accessed from static class reference. Including below parameters: - _connected - pose - rtPose - vel - aVel - axis - state - pre_state

Improve CameraTexture performance.

Added resolution scale lower bound to WaveVR_DynamicResolution

WaveVR_FoveatedRendering component in WaveVR Prefab is now enabled by default

Bug Fixes

Can show both controller beams when EnableSingleBeam is false.

Gaze can focus on Dropdown List and multi-layer GUI now.

InputModuleManager will stop working while losing the system focus now.

Removed

Set the “velocity” and “AngularVelocity” variables of WaveVR_Controller.cs to obsolete.

Removed supporting for DigitalTrigger Key.

WaveVR_ButtonList will be deprecated. Please use WaveVR_ButtonManager instead.

Known Issues

Gaze cannot interact with the ScrollView UGUI. This problem will be fixed in next release.

Keep touching the Touchpad or Trigger button. Click the button to reload/change current scene and keep touching the button after click. The button will NOT have the touch state.

Sometime the auto-role-change does NOT become effective. After reconnecting both Chirps in the situation, the beam will be along with a different controller.

Unreal Engine

Added

Added LateUpdate HMD feature. It saves more usable time in both game and render thread to use.

Added Gesture feature.

Added Direct Preview feature and substitute it for InstantPlay.

Added Gaze enter and exit interaction interface events for 3D objects.

Added tooltips for blueprint APIs.

Added blueprint function - SetParameters.

Changes

Enable AdaptiveQuality by default in WaveVR project settings.

Refine RenderMask’s initial flow.

RenderMask requires LateUpdate to be disabled to work.

Refine the Gesture.

Do not update the bone location when the bone pose is invalid and remove redundant blueprints.

Refine the Gesture interface for core change.

[Important] Removed Digital Trigger key. Added thumbstick and Bumper key. Bumper key (Finch controller only) can be enabled in ControllerLoader.

Attach spawned controller model to ControllerLoader’s parent and update relative pose.

Support Foveation Mode and config Default mode by default in WaveVR project settings.

WaveVR now works as a project plugin (WVR is not a third-party module anymore).

Refine the Render Mask enable and disable options.

Complete Adaptive Quality features, SendQualityEvent and AutoFoveation.

Removed

Removed deprecated (and already not used) AdaptiveControllerBP.

[Important] Removed all APIs in the category “WaveVR|Coordinate|Unity”.

Bug fixes

Fixed “[PIE] The InputModuleManager cannot work when OverrideSystemDefault has not been selected” issue.

Fixed “Head pose will recenter when the current app is forcibly closed by long pressing the home button” issue.

Fixed “The battery status shown is abnormal when the app is in left-handed mode” issue.

Fixed “The app will hang at the beginning of launching” issue.

Known Issues

Does not support IME in the current version.

[UE4.24] MotionController is deprecated. Please replace them with our Input Blueprint. For details, see Controller Buttons.

[UE4.24] Crash while open level many times in shipping build. The workaround for this is to select Source Type of Light in SkyLight as SLS_Specified_Cubemap and avoid selecting SLS_Capture_Scene.

Update 1¶

Unity

Added

Added Button A/B/X/Y support.

Added CR model assets and default load when render model is CR.

(XR Plugin) Mapping Wave Grip Axis to Unity input feature “grip”.

(XR Plugin) Added Custom Android Manifest feature.

Bug fixes

Fixed “Might see controller juddering even when the rendering FPS is at target framerate” issue.

Unreal Engine

Added

Added Button A/B/X/Y support.

Added CR model assets and default load when render model is CR.

Bug fixes

Fixed “Might see controller juddering even when the rendering FPS is at target framerate” issue.

Release 3.1.6¶

Unity

Changes

Update dpServer to 0.4.5.3 due to expiration date.

Bug fixes

Direct Preview failed to open.

Extension Method Collision with SteamVR.

Avoid potential null reference and GC.

Unreal

Bug fixes

Fixed “RenderMask cause crash” issue.

Known Issues

Do not support IME in current version.

Release 3.1.4¶

SDK

Changes

Improve the performance of system recording for device maker.

Bug fixes

Fix bugs of the Adaptive Quality.

Fix bugs for input device mapping failure when input device not support volum up/down. Need to update wave_server.apk to solve this issue.

Fix bugs which may result in present right eye image to both eyes when applying partial texture and present with different left/right eye uv values.

Known Issues

Pluginkit SDK

Bug fixes

Enhance device config data (disableVirtualDpad) let this configuration data can work if didn’t use setVirtualDpadSupport to enable disableVirtualDpad.

Unity

Changes

Remove emulation-switching in DirectPreview options.

Not to export log to file of DirectPreview Server.

Set default Auto Graphics API false and Graphics Apis OpenGLES3.

Improve DirectPreview stability.

Bug fixes

Fixed foveation function not working in IL2CPP build.

Unreal

Bug fixes

Fixed “The battery did not show when controller is in left-handed mode” issue.

Fixed “Z-Fighting problem” by following the NearClippingPlane value in Project Settings.

Fixed Unreal presenting the right eye image to both eyes if disable MultiView feature.

Known Issues

Do not support IME in current version.

Release 3.1.1¶

SDK

Changes

Renamed SDK API from WVR_TriggerVibrator to WVR_TriggerVibration.

Simplify WVR_RenderConfig enum which contains WVR_RenderConfig_Default, WVR_RenderConfig_Disable_SingleBuffer, WVR_RenderConfig_Disable_Reprojection and WVR_RenderConfig_sRGB.

WVR_GetSyncPose will no longer be blocked by vsync, instead, WVR_SubmitFrame will not return until the next vsync middle is coming.

Fixed the issue that controller icons would be on the wrong side when the controller devices turned on.

Added

Added new SDK API WVR_SetPosePredictEnabled for APP to have predicted HMD’s position, and Controllers’ rotation & position. HMD’s rotation prediction is always on. Note Pose Prediction.

Added new InputId_Alias1_Back in WVR_InputId definition for controller device.

Added How to support 64-bit VR APP and 64 bit Support Limitation.

Add WVR_SubmitExtend_PartialTexture in WVR_SubmitExtend enum and WVR_TextureLayout_t in WVR_TextureParams_t. It can specify the region of submitting texture.

Support different kind of texture target by adding WVR_TextureTarget_2D_DUAL, WVR_TextureTarget_2D_EXT_DUAL and WVR_TextureTarget_VULKAN in WVR_TextureTarget enum.

Add AdaptiveQuality 1.0. It can change CPU and GPU clock dynamically by calling WVR_EnableAdaptiveQuality . Using WVR_IsAdaptiveQualityEnabled to check if platform supports.

Add WVR_EventType_RecommendedQuality_Lower and WVR_EventType_RecommendedQuality_Higher in WVR_EventType. They are used to inform developer to change quality when AdaptiveQuality enabled.

Support submitting VkImage. Please check wvr_vulkan header.

Disable watchdog when debug build.

Release performance HUD tool. Performance Profiling.

Support fade-out current Activity. Fade current Activity.

Release performance HUD2 tool. Performance Profiling.

Bug fixes

Fixed app crashed issue when app invokes onDestroy() more than once.

Fixed bug and return error when starting camera before App resuming.

Fixed Unity 2018.3 and later may crash because of allowing EGL_KHR_no_config_context.

Known Issues

Performance HUD tool does not support Unreal in this version.

Pluginkit SDK

Added

Added new Config supportedPositionPrediction. Only if true, WVR_SetPosePredictEnabled is able to predict for that device over position.

Added new Config supportedRotationPrediction. Only if true, WVR_SetPosePredictEnabled is able to predict for that device over rotation.

Added new InputId_Alias1_Back in WVR_InputId definition.

Added How to support 64-bit VR Device and 64 bit Support Limitation.

Added new Config “maxSwipePoints”, “minSwipeLength” as the threshold to trigger swipe events.

Unity

Added

Support Co-existence with DayDream and Oculus.

Added Direct Preview feature(Alpha version).

Added Customized AndroidManifest.xml folder at “Assets/WaveVR/Platform/Android/Customize/”.

WaveVR_PermissionManager added new api for requestUsbPermission.

WaveVR_Utils added GetControllerName API.

Allow developer to adjust resolution in runtime.

[Important] Added Scripts/EventSystem/WaveVR_GazeInputModule.cs.

Added 64 bit Support.

Added AdaptiveQuality feature and provide related APIs.

Stereo Rendering mode can switch between SinglePass and MultiPass at runtime. Switch need reset the WaveVR_Render or just use different “WaveVR” prefab.

Change

Do NOT allow gameObject with WaveVR_ControllerLoader to be set as controller in InputModuleManager.

Improve WaveVR_Camera performance in SinglePass.

Use GL.Clear() to replace LoadingCanvas.

Developer can specify background color for the loading period.

Set gaze to timer trigger if WaveVRButtons is not put in scene.

Due to 2.1.8 and older server device service key table is wrong, needing to check capability of key mapping table.

[Important] WaveVR_InputModuleManager.cs and InputModuleManager prefab are changed. If developer used

WaveVR_InputModuleManager script in custom object,

2) InputModuleManager prefab in custom scene, developer would need to check the parameters of WaveVR_InputModuleManager & InputModuleManager in new SDK.

Move logic of reading OEM CONFIG of Beam&Pointer to ControllerLoader.

If no controller connected and hmd enter button is unavailable, set Gaze to timger trigger.

If there is only 1 controller and type is not focus, controller beam & pointer will be hidden by WaveVR_PoseTrackerManager.

ControllerInstanceManager apply config of enabling single beam logic

Change android targetSdkVersion to 26 and Unity 5.6 is no longer supported.

[Important]Refine the button usage in scripts.

Remove class WaveVR_ControllerInputModule.EControllerButtons, use WaveVR_ButtonList.EButtons instead.

Remove volume keys from WaveVR_ButtonList.EButtons due to volume evens are enabled by default if device has volume keys and cannot be disabled.

Remove WaveVR_InputModuleManager.OtherButtonToTrigger and WaveVR_ControllerInputModule.OtherButtonToTrigger due to its bad usage in architecture.

Change WaveVR_InputModuleManager.ButtonToTrigger and WaveVR_ControllerInputModule.ButtonToTrigger to List<WaveVR_ButtonList.EButtons>

Always overrides system settings of controller beam & pointer in ControllerLoader.

Bug fixes

WaveVR_ControllerPointer fixed an issue that used a shared mesh in Unity built-in Quad to edit, instead of editing a copy object.

WaveVR_ControllerLoader fixed exception by zero reset memory after alloc.

Fixed controller pose is unexpected high in “InteractionMode Test” test scene.

WaveVR_RenderModel loads default model when we cant find FBX from device service.

Fixed controller is shown in gaze mode.

Removed

WaveVR_ControlelrLoader removed menu of asset bundle creating.

[Important] Set Scripts/Extra/GazeInputModule.cs to obsoleted.

Unreal

Changes

Change android TargetSDKVersion to 26.

Apply WaveVROEMConfig APIs on AdaptiveController, ControllerInstanceManager, LinePointer, RenderModel.

Change WaveVRGetKeyValue API to WaveVR|OEMCONFIG API in WaveVR_Pawn.

Override GameActivity.finish() to quit android application.

Reset button states if device is disconnected.

If no controller connected and hmd enter button is unavailable, set Gaze to timer trigger. - Refine WaveVR_Pawn gaze feature. - Add function IsButtonAvailable().

Replace WVR_TriggerVibrator with WVR_TriggerVibration due to the change of wvr api.

Added

Support MultiView and MultiView(Direct). Developer need choose GLES3.0 only in Unreal Project Settings when using MultiView.

Support MultiSample 1~4X.

Support arm64 build.

Support custom multiple buttons for interaction click event.

Added BP function SetPosePredictEnabled.

Added WaveVROEMConfig class and APIs.

Added WaveVR_IsEnableSingleBeam API.

Added Software IPD feature.

Added RenderMask feature.

Added HMD Back key in button event & Unreal Input.

Added Thumbstick to Unreal Input.

Added AdaptiveQuality feature and provide related APIs.

Added requestUsbPermission API to support OTG device.

Removed

Set WaveVRJson APIs to deprecated.

Set IsBatteryInfo API to deprecated.

Removed Digital Trigger from Unreal Input since it won’t be SetInputRequest

Bug fixes

Fixed “warm start HelloVR will show grey band in middle of screen” issue.

Fixed “Controllers disappear while teleport” issue.

Fixed HomeKey name in Chinese.

Known Issues

Do not support IME in current version.

Release 3.0.2¶

SDK

Changes

Renamed SDK API from WVR_GetDeviceErrorStatus to WVR_GetDeviceErrorState. WVR_GetDeviceErrorState queries the abnormal state whether is existed on the device.

Rename SDK folder name and apk name. To see details SDK Folder Change List.

Refined WVR_AnalogType name and id, please check the enum definition in file wvr_devices.h for detail.

Changed from WVR_AnalogType_TouchPad to WVR_AnalogType_2D

Changed from WVR_AnalogType_Trigger to WVR_AnalogType_1D

Enable render Mask with Texture Target. Please refer to WVR_RenderMask.

Added

WVR_SetInputRequest MUST be invoked after WVR_Init otherwise the app can NOT receive any key events from WAVE SDK 3.0 and later. To see detail.

Added new SDK API WVR_GetInputMappingPair and WVR_GetInputMappingTable to get input device mapping result.

Added new SDK API WVR_GetInputDeviceAnalogType to get input device analog type.

Added new SDK API WVR_SetArmModel for APP to have simulated controller position with Arm Model, also a SDK API WVR_SetArmSticky to customize its behavior.

Added new SDK API WVR_SetNeckModel for APP to have simulated HMD position with Neck Model.

Added new WVR_InputId_Alias1_Enter and WVR_InputId_Alias1_Thumbstick in WVR_InputId definition.

Added a checkpoint for checking the positions of controllers to adjust controller roles when client got the pose ready event.

Support fixed foveation rendering. Please refer to WVR_RenderFoveation API.

Support overfill function. Please refer to WVR_SetOverfillRatio .

Support submit EGLImage directly.

Support submit frame without doing distortion correction.

Disable screenshot/cast if application set window to FLAG_SECURE.

Support OEM performance module for device maker to config performance based on Application request.

Known Issues

When we press the trigger button, the light blue effect of trigger key won’t show in app built with the SDK before version 2.1.8 or earlier.

Unreal app is not supported for pressing HMD volume button to do unpair controller, need to go back to launcher or other unity app to do unpair controller operation.

Plugin faceplate and switch device service to finch controller and connect finch with HMD, finch controller will be disconnected with HMD when unplug faceplate and there is no controller scanner in the scene, need to umount and mount HMD again to recover.

Bug fixes

Add error handling when bit table is invalid.

Fixed the issue of updating setting table from settings AP while system is setting the dominant hand.

Unity

Changes

[Important] Getting runtime status is changed:

Real Connection:

Passive: developer can listen to event WaveVR_Utils.Event.ALL_VREVENT to get the connection status of Head, Dominant Controller and NonDominant Controller

Proactive: developer should use WaveVR_Controller.Input().connected to get the connection status of Head, Dominant Controller and NonDominant Controller

Valid Pose:

Passive: developer can listen to event WaveVR_Utils.Event.DEVICE_CONNECTED to check whether the pose of Head, Dominant Controller and NonDominant Controller is valid.

Proactive: developer should use WaveVR.Instance.getDeviceByType ().connected to check whether the pose of Head, Dominant Controller and NonDominant Controller is valid.

Left-Handed Mode:

Passive: developer can listen to event WaveVR_Utils.Event.DEVICE_ROLE_CHANGED to get the device role change event.

Proactive: developer should use WaveVR_Controller.IsLeftHanded to check left-handed mode. (True: left-handed)

Assume developer uses InputModuleManager and set parameters as below:

Custom Input Module: Gaze

BtnController: True (means using controller button to controll)

With Time Gaze: False (means no timer)

In runtime, if controller disconnected, Gaze module would use timer.

Set HMD enter button to trigger Gaze as default.

[Important] wvr.cs is changed:

Added API WVR_GetInputDeviceAnalogType

Added API WVR_SetNeckModel

Added API WVR_SetArmModel

Added API WVR_SetArmSticky

Added API WVR_SetInputRequest

Added API WVR_GetInputMappingPair

Added API WVR_GetInputMappingTable

Added API WVR_GetDeviceErrorState

Added API WVR_IsRenderFoveationSupport

Added API WVR_RenderFoveation

Removed API WVR_GetDeviceErrorStatus

Added enum WVR_PeripheralQuality

Added enum WVR_DeviceErrorState

Added enum WVR_SimulationType

Changed enum WVR_DeviceType

Changed enum WVR_InputId

Changed enum WVR_AnalogType

Changed enum WVR_ScreenshotMode

Changed enum WVR_SubmitExtend

Changed enum WVR_Eye

Added struct WVR_InputAttribute_t

Added struct WVR_InputMappingPair_t

Added struct WVR_RenderFoveationParams

[Important] Change Unity plugin device type.

From SDK3.0, developer will not see type “right” or “left” in component inspector. Instead, the device type will be “Dominant” or “NonDominant”. In right-handed mode, the “Dominant” hand will be right device. In left-handed mode, the “Dominant” hand will be left device. Here is the change file list. If developer used these files of previous version SDK to make customized prefabs, developer would have to check the value of fields in prefabs due to old types are removed from SDK3.0

Extra/GazeInputModule.cs

Extra/FollowTransform.cs

WaveVR.cs

WaveVR_AdaptiveControllerActions.cs

WaveVR_Beam.cs

WaveVR_Controller.cs

WaveVR_ControllerInputModule.cs

WaveVR_ControllerInstanceManager.cs

WaveVR_ControllerListener.cs (this file is obselete)

WaveVR_ControllerLoader.cs

WaveVR_ControllerManager.cs and its client function SetDeviceIndex

WaveVR_ControllerPointer.cs

WaveVR_ControllerPoseTracker.cs

WaveVR_ControllerRootToEmitter.cs

WaveVR_DevicePoseTracker.cs

WaveVR_EventSystemControllerProvider.cs

WaveVR_InputModuleManager.cs

WaveVR_PointerCameraTracker.cs

WaveVR_PoseTrackerManager.cs

WaveVR_RenderModel.cs

WaveVR_Reticle.cs

WaveVR_SetAsEventSystemController.cs

WaveVR_TrackedButtons.cs

[Important] added / removed parameters and changed name of parameters of Prefab:

Beam.prefab

ControllerLoader.prefab

ControllerPointer.prefab

InputModuleManager.prefab

Developer should check local customized prefabs.

[Important] changed public variables name of Script:

WaveVR_ControllerLoader.cs

WaveVR_Beam.cs

WaveVR_ControllerPointer.cs

Developer should check source code to which is related.

In ControllerLoader.prefab, developer can customize beam & pointer.

WaveVR_Beam.cs and WaveVR_ControllerPointer.cs is unbundled from WaveVR event system.

Developer can not set raycast mode and related settings in WaveVR_Beam and WaveVR_ControllerPointer anymore. Developer should review related source code about using WaveVR_Beam and WaveVR_ControllerPointer.

Send DEVICE_ROLE_CHANGED broadcast only when resuming and receving WVR_EventType_DeviceRoleChanged event

In Mouse mode, use WaveVR_Render.Instance.righteye as right camera position, WaveVR_Render.Instance.lefteye as left camera position.

Refine button behaviour of WaveVR_ButtonList & WaveVR_Controller

Input ID 1~15: provide press event only.

Input ID 16~18: provide press & touch event / axis.

Send OEM_CONFIG_CHANGED event if runtime config value has been changed.

Move VR Support check and symbol define addition to WaveVR_RenderBuildPecessor. Because the BuildCheck.cs might be removed by developer. :>

In WaveVR_Settings, add more description for VR SinglePass.

WaveVR_Render remove unused Gaze option, and refine CenterCamera.

CenterCamera no need be modified to narrow viewport when playing because the Gaze won’t need it any more. When Playing, disable the CenterCamera.

The attached camera is not required by WaveVR_Render.

WaveVR_Render inspector has more settings and is able to set customized camera. If set, WaveVR_Render will not create new camera when expand stage.

Updated all controller tips for supported language.

Rename some unity files.

rename wavevr_internal.aar to wvr_internal.aar

rename wavevr_pidemo.aar to wvr_pidemo.aar

rename wavevr_resdemo.aar to wvr_resdemo.aar

rename wavevr_resindicator.aar to wvr_resindicator.aar

rename wavevr_unity_plugin.aar to wvr_unity_plugin.aar

rename wavevr_unity_plugin_2017.aar to wvr_unity_plugin_2017.aar

rename WaveVR.unitypackage to wvr_unity_sdk.unitypackage

rename Sample.unitypackage to wvr_unity_samples.unitypackage

rename WaveVR_SimulatorServer.apk to wvr_plugins_simulator_server.apk

rename HelloVRUnity.apk to wvr_unity_hellovr.apk

rename VRTestAppUnity.apk to wvr_unity_vrtestapp.apk

Added

Added press-effect support for Grip, DPad_Left, DPad_Up, DPad_Down, DPad_Right, Trigger.

Added support for custom ButtonList and InputMapping.

Added ControllerInstanceManager to manage event, beam, pointer of controller instances.

There are different behavior in client application build with SDK 3.0.2 runs on different version of WaveVR runtime.

Application + runtime 3.0.2 - All applications are aligned focus controller.

Application + runtime 2.1.8 or older - Every application has its owned focus controller and isn’t sync with other applications.

If you are using application built with SDK 2.1.8 or older

Both 2 controllers are focus controller (able to interact with other objects/actors).

Controller loader added support for FBX format.

The loading priority is below: 1. FBX 2. Assetbundles 3. Client resource 4. Generic model

Added system default controller tips.

[Important] added new Prefab:

WaveVRButtons.prefab

Developer should read documents “Buttons (new in SDK3.0) about button usage.

[Important] add new Script:

WaveVR_ButtonList.cs

Developer should read documents “Buttons (new in SDK3.0) about button usage.

Developer can change WaveVR_Beam settings in runtime

Support of new buttons: WVR_InputId.WVR_InputId_Alias1_Thumbstick & WVR_InputId.WVR_InputId_Alias1_Enter.

Added “OtherButtonToTrigger” in InputModuleManager prefab. Developer can choose multiple buttons to trigger event.

Added “UnityMouseMode” in WaveVR_ControllerInputModule, developer can change the value to let input module behaves like Unity mouse.

New cameras : BothEyes, CenterEye

New Delegates to listen to Camera Expand and status change.

An experimental feature stereo rendering path: SinglePass.

Developer can enable it by WaveVR_Settings (Preference). Old multipass rendering path still available.

A RenderMask support for SinglePass

RenderMask CommandBuffer will set to camera every frame.

Support Foveated Rendering. Use FOV to set the foveated region.

WaveVR prefab added the FoveatedRendering part. Default is disabled in WaveVR prefab.

Added FoveatedRendering prefab. Put it into scene to enable a static foveated rendering. Developer can control it by script.

Added WaveVR_RenderModel.cs to support

merge multiple meshes to one mesh. customize emitter mesh to decide position/rotation of beam/pointer. show battery indicator provided by controller provider. broadcast DS_ASSETS_NOT_FOUND event when FBX is not found.

Added “Controller Tips”, “Controller Instance Manager”, “Render Model”, “ScreenShot”, “RenderMask”, “Teleport”, “Button” tests to VRTestApp.

Added a toggle to enable/disable Simulator and disable simulator by default.

Simulator added controller button support.

Removed

Switch custom hand in runtime.

WaveVR_CavasEye are modified for new WaveVR_Render architecture.

WaveVR_CavasEye can be only available in MultiPass. Suggest not to use.

Removed “VirtualWall_test” scene in unity test app.

Set WaveVR_TrackedButtons to obseleted interface.

Bug fixes

Let touch dot effect more floating to touchpad.

Fixed ControllerLoader memory leakage.

Fixed “Get InputButtonState/InputTouchState did not work when use simulator” issue.

Fixed Assets/Plugins/WaveVR_Simulator.dll not found in some computers.

Fixed null reference exception when no focus window.

Known Issues

When we press the trigger button, the light blue effect of trigger key won’t show in app built with the SDK before version 2.1.8 or earlier.

If play switches beam during casting to an object, the object will not receive event from origin controller anymore.

Use ControllerLoader prefab and uncheck “Track Position”. Even if ControllerLoader has parent with any position, the controller position will always be (0, 0, 0)

Use WaveVR_PoseTrackerManager.cs standalone at a GameObject and set the “Track Timing” to “When Update”. The children objects of the GameObject will be hidden.

Sometimes controller pointer will change after unplugging / plugging faceplate on Head Mount Device with SDK2.1.8 ROM.

Unreal

Changes

Upgrade to Unreal Engine version 4.21.

Changed spawn controller model from AdaptiveControllerBP to WaveVR_AdaptiveController, WaveVR_RenderModel, WaveVR_LinePointer.

Added WaveVR_AdaptiveController blueprint to replace AdaptiveControllerBP’s function of Pose/Event.

Added WaveVR_LinePointer blueprint to replace AdaptiveControllerBP’s function of beam/pointer.

Support line and pointer starting from custom emitter.

Support enable/disable line/pointer option.

Added WaveVR_RenderModel blueprint to replace AdaptiveControllerBP’s function of model/effect.

Merge multiple meshes to one bone.

Support battery indicator

Support custom emitter.

Support reading touchpad information.

Support auto key mapping.

Changed controller model position from Cast to WaveVR_pawn location to the location output to “get Wave VRInput Device Position” which is set to HMD.

Update generic controller model.

Refine button behaviour

Input ID 1~15: provide press event only.

Input ID 16~18: provide press & touch event / axis.

Developer can get all button events from WaveVREventCommon

Change simulation pose options from true/false to force/no/when no position

Hide controller when invalid pose.

Apply texture size which derived from WVR_GetRenderTargetSize instead of monitor resolution.

Changed test scenes of VRTestApp.

Added left controller to InputMode_test.

Added sound volume to SeaOfCube_test.

wvr_device.h: enum WVR_SimulationType values are changed.

Rename vr.permission.client.aar to wvr_permission_client.aar

Rename simulator apk from WaveVR_SimulatorServer.apk to wvr_plugins_simulator_server.apk.

Added

Added ControllerInstanceManager to manage beam/pointer and event.

There are different behavior in client application build with SDK 3.0.2 runs on different version of WaveVR runtime.

Application + runtime 3.0.2 - All applications are aligned focus controller.

Application + runtime 2.1.8 or older - Every application has its owned focus controller and isn’t sync with other applications.

If you are using application built with SDK 2.1.8 or older

Both 2 controllers are focus controller (able to interact with other objects/actors).

Added auto reloading meshanism when render model is different.

WaveVR Unreal SDK supports MotionController buttons below:

Touchpad: mapping to MotionController (R/L) Thumbstick

Trigger: mapping to MotionController (R/L) Trigger

Menu: mapping to MotionController (R/L) Facebutton1

DPad Up: mapping to MotionController (R/L) Thumbstick Up

DPad Right: mapping to MotionController (R/L) Thumbstick Right

DPad Down: mapping to MotionController (R/L) Thumbstick Down

DPad Left: mapping to MotionController (R/L) Thumbstick Left

Add TriggerHapticPulse to vibrate controller.

Support for new WVR_InputId.WVR_InputId_Alias1_Enter

Added broadcast of ALL WaveVR button event. (not MotionController)

Provide onConfigChanged callback when runtime OEM Config is changed.

Added new APIs SetTrackingHMDPosition/SetTrackingHMDRotation/IsTrackingHMDPosition/SetTrackingOrigin3Dof.

Added GetTexture2DFromImageFile feature.

Added Splash Screen feature.

Added Foveated Render feature.

Added Screenshot APIs.

Added Splash Screen Test, Forveation Test, Screenshot Test into VRTestApp.

Removed

Remove WaveVRMotionControllerComponent

Deprecated GetNumOfDof/SetNumOfDof.

Deprecated AdaptiveControllerBP blueprints.

Bug fixes

Fixed “Axis did not work when use instant play” issue.

Trigger axis is incorrect.

Axis of Thumbstick & Trigger is incorrect if GetAxis more than 1 time in a frame.

Only one controller can take effect on Widget when both controllers are connected.

The same actor receives the EXIT event from both controllers.

Known Issues

Do not support IME in current version.

Pluginkit SDK

Changes

Modified the build.gradle in device service project, merge grpc related dependencies into vr.pluginkit. Remember to remove the three dependencies “compile ‘io.grpc:grpc-okhttp:0.13.2’, compile ‘io.grpc:grpc-protobuf-nano:0.13.2’, compile ‘io.grpc:grpc-stub:0.13.2’.

Add buttonId capabiity check inside setButtonPress(boolean press, int buttonId, long nanoTime). If the config inside TrackedDevice.Config.supportedButton for the buttonId is set to 1, the function can work.

Add buttonId capabiity check inside setButtonTouch(boolean press, int buttonId, long nanoTime). If the config inside TrackedDevice.Config.supportedTouch for the buttonId is set to 1, the function can work.

Add analogId capabiity check inside updateAnalog(int analogId, PointF axis, long nanoTime). If the config inside TrackedDevice.Config.supportedAnalog for the buttonId is set to 1, the function can work.

Added

Added a new API setErrorState for developers to set or remove the abnormal states which occur by device.

Added a new enumeration “DeviceErrorState” for replacing the original enumeration “DeviceErrorStatus”, which represents the current states of the device - normal or abnormal.

Added new API registerDevice and unregisterDevice to replace getDevices. To see detail.

Added three classes “VRCameraInterface”, “VRCameraData” and “VRCameraHandle” for camera developer. See also Pluginkit_VRCameraInterface.

Added a new field inside TrackedDevcie.Config to represent analog type.

Added new InputId_Alias1_Enter and InputId_Alias1_Thumbstick for InputId definition.

Removed

Removed abstract getDevies function form VRDeviceService

Removed connect and disconnect function form VRDeviceService

Removed abstract isConnected function form VRDevice

Release 2.1.8¶

Hardware

Notice

New 6DoF controller Dev. Kit. has “Trigger” key with analog data. Please handle both “WVR_InputId_Alias1_Trigger” and “WVR_InputId_Alias1_Digital_Trigger” in your content app for the numerous controller types support.

SDK

Bug fixes

Fixed cannot controller MTP overlay sometimes when gaze mode.

Fix server suspend may encounter DS IPC mechanism didn’t suspend.

Fixed the issue that Simple OEMService causes an app crashed because of sending server ready twice.

Fixed controller beam hitting view of overlay but no response.

Fixed black screen when running on specific device (Skyworth).

Fixed ipd change does not update sometimes.

Fixed a crash issue which was occurred when user started or reset an APP.

Fixed cast fail and black screen when running second round WVR_Init

Fixed crash sometimes when using two controllers.

10.Fixed virtual wall sometimes appears on the wrong timing after resuming.

Known Issues

Only one controller can control overlay, such as quick menu, permission dialog and so on.

Unity

Changes

Changed behavior to destroy controller when real device is disconnect or render model name is different.

Changed adaptive loading to support FBX file, export button effect, beam and indicator option to controller loader.

Changed controller tips for zh_cn, zh_tw language.

Added

Show WaveVR relative attributes when building apps.

Interaction add custom hand support.

Add controller tips for RU, CS language.

Removed

Removed the default value of NumDoFHMD, NumDoFController, and NumController in AndroidManifest.xml.

Bug fixes

Fixed ControllerLoader memory leakage by cleaning native mesh.

Fixed TrackedButtons naming conflicted with Steam VR

Fixed Simulator not working when WIFI is connected.

Fixed gazeTriggerType_System value when OverrideSystemDefault is not clicked.

Fixed beam issues:Beam will disappear if beam mode is switched from other mode to mouse mode.Beam in flexible beam mode is NOT flexible.If there are two controllers in scene, only one controller beam changes following beam mode.

Fixed issue of touch dot effect inactive between Apps switch.

Read QualitySettings.activeColorSpace value at game thread to enable development build.

Fixed Build Target group not switch to Android issue in DefaultPreferenceDialog.

Fixed black screen issue after Unity 2018.1.2f1.

Unreal

Changes

Set default values when cast WaveVR_Pawn failed in AdaptiveControllerBP. (no WaveVR_Pawn exists)

Update projection matrix when IPD changed in WVR.

Use Pawn without casting to WaveVRPawn location to spawn controller model.

Set default values when cast WaveVRPawn failed in AdaptiveControllerBP. (no WaveVRPawn exists)

Decouple CameraTexture plugin and sample and refine VRTestApp for camera.

Reset orientation same as runtime pose while take off and on HMD if triggered Teleport.

Do not set pose as 0, pose will be the same as the last valid one when pose is invalid.

Move “Enable Input Simulator” feature from Controller to WaveVR_Pawn

Hide controller when pose is invalid.

Increase the arm model elbow pitch angle from degree 60 to 90.

Added

Add Instant play feature.

Add button event handling to Controller and Gaze for 3D objects of Editor Mode

Add AskWaveVRPawnToTeleport_Event a bool NeedRotateYaw due to we do not make orientation change by default.

Add TouchpadPress event.

Add Enter/Exit event in WaveVR_Pawn for beam mouse mode.

Add VR Mode while run on WVR path to increase performance.

Removed

Remove mouse click event handling in AdaptiveControllerBP.

Remove unhover event from interaction_interface.

Bug fixes

Fix “Gaze will be triggered when switching interaction mode from Controller”

Fix “Show native volume key while run on WVR path”

Fix “Quick Manu cannot show after pause/resume” issue.

Fix “Abnormal Quit” issue by solving assertion message.

Known Issues

Do not support button effect in current version.

Do not support IME in current version.

Do not support WaveVR simulator in current version.

Pluginkit SDK

Changes

Modified VRDevice lifecycle, call onResume/onPause after onStart

Added

Added new pluginkit API setSwipeDistanceThreshold to adjust the minimum movement of swipe motions on touchpad

Release 2.1.0¶

SDK

Changes

WaveVR server supports the functions with API Level 2. See detail in WVR Version Check.

Refined WVR_EventType name and id, please check the enum definition in file wvr_types.h for detail.

Renamed WVR_InputId_9 alias mapping from WVR_InputId_Alias1_Bumper to WVR_InputId_Alias1_Digital_Trigger.

Supports pose reporting velocity and angular velocity.

Supports overlay controller model dynamically loading from device service.

Extend triggering time of Gaze to 3 seconds in overlay.

Enlarge Gaze circle to 1.5 times in overlay.

Added

Added new SDK API WVR_InAppRecenter for APP to make specific recenter within app. Note that the effect of re-center in app will be reset while the app is onPause.

Supports interaction mode to switch controller or gaze content scene. See wvr_device.h for detail.

Supports gaze trigger type to switch timeout or button trigger. See wvr_device.h for detail.

Added WVR_SetPerformanceLevels API for Qualcomm SVR platform.

Added new SDK API WVR_IsOverlayValid to check if overlay release after Android suspended.

Added new SDK API WVR_SetNeckModelEnabled to enable/disable neck model.

Runtime return zero position for 3dof scene AP (WVR_PoseOriginModel_OriginOnHead_3DoF).

Added transition when switch to passenger mode.

Removed

Deprecated WVR_TriggerRecenter API.

Deprecated WVR_TrackingModeEvent_t struct.

Deprecated WVR_Hexagon_t struct.

Bug fixes

Fixed issue of WVR client is no default height for origin on ground.

Fixed App hung when previous App out of boundary.

Fixed jitter and no available texture sometimes when using StereoRenderer.

Fixed black screen when missing properties files in device service.

Fixed App black screen when the second time launching on Mali GPU.

Fixed unity reload scene may cause abnormal when doing miracasting.

Fixed controller cannot rebind after removing bonding.

Fixed loading animation will always show up when user turns on/off virtual wall in more setting.

Fixed the issue of server crash which is caused when server tried to unregister a controller after clearing all devices.

Fixed the performance dropping when enable/disable passenger mode.

Improved the overlay performance.

Fixed scene shaking issue while HMD is static.

Fixed screen mess after APP resumed.

Fixed an issue which would occur recursive execution when system checked the positions of all of devices. This issue would appear that the moment controller role(right hand/left hand) should be exchanged.

Unity

Changes

Replaced button name Bumper with Digital_Trigger.

Replaced keyword trackpad with touchpad.

Replaced WVR_EventType_Settings_Controller with WVR_EventType_DeviceRoleChanged

Supports interaction mode to handle both user settings and system settings by using OverrideSystemSettings flag.

Supports WaveVR Unity Plugin build passed on Unity 2018.

Show generic controller model with old version wavevr service.

Make the controller beam of fixed beam to be solid line and could be adjusted during design stage.

Fine tune Interaction algorithm for System Focus. 1) Disable gaze icon when losing focus. 2) WaveVR_TrackedButtons does not check button state when losing focus.

Update Finch controller model.

Refine algorithm of Interaction Mode and Pose Tracker Manager.

We used 4 variables to determine whether to hide object with pose tracker or not. There are 2 kinds of pose tracked object: (1) Normal object : shown when connected && has system focus && pose updated. (2) Controller : shown when connected && has system focus && pose updated && not Gaze mode.

Hide pose tracked objects on AP start.

Use Gaze.EnableGaze and Controller.EnableController to record custom setting of Input Module.

Use InteractionMode_System to record system setting of Input Module.

Add broadcast of INTERACTION_MODE_CHANGED and SYSTEMFOCUS_CHANGED

Reset interaction mode and gaze trigger type to system settings when disabled (leave scene)

If interaction mode is Gaze only, (1) Hide event controller (including model, beam and pointer), (2) Not influence other GameObjects those are using WaveVR_PoseTrackerManager.

If interaction mode is NOT Gaze only, (1) Show event controller if connected, (2) Not influence other GameObjects.

Change generic controller model to Finch.

Export adaptive loading option.

Using reload scene to apply SetQualityLevel instead of pause/resume for applyExpensiveChanges is true.

Added

Added SetPerformanceLevels function.

Added adaptive loading feature to controller loader. 1st priority is adaptive loading, next is generic model.

Added interaction mode/gaze trigger type.

Hide controller when interaction mode - gaze only.

Support neck model in PoseTrackerManager and DevicePoseTracker.

Added option to toggle adaptive loading.

Support WaveVR simulator in editor.

Removed

Removed Finch/Link/Pico/iQiyi controller model in SDK package.

Removed libwvrDistortion.dll from apks.

Removed the default value of “com.htc.vr.content.NumDoFHmd”, “com.htc.vr.content.NumDoFController”, and “com.htc.vr.content.NumController” from AndroidManifest.xml. Please refer to Configure App Capabilities to know how to configure your content app.

Bug fixes

Fixed an issue which application would be black screen for 20 seconds and then crashed while pressing controller app button after Home button pressed.

Reset button states while controller role change.

Fixed black screen issue when controller role Change.

Fixed AP can’t receive “WVR_EventType_DeviceRoleChanged” event while in background issue.

Do NOT gaze if no system focus.

Correct touch dot effect position.

Reset button state after resume.

Fixed render memory leakage.

Fixed AssetBundleCreate for unity 2018.

Fixed the beam length of other controller mode could not be recovered after switching interface between controller and Gaze.

Fixed null pointer exception if no InputModuleManager in interaction mode.

Controller Input Module still works when no system focus.

Fixed sometimes beam is not controlled.

Fixed GameObject with PointerEnter is not released when controller is hidden.

Fixed when setting OverrideSystemSettings from false to true, interaction mode is not reset to user settings.

Fixed memory leakage of WaveVR_Beam.

Unreal

Changes

Replaced WVR_EventType_Settings_Controller with WVR_EventType_DeviceRoleChanged.

Replaced button name Bumper with Digital_Trigger.

Default disable telepot feature on WaveVR_Pawn.

Changed WVR_Event name to fit SDK.

Corrected camera image format value of CameraTexture.

Reset button states while receive WVR_EventType_DeviceRoleChanged event.

Change reticle color to white.

Change beam color to white.

Upgrade to fit UE4.19.

Export FollowHMD and SimulationPose to controller loader.

Change and refine PermissionManager behavior.

Changed logic to add generic controller model to adaptive controller if resource loading failed.

Changed loaded controller model base on WaveVRPawn location.

Changed button support in PIE to AdaptiveController

Changed the style of spinning reticle and beam of Controller.

Changed generic controller model.

Change interaction mode mechanism.

Upgrade to Unreal Engine version 4.20.

Added

Added permissions for accessing VRSettings.

Added IsInputFocusBySystem condition to avoid showing controller while showing system menu.

Added GetSupportedNumOfDoF/GetNumOfDoF/SetNumOfDoF in Blueprint function library.

Added all common events broadcast.

Added Adaptive Controller Loader feature

Load generic controller model when FBX/PNG reading failed.

Added spinning reticle.

Added AskWRPawnToDispatcher on WaveVRPawn to trigger Teleport.

Default use “touch pad” button to trigger onClick event on Widgets. And automatically trigger holver/unhover by controller beam or gaze.

Added controller mouse mode for widget.

Removed

Removed static function of PermissionManager.

Removed indicator feature of Controller Model.

Remove redundant WaveVRController APIs from Blueprint

Remove all resources of Finch/Link blueprint.

Bug fixes

Fixed “volume key on HMD not work”.

Fixed Hide Controller model logic.

Fixed Gaze point lost focus.

Fixed AP can’t receive “WVR_EventType_DeviceRoleChanged” event while in background.

Fixed local reference overflow of PermissionManager

Fixed touch up / press up event is not received after switching hand.

Fixed “Can’t launch on U11-Link” issue.

Fixed “First frame not updated after doing Teleport immediately” issue

Fixed “Black edge” issue.

Fixed return value of isPermissionGranted.

Fixed adaptive loader crash on API_LEVEL_1 server

Fixed Simulated controller will flash at level starting issue.

Fixed Memory leakage on adaptive loader,camera texture and WaveVRHMD.

Fixed reticle and spinning reticle hidden by scene objects issue.

Fixed “controller model shown with stripes” issue.

Fixed “click event of mouse mode keep be sent when button is pressed continuely.” issue

Fixed “beam is disappeared after move controller behind head and back in front of head” issue

Fixed wrong pose on first frame while doing Teleport.

Fixed warning messages.

Fixed interaction mode is not reset to user settings when setting OverrideSystemSettings from false to true.

Fixed 2D permisssion request issue.

Known Issues

Do not support button effect in current version.

Do not support IME in current version.

Do not support WaveVR simulator in current version.

Pluginkit SDK

Changes

Modified VRDeviceService onBind() must return super.onBind().

Added

Add document of “Configure Device Capabilities” about defining capability of device for filtering app.

Removed

Removed attribute include Attr_IsHWRecenter_Bool and Attr_Is6DoFTracking_Bool.

Release 2.0.37¶

SDK

Fixed “While out-of-boundary, invoking SetArenaVisible to ForceOn virtual wall will cause the scene is black.”

Fixed camera feature cannot work on 3-DoF mode.

Release texture memory while app goes to background.

Inform 6/3Dof Mode change to AP and DeviceService.

Enable miracast + single-eye presentation.

Fixed watchdog timeout on WVR_StartRender.

Change android minSDKVersion to 25.

3/6 DoF mode switch configured by More Settings.

Fixed miracast HMD and TV screen are both abnormal.

Replace WVR_EventType_RecenterSuccess with WVR_EventType_RecenterSuccess_3DoF event when device is 3-DoF or in 3-DoF tracking mode.

Unity

Change controller indicator “Trackpad” -> “Touchpad”.

Add the button control feature to Gaze function.

Reset button state after controller role is changed.

Fix issue: AP does NOT receive role change event while in background.

Release 2.0.32¶

SDK

Fixed app crash while VR device doesn’t install ConfigService.

Allow content to set virtual wall WVR_ArenaVisible_Auto or WVR_ArenaVisible_ForceOn via SetArenaVisible function. WVR_ArenaVisible_ForceOff is still restricted for users’ safety.

Removed “Launching” word of app switching picture.

Fixed no button id in touchpad swipe event.

Changed default mode of miracast to mirror mode.

Upgraded the controller model of overlay.

Fixed overlay controller hang after application suspend -> resume.

Disable WVR_TriggerRecenter function for Vive Focus since Vive Focus has the system recenter flow and developers have no need to do recenter per content.

Support left-handed mode. Note. The apps built with SDK 2.0.23 or former just support right-handed mode even users switch to left-handed mode via settings.

Support 3DoF mode for the usage on vehicle.

Support arm model controller for overlay.

Change Miracast function from mirror mode with stereo distorted image to presentation mode with mono undistorted image.

Change app switching image.

Change app loader animation.

Unity

Fixed touchpad of controller model sometimes may show blue effect even controller touchpad doesn’t be pressed.

Fixed controller model indicator blurred with the translucent content scene.

Fixed controller model indicator language cannot be switched real-time while system language is changed.

Fixed controller model indicator cannot be shown while user turns to back.

Set default value of controller model indicator OFF. Developer enables it by content demand.

Fixed the flicker of controller model indicators.

Fixed controller disappears while left/right hand switch.

Add feature for hiding controller indicator when xangle > 90 degrees.

Support controller mouse pointer mode to fix controller beam dot cross objects in visual but no hover event in fact.

Fine tune controller arm model behavior.

Fine tune the usage of controller module of unity plugin.

Upgrade new controller model of Vive Focus, and add buttron effects and indicators.

Release 2.0.23¶

SDK

Enable virtual wall for 3DoF contents.

Fix some logic error for “New launched app inherits the last pose from previous app”.

Fix issue “The launcher shifts 90 degrees after reboot device”.

Fix issue “The content drifts after switch app”.

Fix issue “Abnormal sensor polling caused system overhead”.

Fix issue “Server crashes while controller is disconnected”.

Hide controller model and disable button/touch/analog events until user does re-center successfully.

Change the system overlay behavior from moving with head to fixed position.

Change the controller beam style and position of system overlay.

Change the Vive Wave logo while app launches.

Fix issue “IME cannot be hit while the head is moving”.

Fix issue “IME sluggish and broken”.

Avoid onResume/onPause too fast resulting in Unity abnormal by sleeping 200ms in the main thread after calling unity resume.

Avoid the black screen issue when the app crashes and onServerReady not along with onResume.

Change texture number used in texture queue from 6 to 3 to shrink memory usage.

Adjust z-order of overlay modules to fix issue “Controller focus dot crosses overlay panel”.

Shutdown device if device is idle more than 4 hours.

Unity

Update Finch controller model.

Change battery color from blue to white.

Change button color and line width.

Create touch-dot-texture dynamically if touchpad_use_texture is false.

Changed: Finch controller & beam’s shape.

Added: Finch controller transparency.

Tune size of beam pointer.

Controller will become transparent if its position is closed to eye camera.

Add a script ControllerFadeManager to help hiding controller when pitch is higher than 75 degree(this function IS NOT applied to controller by default).

WaveVR_ControllerInputModule effects the WaveVR_ControllerPointer instead of the WaveVR_Reticle.

Fine tune the behavior of arm model.

Fix controller pose pulse issue.

WaveVR_Render adds new checkbox, ‘TimeController’. This can help to set timeScale=0 if input focus is captured by system UI.

Disable feature “Controller becomes transparent while user raises controller in front of eyes”.

Fix issue “OnClick of button is called twice” in WaveVR_ControllerInputModule.cs.