Vuforia Engine Release Notes

STATISTICS ›

Vuforia Engine v10.3.2

 

Bugfixes / Features 

 

All

  • The Vuforia Engine SDK has an updated behavior on when to display the Vuforia Engine Watermark. Please view the updated licensing terms on the Vuforia Engine FAQ.
  • Legacy licenses can still be used with the updated behavior. Please check Vuforia Engine FAQ and the pricing page for details on the licensing changes.
  • The Vuforia VFX Library, available in the Unity Asset Store, contains best-practices scripts, shaders, and effects to build compelling AR applications in combination with Vuforia Engine's tracking capabilities. See the Vuforia VFX Library to get started.

Environments

  • BETA FEAUTRE: The Area Target Capture API enables runtime generation of Area Targets on supported iOS devices. Using this native and Unity API, you can embed Area Target capture into your application, store, retrieve, and share the target to augment your environment at runtime or later. A preview mesh is provided to aid feedback during the capture process, all Area Target assets are created on device and remain on the device. Cloud connectivity is required only to verify your developer credentials. For more information, please check out our documentation on the Area Target Capture API.
  • A 3D prior can be provided for Area Targets in multi-story building scans.
  • A change in the behavior of Vuforia Engine SDK allows for covering larger spaces with multiple smaller Area Targets. In such situations you will need to provide the AreaTargetBehaviour with an external position. Note: this change now requires developers to manually enable "Requires External Positions" for large Area Targets or else you will receive a VU_AREA_TARGET_CREATION_ERROR_REQUIRES_EXTERNAL_POSITIONS error. Earlier this was the default behavior for targets beyond a certain size threshold.

Objects

  • Multiple VuMark databases can be loaded and activated at the same time, independent from the license type.
  • Fixed an issue where wrongly scaled Image Targets or VuMarks showed unstable behavior during the first motion after detection when maximumSimultaneousTrackedImages() was set to 1 or left a the default value.

Session Recorder

  • Recordings made with the SessionRecorder now create a single mp4 file. This file contains the compressed video stream along with Vuforia Engine specific meta-data. If the mp4 file is modified with video editing tools it will no longer be valid for play back using the Vuforia Engine File Driver.

Android

  • The minimum version of ARCore that Vuforia Engine can use has been increased from 1.18.0 to 1.24.0.

iOS

N/A

UWP

  • HoloLens 1 support has been deprecated.
  • An issue with device orientation handling on unsupported devices running Windows 11 has been resolved.
Lumin N/A

Unity

  • When using Vuforia in combination with ARFoundation on Android, the ARCore XR Plugin and ARFoundation packages must be updated to the latest version on Unity 2020.3: the verified version of the packages contains an older version of ARCore not compatible with Vuforia.
  • An issue with SIMULATOR Playmode not rendering point-cloud based targets during testing on Windows desktops when using the Mesh Collider has been resolved.
  • Editing the C# script while in Playmode is now gracefully failing with an error “Vuforia cannot recover from Assembly reload.”.

 

Known Issues

 

All

Environments

  • The Device Pose Observer static mode needs to be configured before target Observers are activated for Extended Tracking to work.
  • Using multiple targets simultaneously while Extended Tracking them when using the Vuforia Sensor Fusion provider may lead to degraded tracking quality in rare scenarios.
  • VISLAM may fail on environments with predominantly edgy structures with fine lines w/o other texture.
  • The Ground Plane sample app does not allow re-positioning of the annotations into a new area after pause and resume. Going back to the original area and recovering the original annotation is necessary before it can be moved. As an alternative you can reset the experience after resume to use the app again.
  • Under certain conditions when doing fast motions during Extended Tracking using Fusion-provider VISLAM an apparent shift in augmentation might be observed. Approaching the original target and/or resetting Device Pose Observer will resolve the issue.

Session Recorder

  • Playback of recordings from the Session Recorder do not support Ground Plane experiences.

Model Targets

  • Device Pose Observer reset during Extended Tracking with Model Target might in some cases lead to unexpected relocalization issues. Deactivating/activating the Model Target improves the situation - but user will have to start experience again with detecting the Model Target.
  • Targets with motion hint STATIC are more sensitive to wrongly specified physical size in the dataset.
  • Model targets may switch to EXTENDED_TRACKED more often during very fast user motion when the motion hint is set to STATIC. We recommend using ADAPTIVE if robust tracking during very fast motions is required.

Other

  • Reported bounding-box size via vuObjectTargetObserverGetBoundingBox() API is in some cases not reflecting actual target size.
  • The improvement to detect Image Targets at a greater distance introduced in SDK 7.5.20 does not apply for Cloud Targets
  • Issues were reported using the VuMark Designer Scripts with latest Adobe Illustrator 2021 versions. Please use the scripts with Adobe Illustrator 2020 until a compatibility update has been released.
Android
  • Vuforia Engine may fail to detect ARCore on some devices, additional logging has been introduced in 9.8.11 and 10.0 which will help diagnose these failures. Note that when building with target API level 30 or above developers should be sure to build with ARCore version 1.22.0 or higher.
  • When building the UVC camera library for Android, we recommend using NDK 13b. Please see the UVC Driver documentation or the ReadMe.md in the UVC sample for more details.
  • After Device Pose Observer loses tracking with ARCore it may be necessary to direct the user to return to the target to recover extended tracking when using Advanced Model Targets.
  • On Android, the Session Recorder writes to the OS defined primary storage location. On devices with emulated storage Android typically provides the emulated storage as the primary location. This means that Vuforia will not usually record to a removable SD card.

iOS

  • During consecutive runs of Area Target Capture in the same session the preview mesh may not be cleared or only cleaned up partially.
  • A crash is observed on the iPad Pro 4th generation on application start in cases where the device is connected to debugging. This behaviour is not observed in iPadOS 13.6 and later.
  • Running (Advanced) Model Targets with Device Pose Observer on dual-core iOS devices (e.g. iPhone 6/6s) may result in noticeable video background lag.

UWP

  • On Hololens, starting a Vuforia App when an existing Miracast session is active will terminate the Miracast session. It is possible to re-start the Miracast session and use it while Vuforia is tracking, however any camera start operation in Vuforia will again terminate the Miracast session.
  • Small or far away Image Targets may temporarily show increased jitter on HoloLens when only very limited head motion is performed.
  • On HoloLens, rapidly attempting to deactivate or activate a VuMark database within the Vuforia_onUpdate callback can lead to freezing.
  • On UWP devices with outdated Intel AVStream camera drivers, the camera feed sometimes freezes.
  • Extended tracked targets may be reported with incorrect poses for one or two frames after pausing and resuming when using Vuforia Sensor Fusion provider.
Lumin N/A

Unity

Model Targets

  • Apps may experience long dataset loading times and/or run out of memory if Advanced Model Target databases with more than 10 trained models are used. The exact number of supported targets is dependent on model size and complexity as well as the device that is being used.
  • Changing the Guide View mode of multiple Model Target behaviours simultaneously by having them all selected in the Unity Editor is currently not supported. Please change the guide view mode for each behaviour separately.

Area Targets

  • Area Target Capture may show on tracking loss "excessive motion" error followed by "movement needed" even though the user makes an optimal motion. A better UX recommendation is to show "The capture is relocalizing, the user should move around slowly and return towards a previously mapped area in order to resume normal capturing".
  • Area Targets created prior to 9.7 or created with the Area Target Generator of earlier versions will not work out of the box with the Occlusion Mesh and Mesh Collider settings in Unity. See the Migration Guide for details and workaround.

Android

  • If your Unity project includes the ARCore XR Plugin you must uncheck the Vuforia Configuration option ‘Include ARCore library’ to avoid duplicate symbol errors building your app.
  • On some Android devices (e.g. PixelXL), objects occluded by Vuforia Engine's "Custom/DepthMask" shader (used e.g. for Area Target occlusion) are rendered black. To work around this issue, set the occluded objects' materials to Rendering Mode "Transparent".
  • When using the scriptable render pipeline, enabling the experimental SRP Batcher option will break Video Background Rendering on Android OpenGL ES 3.0.
  • In some occasions, the sample UVC driver implementation may fail to start after the USB camera permission has been accepted on Android.

iOS

  • Vuforia Engine requires "Render Over Native UI" to be set for iOS to resolve a performance issue seen on some ARKit-enabled devices. However, the same setting causes non-Vuforia specific issues on Android 8.0. Therefore, this setting is set/unset automatically when switching the platform between Android and iOS in Unity.When upgrading the Vuforia extension package on MacOS, a restart of the Unity Editor may be required to complete the upgrade process.
  • Calling SceneManager.LoadScene successively and in quick manner may result in a black video background on iOS devices.
  • 2D Model Target Guide views are currently not supported on iOS when using the OpenGLES2 Graphics API. Please use 3D guide views in case you want to support the OpenGL ES 2.0 rendering backend.

UWP

  • Vuforia Engine should not be used with the OpenXR Unity plugin on Hololens devices, this combination results in an offset of augmentations.
  • On the Hololens 1 device the Hololens sample exposes diverse issues after pause/resume, incl. targets not detected and menu stuck.
  • After pausing and resuming the HoloLens sample application, the hand tracking fails to restart and the hand augmentation and the cursor appear stuck, rendering any hand interaction impossible.
  • The Virtual Scene Scale Factor in Unity is not supported on HoloLens.
  • In the HoloLens sample app for Unity, voice commands may stop working after suspending and resuming the app.
  • In the Unity HoloLens sample, some renderings errors are seen in scene view in the Unity Editor.
  • VuMarks may not work on UWP devices with the locale set to something different than English.
  • on UWP, using the "Run in background" option in the Unity player settings may cause the video background to freeze on resume after the application was minimized (suspended). It is recommend to disable "Run in background" so that Vuforia can be properly paused if the app is not in the foreground.
  • Initialization fails to return INIT_NO_CAMERA_ACCESS error code when camera permissions are denied on UWP.
  • UWP apps may exhibit symptoms such as a black screen or frozen camera image when another app is also using the camera.

Lumin

  • The SessionRecorder prefab requires custom UI when used on Magic Leap One.
  • The Virtual Scene Scale Factor in Unity is not supported on Magic Leap One.

Other

  • When integrating with ARFoundation in Unity, Vuforia will automatically use the highest camera resolution that ARFoundation offers. Changing that camera resolution is currently not supported.
  • Unity Cloud Build is currently not supported in Unity 2018.4 if Vuforia Engine is upgraded through an update installer. This issue is resolved with Unity 2019.2, where Vuforia Engine is integrated with Unity's package manager.
  • When upgrading the Vuforia extension package on MacOS, a restart of the Unity Editor may be required to complete the upgrade process.
  • When building a Vuforia project using Unity in batch mode, the Render Over Native UI setting must be manually configured according to the desired target platform.
  • Ground Plane experience currently do not support changing Virtual Scene Scale in Unity at runtime.
  • Accessing the camera background materials in Unity interferes with video texture updates. Please refer here for more information.
  • Incorrect build errors may appear when building an application for the first time on a specific platform. The current workaround is to build a second time and errors will be resolved
  • Successively calling GetCameraImage() from multiple scenes returns incorrect images.

Vuforia Engine v10.2.5

 

Bugfixes / Features 

 

All

  • Tracking of moving targets, in particular Model Targets has been improved. Use motion hint ADAPTIVE to benefit from this improvement. When this motion hint is set for a target, the motion of a target will be predicted in case it is moving. If the target is not moving, its pose will be stabilized with Vuforia Fusion by leveraging device tracking capabilities.

Android

N/A

iOS

N/A

UWP

  • Improved the default configuration returned by vuHitTestConfigDefault() to return a valid default deviceHeight.
Lumin
  • Session Recording is now supported on Magic Leap, but no out-of-the-box user interface is provided to start and stop recordings.

Unity

  • An issue using a VirtualSceneScale other than 1.0 with Area Targets causing wrongly scaled target in Simulator mode has been resolved.

 

Known Issues

 

All

Environments

  • The Device Pose Observer static mode needs to be configured before target Observers are activated for Extended Tracking to work.
  • Using multiple targets simultaneously while Extended Tracking them when using the Vuforia Sensor Fusion provider may lead to degraded tracking quality in rare scenarios.
  • VISLAM may fail on environments with predominantly edgy structures with fine lines w/o other texture.
  • The Ground Plane sample app does not allow re-positioning of the annotations into a new area after pause and resume. Going back to the original area and recovering the original annotation is necessary before it can be moved. As an alternative you can reset the experience after resume to use the app again.
  • Under certain conditions when doing fast motions during Extended Tracking using Fusion-provider VISLAM an apparent shift in augmentation might be observed. Approaching the original target and/or resetting Device Pose Observer will resolve the issue.

Session Recorder

  • Playback of recordings from the Session Recorder do not support Ground Plane experiences.

Model Targets

  • Device Pose Observer reset during Extended Tracking with Model Target might in some cases lead to unexpected relocalization issues. Deactivating/activating the Model Target improves the situation - but user will have to start experience again with detecting the Model Target.
  • Targets with motion hint STATIC are more sensitive to wrongly specified physical size in the dataset.
  • Model targets may switch to EXTENDED_TRACKED more often during very fast user motion when the motion hint is set to STATIC. We recommend using ADAPTIVE if robust tracking during very fast motions is required.

Other

  • Wrongly scaled Image Targets or VuMarks may show unstable behavior during the first motion after detection. To work around the issue, we recommend setting vuEngineSetMaximumSimultaneousTrackedImages to a value of 2 or higher, even if just a single target is used. See Tracking Multiple Targets Simultaneously for setting the value,
  • Reported bounding-box size via vuObjectTargetObserverGetBoundingBox() API is in some cases not reflecting actual target size.
  • The improvement to detect Image Targets at a greater distance introduced in SDK 7.5.20 does not apply for Cloud Targets
  • Issues were reported using the VuMark Designer Scripts with latest Adobe Illustrator 2021 versions. Please use the scripts with Adobe Illustrator 2020 until a compatibility update has been released.
Android
  • Vuforia Engine may fail to detect ARCore on some devices, additional logging has been introduced in 9.8.11 and 10.0 which will help diagnose these failures. Note that when building with target API level 30 or above developers should be sure to build with ARCore version 1.22.0 or higher.
  • When building the UVC camera library for Android, we recommend using NDK 13b. Please see the UVC Driver documentation or the ReadMe.md in the UVC sample for more details.
  • After Device Pose Observer loses tracking with ARCore it may be necessary to direct the user to return to the target to recover extended tracking when using Advanced Model Targets.
  • The Session Recorder writes to the OS defined primary storage location. On devices with emulated storage Android typically provides the emulated storage as the primary location. This means that Vuforia will not usually record to a removable SD card.

iOS

  • A crash is observed on the iPad Pro 4th generation on application start in cases where the device is connected to debugging. This behaviour is not observed in iPadOS 13.6 and later.
  • Running (Advanced) Model Targets with Device Pose Observer on dual-core iOS devices (e.g. iPhone 6/6s) may result in noticeable video background lag.

UWP

  • On Hololens, starting a Vuforia App when an existing Miracast session is active will terminate the Miracast session. It is possible to re-start the Miracast session and use it while Vuforia is tracking, however any camera start operation in Vuforia will again terminate the Miracast session.
  • On HoloLens, rapidly attempting to deactivate or activate a VuMark database within the Vuforia_onUpdate callback can lead to freezing.
  • Small or far away Image Targets may temporarily show increased jitter on HoloLens when only very limited head motion is performed.
  • On UWP devices with outdated Intel AVStream camera drivers, the camera feed sometimes freezes.
  • Extended tracked targets may be reported with incorrect poses for one or two frames after pausing and resuming when using Vuforia Sensor Fusion provider.
Lumin N/A

Unity

Model Targets

  • Apps may experience long dataset loading times and/or run out of memory if Advanced Model Target databases with more than 10 trained models are used. The exact number of supported targets is dependent on model size and complexity as well as the device that is being used.
  • 2D Model Target Guide views are currently not supported on iOS when using the OpenGLES2 Graphics API. Please use 3D guide views in case you want to support the OpenGL ES 2.0 rendering backend.
  • Changing the Guide View mode of multiple Model Target behaviours simultaneously by having them all selected in the Unity Editor is currently not supported. Please change the guide view mode for each behaviour separately.

Area Targets

  • On Windows, enabling Mesh Collider when using a point-cloud based target will cause the point-cloud not being rendered in SIMULATOR Playmode. For testing such scenarios in the Editor disable the collider or use a MacOS based desktop for testing.
  • Area Targets created prior to 9.7 or created with the Area Target Generator of earlier versions will not work out of the box with the Occlusion Mesh and Mesh Collider settings in Unity. See the Migration Guide for details and workaround.

Android

  • If your Unity project includes the ARCore XR Plugin you must uncheck the Vuforia Configuration option ‘Include ARCore library’ to avoid duplicate symbol errors building your app.
  • On some Android devices (e.g. PixelXL), objects occluded by Vuforia Engine's "Custom/DepthMask" shader (used e.g. for Area Target occlusion) are rendered black. To work around this issue, set the occluded objects' materials to Rendering Mode "Transparent".
  • When using the scriptable render pipeline, enabling the experimental SRP Batcher option will break Video Background Rendering on Android OpenGL ES 3.0.
  • Vuforia Engine requires "Render Over Native UI" to be set for iOS to resolve a performance issue seen on some ARKit-enabled devices. However, the same setting causes non-Vuforia specific issues on Android 8.0. Therefore, this setting is set/unset automatically when switching the platform between Android and iOS in Unity.
  • In some occasions, the sample UVC driver implementation may fail to start after the USB camera permission has been accepted on Android.

iOS

  • When upgrading the Vuforia extension package on MacOS, a restart of the Unity Editor may be required to complete the upgrade process.
  • Calling SceneManager.LoadScene successively and in quick manner may result in a black video background on iOS devices.

UWP

  • Vuforia Engine should not be used with the OpenXR Unity plugin on Hololens devices, this combination results in an offset of augmentations.
  • On the Hololens 1 device the Hololens sample exposes diverse issues after pause/resume, incl. targets not detected and menu stuck.
  • After pausing and resuming the HoloLens sample application, the hand tracking fails to restart and the hand augmentation and the cursor appear stuck, rendering any hand interaction impossible.
  • In the HoloLens sample app for Unity, voice commands may stop working after suspending and resuming the app.
  • In the Unity HoloLens sample, some renderings errors are seen in scene view in the Unity Editor.
  • VuMarks may not work on UWP devices with the locale set to something different than English.
  • The Virtual Scene Scale Factor in Unity is not supported on HoloLens.
  • Using the "Run in background" option in the Unity player settings may cause the video background to freeze on resume after the application was minimized (suspended). It is recommend to disable "Run in background" so that Vuforia can be properly paused if the app is not in the foreground.
  • Initialization fails to return INIT_NO_CAMERA_ACCESS error code when camera permissions are denied on UWP.

Lumin

  • The SessionRecorder prefab requires custom UI when used on Magic Leap One.
  • The Virtual Scene Scale Factor in Unity is not supported on Magic Leap One.

Other

  • When integrating with ARFoundation in Unity, Vuforia will automatically use the highest camera resolution that ARFoundation offers. Changing that camera resolution is currently not supported.
  • Unity Cloud Build is currently not supported in Unity 2018.4 if Vuforia Engine is upgraded through an update installer. This issue is resolved with Unity 2019.2, where Vuforia Engine is integrated with Unity's package manager.
  • When building a Vuforia project using Unity in batch mode, the Render Over Native UI setting must be manually configured according to the desired target platform.
  • Ground Plane experience currently do not support changing Virtual Scene Scale in Unity at runtime.
  • Accessing the camera background materials in Unity interferes with video texture updates. Please refer here for more information.
  • Incorrect build errors may appear when building an application for the first time on a specific platform. The current workaround is to build a second time and errors will be resolved
  • Successively calling GetCameraImage() from multiple scenes returns incorrect images.

Vuforia Engine v10.1.4

 

Bugfixes / Features 

 

All

  • Detection and Tracking of VuMarks has been improved to work at significantly greater distances.

Other

  • All vuIdentityVector methods have been renamed to vuOneVector (for VuVector2F, VuVector3F, VuVector4F, and VuVector8F).

Android

N/A

iOS

N/A

UWP

  • Fixed a bug in the FileDriver sample for UWP, if the specified recording path didn’t exist on the device an exception was thrown by UWP but not caught by the Driver resulting in a crash.
  • Fixed a problem handling the video background with DirectX on UWP, for certain camera or recording resolutions, the video background appeared corrupted in previous releases.
  • An issue causing a crash in the Model Target core sample when switching models on UWP devices has been resolved.
Lumin N/A

Unity

  • Fixed an issue where the DevicePoseObserver would fail to be created after manually deinitializing and initializing Vuforia.
  • Fixed an issue which prevented Session Recorder working in Unity on a Hololens device.
  • Fixed an issue where the VideoBackground image would freeze when disabling the DevicePoseBehaviour in a GroundPlane scene.
  • Fixed issue where a ModelTarget’s GuideView would only have the correct orientation in combination with ARFoundation when the screen orientation was Landscape Left.
  • An issue with the Webcam stuck upon initialization in Unity Playmode has been fixed.

 

Known Issues

 

All

Environments

  • The Device Pose Observer static mode needs to be configured before target Observers are activated for Extended Tracking to work.
  • Using multiple targets simultaneously while Extended Tracking them when using the Vuforia Sensor Fusion provider may lead to degraded tracking quality in rare scenarios.
  • VISLAM may fail on environments with predominantly edgy structures with fine lines w/o other texture.
  • The Ground Plane sample app does not allow re-positioning of the annotations into a new area after pause and resume. Going back to the original area and recovering the original annotation is necessary before it can be moved. As an alternative you can reset the experience after resume to use the app again.

Session Recorder

  • Playback of recordings from the Session Recorder do not support Ground Plane experiences.

Model Targets

  • Device Pose Observer reset during Extended Tracking with Model Target might in some cases lead to unexpected relocalization issues. Deactivating/activating the Model Target improves the situation - but user will have to start experience again with detecting the Model Target.
  • Targets with motion hint STATIC are more sensitive to wrongly specified physical size in the dataset.
  • Model targets may switch to EXTENDED_TRACKED more often during very fast user motion when the motion hint is set to STATIC. We recommend using ADAPTIVE if robust tracking during very fast motions is required.

Other

  • Reported bounding-box size via vuObjectTargetObserverGetBoundingBox() API is in some cases not reflecting actual target size.
  • The improvement to detect Image Targets at a greater distance introduced in SDK 7.5.20 does not apply for Cloud Targets
  • Issues were reported using the VuMark Designer Scripts with latest Adobe Illustrator 2021 versions. Please use the scripts with Adobe Illustrator 2020 until a compatibility update has been released.
Android
  • Vuforia Engine may fail to detect ARCore on some devices, additional logging has been introduced in 9.8.11 and 10.0 which will help diagnose these failures. Note that when building with target API level 30 or above developers should be sure to build with ARCore version 1.22.0 or higher.
  • When building the UVC camera library for Android, we recommend using NDK 13b. Please see the UVC Driver documentation or the ReadMe.md in the UVC sample for more details.
  • After Device Pose Observer loses tracking with ARCore it may be necessary to direct the user to return to the target to recover extended tracking when using Advanced Model Targets.
  • The Session Recorder writes to the OS defined primary storage location. On devices with emulated storage Android typically provides the emulated storage as the primary location. This means that Vuforia will not usually record to a removable SD card.

iOS

  • A crash is observed on the iPad Pro 4th generation on application start in cases where the device is connected to debugging. This behaviour is not observed in iPadOS 13.6 and later.
  • Running (Advanced) Model Targets with Device Pose Observer on dual-core iOS devices (e.g. iPhone 6/6s) may result in noticeable video background lag.
  • The Vuforia Sample on iOS builds up memory under Metal API validation.

UWP

  • On Hololens, starting a Vuforia App when an existing Miracast session is active will terminate the Miracast session. It is possible to re-start the Miracast session and use it while Vuforia is tracking, however any camera start operation in Vuforia will again terminate the Miracast session.
  • On HoloLens, rapidly attempting to deactivate or activate a VuMark database within the Vuforia_onUpdate callback can lead to freezing.
  • Small or far away Image Targets may temporarily show increased jitter on HoloLens when only very limited head motion is performed.
  • On UWP devices with outdated Intel AVStream camera drivers, the camera feed sometimes freezes.
  • Extended tracked targets may be reported with incorrect poses for one or two frames after pausing and resuming when using Vuforia Sensor Fusion provider.
  • Vuforia UWP apps may exhibit symptoms such as a black screen or frozen camera image when another app is also using the camera.
Lumin
  • The Session Recorder prefab for Unity is not supported on Magic Leap. However, the Session Recorder can be used on Magic Leap by using the scripting API directly..

Unity

Model Targets

  • Apps may experience long dataset loading times and/or run out of memory if Advanced Model Target databases with more than 10 trained models are used. The exact number of supported targets is dependent on model size and complexity as well as the device that is being used.
  • 2D Model Target Guide views are currently not supported on iOS when using the OpenGLES2 Graphics API. Please use 3D guide views in case you want to support the OpenGL ES 2.0 rendering backend.
  • Changing the guide view mode of multiple Model Target behaviours simultaneously by having them all selected in the Unity Editor is currently not supported. Please change the guide view mode for each behaviour separately.

Area Targets

  • Using a VirtualSceneScaleFactor set to other than 1.0 with AreaTargets will result in a wrongly scaled target in Simulator mode. Authoring mode and the deployed run-time application will respect the scale correctly.
  • Area Targets created prior to 9.7 or created with the Area Target Generator of earlier versions will not work out of the box with the Occlusion Mesh and Mesh Collider settings in Unity. See the Migration Guide for details and workaround.

Android

  • If your Unity project includes the ARCore XR Plugin you must uncheck the Vuforia Configuration option ‘Include ARCore library’ to avoid duplicate symbol errors building your app.
  • On some Android devices (e.g. PixelXL), objects occluded by Vuforia Engine's "Custom/DepthMask" shader (used e.g. for Area Target occlusion) are rendered black. To work around this issue, set the occluded objects' materials to Rendering Mode "Transparent".
  • When using the scriptable render pipeline, enabling the experimental SRP Batcher option will break Video Background Rendering on Android OpenGL ES 3.0.
  • Vuforia Engine requires "Render Over Native UI" to be set for iOS to resolve a performance issue seen on some ARKit-enabled devices. However, the same setting causes non-Vuforia specific issues on Android 8.0. Therefore, this setting is set/unset automatically when switching the platform between Android and iOS in Unity.
  • In some occasions, the sample UVC driver implementation may fail to start after the USB camera permission has been accepted on Android.

iOS

  • Vuforia Engine requires "Render Over Native UI" to be set for iOS to resolve a performance issue seen on some ARKit-enabled devices. However, the same setting causes non-Vuforia specific issues on Android 8.0. Therefore, this setting is set/unset automatically when switching the platform between Android and iOS in Unity.
  • Calling SceneManager.LoadScene successively and in quick manner may result in a black video background on iOS devices.
  • When upgrading the Vuforia extension package on MacOS, a restart of the Unity Editor may be required to complete the upgrade process.

UWP

  • Vuforia Engine should not be used with the OpenXR Unity plugin on Hololens devices, this combination results in an offset of augmentations.
  • On the Hololens 1 device the Hololens sample exposes diverse issues after pause/resume, incl. targets not detected and menu stuck.
  • After pausing and resuming the HoloLens sample application, the hand tracking fails to restart and the hand augmentation and the cursor appear stuck, rendering any hand interaction impossible.
  •  In the HoloLens sample app for Unity, voice commands may stop working after suspending and resuming the app.
  • In the Unity HoloLens sample, some renderings errors are seen in scene view in the Unity Editor.
  • VuMarks may not work on UWP devices with the locale set to something different than English.
  • The Virtual Scene Scale Factor in Unity is not supported on HoloLens.
  • Using the "Run in background" option in the Unity player settings may cause the video background to freeze on resume after the application was minimized (suspended). It is recommend to disable "Run in background" so that Vuforia can be properly paused if the app is not in the foreground.
  • Initialization fails to return INIT_NO_CAMERA_ACCESS error code when camera permissions are denied on UWP.

Lumin

  • Session recording is currently not supported on Magic Leap One.
  • The Virtual Scene Scale Factor in Unity is not supported on Magic Leap.

Other

  • When integrating with ARFoundation in Unity, Vuforia will automatically use the highest camera resolution that ARFoundation offers. Changing that camera resolution is currently not supported.
  • Unity Cloud Build is currently not supported in Unity 2018.4 if Vuforia Engine is upgraded through an update installer. This issue is resolved with Unity 2019.2, where Vuforia Engine is integrated with Unity's package manager.
  • When building a Vuforia project using Unity in batch mode, the Render Over Native UI setting must be manually configured according to the desired target platform.
  • Ground Plane experience currently do not support changing Virtual Scene Scale in Unity at runtime.
  • Accessing the camera background materials in Unity interferes with video texture updates. Please refer here for more information.
  • Incorrect build errors may appear when building an application for the first time on a specific platform. The current workaround is to build a second time and errors will be resolved
  • Successively calling GetCameraImage() from multiple scenes returns incorrect images.
  • Under certain conditions when doing fast motions during Extended Tracking using Fusion-provider VISLAM an apparent shift in augmentation might be observed. Approaching the original target and/or resetting Device Pose Observer will resolve the issue.

Vuforia Engine v10.0.12

 

Bugfixes / Features 

 

All

General

  • A new modernized API is introduced that significantly simplifies managing targets and tracker lifecycle. More information can be found at:
  • The Vuforia Engine package for Unity is no longer distributed through Git. Instead, it's now bundled as a tarball package (.tgz) that is included in the Asset Store samples and as a .unitypackage that can be downloaded from the Vuforia Developer Portal.

Model Targets

  • Model Target tracking for cars and other large, reflective objects is now significantly improved through an AI powered tracking technology when combining the STATIC motion hint with tracking mode CAR. This improvement is available on most iOS devices and selected Android phones. More information on Optimizing Model Target Tracking page.
  • Model Target datasets generated with the Vuforia MTG version 10.0 are significantly smaller than before. Advanced Model Target datasets are reduced to approx. 50% of their previous size, while standard, untrained Model Targets will be reduced to about 20% or their previous dataset size.
  • Model Target Simplification in the MTG is now available to all users, not just those with a paid Vuforia Engine license.
  • Legacy support for Model Targets with Advanced Recognition - the feature to automatically recognize a specific guide view - has been removed. Advanced Model Targets - recognizing a Model Target from different angles without requiring guide views - is of course still supported.
  • An issue where Model Targets in conjunction with AR Foundation was not snapping in cases when the screen orientation is set to something other than “Landscape Left” was resolved.

Area Targets

  • Area Target support for Leica BLK360 and Leica RTC360 has been fully enabled and is no longer beta-quality.

Other features

  • A new DYNAMIC motion hint has been introduced for all Object Target types, including Image-, Cylinder-, Multi- and Model Targets. This motion hint optimizes tracking for targets that are continuously moving. For more information see Motion Hints.
  • The native samples now support auto rotation.

Android

  • Fixed a number of small memory leaks seen when Vuforia is deinitialized, these could become a problem if Vuforia Engine is initialized and de-initialized multiple times within the same App session.
  • Fixed Vuforia Engine to work with ARCore when the App is built with ARCore version 1.23 and above.
  • Added a workaround for ARCore camera failures seen on some devices (including LG G7) which result in a black screen typically seen on resuming the App from paused state.
  • Fixed an issue where ARCore failed to start when app has been compiled targeting Android API 30.

iOS

  • Fixed a crash on iOS during shutdown of Vuforia Engine.
  • Fixed an issue in the native iOS sample app where Initialization/de-initialization of Vuforia Engine did not release some memory.

UWP

  • A change has been made to address an issue that causes high CPU usage when detecting trained Model Targets on Windows UWP (including Hololens 2) after upgrading Windows 10 to 21H1.
Lumin
  • Vuforia Engine now fully supports the Magic Leap eyewear device
  • Area Targets are now fully supported on Magic Leap.

Unity

  • The minimum supported Unity version is raised to 2020.3 LTS.
  • Changed the shaders used for video background rendering to give a more neutral image appearance.
  • 2D Model Target Guide View poses can now be overriden at runtime.
  • Fixed major lag issue observed with Model Target augmentation when integrating with Unity ARFoundation Unity project.
  • Setters for the following two methods have been exposed:
    • VuforiaConfiguration.Instance.WebCam.DeviceNameSetInEditor
    • VuforiaConfiguration.Instance.WebCam.TurnOffWebCam
  • Greatly improved rendering performance of AreaTarget point clouds in the Editor.
  • Fixed an issue where the point cloud was flickering during Unity authoring of large Area Targets.

 

Known Issues

 

All

Environments

  • The device pose observer static mode needs to be configured before target observers are activated for extended tracking to work.
  • Using multiple targets simultaneously while Extended Tracking them when using the Vuforia Sensor Fusion provider may lead to degraded tracking quality in rare scenarios.
  • VISLAM may fail on environments with predominantly edgy structures with fine lines w/o other texture.
  • Targets with motion hint STATIC are more sensitive to wrongly specified physical size in the dataset.
  • Under certain conditions when doing fast motions during Extended Tracking using Fusion-provider VISLAM an apparent shift in augmentation might be observed. Approaching the original target and/or resetting Device Pose Observer will resolve the issue.
  • The Ground Plane sample app does not allow re-positioning of the annotations into a new area after pause and resume. Going back to the original area and recovering the original annotation is necessary before it can be moved. As an alternative you can reset the experience after resume to use the app again.

Session Recorder

  • Playback of recordings from the Session Recorder do not support Ground Plane experiences.

Model Targets

  • Device Pose Observer reset during Extended Tracking with Model Target might in some cases lead to unexpected relocalization issues. Deactivating/activating the Model Target improves the situation - but user will have to start experience again with detecting the Model Target.
  • Model targets may switch to EXTENDED_TRACKED more often during very fast user motion when the motion hint is set to STATIC. We recommend using ADAPTIVE if robust tracking during very fast motions is required.

Other

  • Issues were reported using the VuMark Designer Scripts with latest Adobe Illustrator 2021 versions. Please use the scripts with AI 2020 until a compatibility update has been released.
  • The improvement to detect Image Targets at a greater distance introduced in SDK 7.5.20 does not apply for Cloud Targets.
Android
  • Vuforia Engine may fail to detect ARCore on some devices, additional logging has been introduced in 9.8.11 and 10.0 which will help diagnose these failures. Note that when building with target API level 30 or above developers should be sure to build with ARCore version 1.22.0 or higher.
  • The Session Recorder writes to the OS-defined primary storage location. On devices with emulated storage Android typically provides the emulated storage as the primary location. This means that Vuforia will not usually record to a removable SD card.
  • After Device Pose tracking loses tracking with ARCore it may be necessary to direct the user to return to the target to recover extended tracking when using Advanced Model Targets.

iOS

  • The Vuforia Sample on iOS builds up memory under Metal API validation.
  • Running (Advanced) Model Targets with Device Tracking on dual-core iOS devices (e.g. iPhone 6/6s) may result in noticeable video background lag.
  • A crash is observed on the iPad Pro 4th generation on application start in cases where the device is connected to debugging. This behaviour is not observed in iPadOS 13.6 and later.

UWP

  • Objects are not occluded by an AreaTarget in Unity Projects on HoloLens despite the option being selected.
  • On HoloLens, starting a Vuforia App when an existing Miracast session is active will terminate the Miracast session. It is possible to re-start the Miracast session and use it while Vuforia is tracking, however any camera start operation in Vuforia will again terminate the Miracast session.
  • Small or far away Image Targets may temporarily show increased jitter on HoloLens when only very limited head motion is performed.
  • On HoloLens, rapidly attempting to deactivate or activate a VuMark database within the Vuforia_onUpdate callback can lead to freezing.
  • Extended tracked targets may be reported with incorrect poses for one or two frames after pausing and resuming when using Vuforia Sensor Fusion provider.
  • On UWP devices with outdated Intel AVStream camera drivers, the camera feed sometimes freezes. Please update the driver.
  • Augmentations placed on Ground Planes may jitter more on UWP tablet devices than on other platforms.
Lumin
  • The Session Recorder prefab for Unity is not supported on Magic Leap. The Session Recorder can, however, be used on Magic Leap by using the scripting API directly.

Unity

Model Targets

  • Unity Model Target datasets with filenames starting or ending with a space character will cause an infinite loop upon import.
  • Apps may experience long dataset loading times and/or run out of memory if Advanced Model Target databases with more than 10 trained models are used. The exact number of supported targets is dependent on model size and complexity as well as the device that is being used.
  • Changing the guide view mode of multiple Model Target behaviors simultaneously by having them all selected in the Unity Editor is currently not supported. Please change the guide view mode for each behavior separately.

Area Targets

  • Area Targets created prior to 9.7 or created with the Area Target Generator of earlier versions will not work out of the box with the Occlusion Mesh and Mesh Collider settings in Unity. See the Migration Guide for details and workaround.
  • Using a VirtualSceneScale other than 1.0 with AreaTargets will result in a wrongly scaled target in Simulator mode. Authoring mode and the deployed run-time application will respect the scale correctly.
  • Unity Area Target datasets with filenames starting or ending with a space character will cause an infinite loop upon import.
  • Objects are not occluded by an AreaTarget on HoloLens despite the option being selected.

UWP

  • On the Hololens 1 device, the Hololens sample exposes diverse issues after pause/resume, incl. targets not being detected and a menu that is stuck.
  • After pausing and resuming the HoloLens sample application, the hand tracking fails to restart and the hand augmentation and the cursor appear stuck, rendering any hand interaction impossible.
  • In the HoloLens sample app for Unity, voice commands may stop working after suspending and resuming the app.
  • In the Unity HoloLens sample, some renderings errors are seen in scene view in the Unity Editor.
  • The Virtual Scene Scale Factor in Unity is not supported on HoloLens.
  • VuMarks may not work on UWP devices with the locale set to something different than English.
  • On UWP devices, using the "Run in background" option in the Unity player settings may cause the video background to freeze on resume after the application was minimized (suspended). It is recommend to disable "Run in background" so that Vuforia can be properly paused if the app is not in the foreground.
  • Vuforia UWP apps may exhibit symptoms such as a black screen or frozen camera image when another app is also using the camera.
  • Initialization fails to return INIT_NO_CAMERA_ACCESS error code when camera permissions are denied on UWP.

Lumin

  • The Session Recorder Prefab is currently not supported on Magic Leap One.
  • The Virtual Scene Scale Factor in Unity is not supported on Magic Leap.

Android

  • If your Unity project includes the ARCore XR Plugin you must uncheck the Vuforia Configuration option ‘Include ARCore library’ to avoid duplicate symbol errors building your app.
  • The DepthContour shader will render with some black artifacts on some Snapdragon-based Android devices when the Vulkan graphics backend is used.
  • On some Android devices (e.g. PixelXL), objects occluded by Vuforia Engine's "Custom/DepthMask" shader (used e.g. for Area Target occlusion) are rendered black. To work around this issue, set the occluded objects' materials to Rendering Mode "Transparent".
  • When using the scriptable render pipeline, enabling the experimental SRP Batcher option will break Video Background Rendering on Android OpenGL ES 3.0.
  • In some occasions, the sample UVC driver implementation may fail to start after the USB camera permission has been accepted on Android.
  • Vuforia Engine requires "Render Over Native UI" to be set for iOS to resolve a performance issue seen on some ARKit-enabled devices. However, the same setting causes non-Vuforia specific issues on Android 8.0. Therefore, this setting is set/unset automatically when switching the platform between Android and iOS in Unity.

iOS

  • Calling SceneManager.LoadScene successively and in quick manner may result in a black video background on iOS devices.
  • 2D Model Target Guide views are currently not supported on iOS when using the OpenGLES2 Graphics API. Please use 3D guide views in case you want to support the OpenGL ES 2.0 rendering backend.
  • Vuforia Engine requires "Render Over Native UI" to be set for iOS to resolve a performance issue seen on some ARKit-enabled devices. However, the same setting causes non-Vuforia specific issues on Android 8.0. Therefore, this setting is set/unset automatically when switching the platform between Android and iOS in Unity.

Other

  • When building a Vuforia project using Unity in batch mode, the Render Over Native UI setting must be manually configured according to the desired target platform.
  • When integrating with ARFoundation in Unity, Vuforia will automatically use the highest camera resolution that ARFoundation offers. Changing that camera resolution is currently not supported.
  • Ground Plane experience currently do not support changing Virtual Scene Scale in Unity at runtime.
  • Unity Cloud Build is currently not supported in Unity 2018.4 if Vuforia Engine is upgraded through an update installer. This issue is resolved with Unity 2019.2, where Vuforia Engine is integrated with Unity's package manager.
  • Accessing the camera background materials in Unity interferes with video texture updates. Please refer here for more information.
  • Incorrect build errors may appear when building an application for the first time on a specific platform. The current workaround is to build a second time and errors will be resolved.
  • Successively calling GetCameraImage from multiple scenes returns incorrect images.

For release notes prior to Vuforia Engine 10.0, please see the Vuforia Engine Archive and the Tools and Test Apps Archive