Vuforia Engine Release Notes

Vuforia Engine v10.11.3

 

Bugfixes / Features 

 

All

Area Targets

  • We improved the fidelity of the Area Target Capture preview mesh provided by Mesh Observer. The preview mesh is now a more accurate representation of the space that will be covered by the generated Area Target.
  • Area Target Capture now supports scanning up to 80% larger environments on iOS devices with LIDAR sensor. In addition, there should be fewer situations where the Capture can end up entering an unrecoverable LIMITED/RELOCALIZING status.
  • Fixed some cases of large rotational geometry misalignments in the authoring mesh generated by Area Target Capture.
  • We made Area Targets at runtime behave snappier while at the same time requiring less performance, leveraging platform specific improvements and some core improvements. To take full advantage, update your iOS devices to iOS 16 or later.

Model Targets

  • Starting with Vuforia 10.12, we will disable any Guide View related API calls for Observers of Advanced Model Targets. Specifically, GetActiveGuideViewIndex() and GetGuideView() for Unity and vuModelTargetObserverGetActiveGuideViewName() and vuModelTargetObserverGetGuideViews() for Native will have their behavior changed to return VU_FAILED if the Observer uses an Advanced Model Target. Subsequently, it will no longer be possible to access Guide View objects and perform function calls on it.

Android

  • We significantly reduced the file size of the Android FileDriver library.

iOS

  • Area Targets on iOS are now more energy efficient and drain less battery.

UWP

  • Fixed an issue on UWP devices that caused the Vuforia Engine build version log to be missing from the ETW Event Logs.
  • Fixed an issue with Continuous Auto Focus mode in UWP devices and on the HoloLens 2, where smaller objects were not in focus and were difficult to detect and track.
  • Fixed a potential crash when switching camera modes while tracking Image Targets and VuMarks.
Lumin
  • Fixed a problem with getting the camera focus mode on Magic Leap 2.
  • Added missing VuforiaEngine/Engine/Lumin/PlatformConfig_Lumin.h header file to Vuforia Engine SDK for Magic Leap 2.
  • The Vuforia VFX library is compatible with the Magic Leap 2 device.
    • When using VFX on Magic Leap 2 you should enable the *Multipass* rendering flag under Project Settings > XR Plug-in Management > Magic Leap Settings. If this is not done, you will observe an incompatibility causing the Axial-and Radial-Scan effects of the Vuforia VFX library to not work as expected.

Unity

  • New minimum supported version of Unity is 2021.3.
  • Fixed an issue where the Vuforia plugin would not be loaded in the Mac Unity Editor.
  • Updated the GuideView3DBehaviour to use a runtime-generated mesh of the Model Target instead of the packaged mesh. This allows to usage of 3D Guide Views for datasets that are loaded dynamically. Fixed surface normal on the VFX Phantom shader.

 

Known Issues

 

All

Environments

  • 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.
  • Model Targets with Low Feature Objects tracking optimization are more sensitive to wrongly specified physical size in the dataset. The same applies when in camera mode OPTIMIZE_SPEED.

Other

  • 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 does not trigger continuous autofocus by default on ARCore as it does on other platforms. Use VuforiaBehaviour.Instance.CameraDevice.SetFocusMode() to ensure that a focus mode is set consistently across all platforms.
  • 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 the 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 such as Android devices typically provides the emulated storage as the primary location. This means that Vuforia will not usually record to a removable SD card.

iOS

  • When using the Area Target Capture API, the Device Pose Observer may incorrectly relocalize after pause/resume. In this case, the preview mesh for the capture will appear in the wrong location. If the Device Pose Observer reports that it is tracking normally, but the capture remains stuck in relocalizing state for several seconds, then the following instructions to the user may help:
    • Go back to a previously captured area that is visually distinctive and pause/resume the application again. This forces the Device Pose Observer to make a new relocation attempt.
  • When an invalid license is used in an app, it is not reported by vuEngineCreate() and results in a blank screen as no frames are delivered by Vuforia. This issue will only occur during app development.
  • 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

  • When an invalid license is used in an app, it is not reported by vuEngineCreate() and results in a blank screen as no frames are delivered by Vuforia. This issue will only occur during app development.
  • 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
  • Under certain conditions, the Magic Leap One will stop delivering camera frames. The workaround is to restart the App.

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.

Android

  • 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

  • The Virtual Scene Scale Factor in Unity is not supported on HoloLens.
  • In the Unity HoloLens sample, some renderings errors are seen in scene view in the Unity Editor.
  • 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 recommended 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 Vuforia MagicLeap sample app does not fully terminate when pressing the "Exit" button. This issue affects any application built with the Lumin SDK v0.25.0 or above, including apps that don’t use the Vuforia Engine. The app can be force-closed either from the device or from The Lab.
  • 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

  • Selecting different CameraModes has no effect when using ARFoundation.
  • Setting the far clip plane to a large number can cause the video background image to flicker when using the URP in combination with GLES3.
  • 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.
  • 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.
  • 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.10.2

 

Bugfixes / Features 

 

All

Model Targets

  • Fixed a bug where Advanced Model Target databases with multiple targets got stuck in a non-TRACKING state.

Area Targets

  • Area Target Capture will now log messages using the standard log stream during the generation process giving developer richer diagnostics, comparable to the Area Target Generator.
  • Area Target Capture target generation now starts much sooner after calling vuAreaTargetCaptureGenerate() for large captures. There will now be less delay between starting generation and getting feedback about the generation progress.
  • After creating an Area Target Capture and associated Mesh Observer, the Mesh Observer will now publish mesh observations with VU_OBSERVATION_POSE_STATUS_NO_POSE status until the capture is started. Previously it was publishing observations with VU_OBSERVATION_POSE_STATUS_EXTENDED_TRACKED status and an empty mesh.

Other

  • Audio permission management is now decoupled from Engine instance creation. If an app's manifest/property list includes the permission to record audio, then this permission no longer needs to be granted before creating the Engine instance, it can be done any time before using audio capabilities in the Session Recorder Controller. If the permission is not granted, no permission error will be reported by Engine, but the Session Recorder Controller will not support audio data recording.

Android

  • Significantly reduced file size of Android FileDriver library.
  • Improved error handling during video recording on Android.
  • Substantially reduced the frequency of an internal ARCore warning message related to hit tests.
  • Fixed rare video encoding & decoding issues on Apple devices.

iOS

  • Improved performance of iOS LiDAR devices resulting in lower device load, providing a better battery life.
  • Apple have deprecated Bitcode as of Xcode 14, and no longer support app submissions containing Bitcode. A future release of the Vuforia Engine SDK will remove Bitcode from the iOS framework.

UWP

  • Model Target tracking for cars and other large, reflective objects is now significantly improved on the HoloLens 2 through an AI powered tracking technology when using the LOW_FEATURE_OBJECTS tracking optimization. This improvement was previously available on higher end iOS devices and Android devices and has now been extended to the HoloLens 2.
Lumin
  • Added support for Magic Leap 2 devices (alpha).

Unity

  • Fixed an issue where an update notification for a new version of Vuforia Engine would not be shown in the Unity Editor.
  • Area Target Capture Device Pose is no longer stuck in LIMITED - INITIALIZING, when the Audio permissions have not been accepted by the user.

 

Known Issues

 

All

Environments

  • 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.
  • Model Targets with Low Feature Objects tracking optimization are more sensitive to wrongly specified physical size in the dataset. The same applies when in camera mode OPTIMIZE_SPEED.

Other

  • 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 does not trigger continuous autofocus by default on ARCore as it does on other platforms. Use VuforiaBehaviour.Instance.CameraDevice.SetFocusMode() to ensure that a focus mode is set consistently across all platforms.
  • 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 the 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 such as Android devices typically provides the emulated storage as the primary location. This means that Vuforia will not usually record to a removable SD card.

iOS

  • When using the Area Target Capture API, the Device Pose Observer may incorrectly relocalize after pause/resume. In this case, the preview mesh for the capture will appear in the wrong location. If the Device Pose Observer reports that it is tracking normally, but the capture remains stuck in relocalizing state for several seconds, then the following instructions to the user may help:
    • Go back to a previously captured area that is visually distinctive and pause/resume the application again. This forces the Device Pose Observer to make a new relocation attempt.
  • Pause/resume invoked too quickly may cause a wrong pose on iOS devices. If observed, it is recommended to provide an option to the user to reset the tracking, aka reset Device Pose Observer in the application.
  • 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
  • Under certain conditions, the Magic Leap One will stop delivering camera frames. The workaround is to restart the App.

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.

Android

  • 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

  • The Virtual Scene Scale Factor in Unity is not supported on HoloLens.
  • In the Unity HoloLens sample, some renderings errors are seen in scene view in the Unity Editor.
  • 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 Vuforia MagicLeap sample app does not fully terminate when pressing the "Exit" button. This issue affects any application built with the Lumin SDK v0.25.0 or above, including apps that don’t use the Vuforia Engine. The app can be force-closed either from the device or from The Lab.
  • 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

  • Selecting different CameraModes has no effect when using ARFoundation.
  • Setting the far clip plane to a large number can cause the video background image to flicker when using the URP in combination with GLES3.
  • 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.
  • 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.
  • 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.9.3

 

Bugfixes / Features 

 

All

Model Targets

 

  • We introduced new Tracking Optimization options for Model Targets that replace the previous Motion Hint and Tracking Mode. Select between Default and optimization for Low Feature Object tracking, which is useful for cars and other reflective objects with smooth surfaces and few features.
    • 3D scans are now automatically detected during Model Target generation and no longer need to be specified explicitly.
    • Power saving features are now activated by choosing the Engine-wide camera mode preset OPTIMIZED_SPEED.
  • We completely reworked how Advanced Views are specified in the Model Target Generator. Most importantly, we added a new workflow for defining User Volumes that specify where a user can be when initializing tracking of an Advanced Model Target. This is particularly useful in cases where the user can only operate close to a large object (for example, underneath a car servicing it, or inside a truck looking at the dashboard) and cannot get the full target into view to initialize tracking

Area Targets

  • Matterport™ is deprecating the Developer API Key based authentication to access data in the Matterport™ Cloud. The Area Target Generator will also remove this option in an upcoming release.
  • Improved progress and time estimate reported during Area Target Generation. Excess memory usage during this phase now correctly causes the cancellation of the target generation with an appropriate error.

Target Manager

  • We greatly improved database view speed in the Target Manager of the Vuforia Engine Developer Portal.

API changes

  • You can now query the current focus mode when a Vuforia Driver is in use.
  • The focus mode also have following changes:
    • Removed support for FOCUS_MODE_TRIGGERAUTO on devices using ARKit or ARCore.
    • Added support for FOCUS_MODE_FIXED on UWP devices.
    • On a device where it is not possible to determine the current focus mode, FOCUS_MODE_NORMAL will be reported.

Native API changes

  • The Vuforia Engine no longer requests required permissions upon calling vuEngineCreate() on platforms using runtime permission requests. It only checks whether they have been granted and fails with VU_ENGINE_CREATION_ERROR_PERMISSION_ERROR if denied. It's the caller code's responsibility to request all required permissions at the application level. See the Vuforia Engine Lifecycle in Native article on setting up permission requests.
  • The deprecated function vuAnchorObservationGetAnchorId() has been removed. Please use vuAnchorObservationGetInfo() instead.

Android

  • Model Targets on Android devices require an OpenGL ES 3 capable device.
  • Fixed an issue with the focus mode to ensure that it fails properly on all platforms when setting an unsupported focus mode.
  • We improved the speed of starting the camera on certain ARCore devices..

iOS

  • Fixed vuCameraControllerSetFocusMode() to ensure that it fails properly on all platforms when setting an unsupported focus mode.

UWP

N/A
Lumin
  • The Area Target Capture on Magic Leap devices requires an OpenGL ES 3 capable device.

Unity

  • Fixed an issue with the "Override Detection Position" flag on ModelTargetBehaviour not correctly overriding the detection position of the currently selected Guide View.
  • The DepthNormalContour shader in the VFX Library now exposes an optional blinking behavior.
  • The Phantom shader in the VFX Library now exposes an edge luminance parameter.
  • Fixed an issue where the Guide View previews did not show up when imported into the Unity Editor.

 

Known Issues

 

All

Environments

  • 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.
  • Model Targets with Low Feature Objects tracking optimization are more sensitive to wrongly specified physical size in the dataset. The same applies when in camera mode OPTIMIZE_SPEED.

Other

  • Reported bounding-box size via vuObjectTargetObserverGetBoundingBox() API is in some cases not reflecting actual target size.
  • 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 does not trigger continuous autofocus by default on ARCore as it does on other platforms. Use VuforiaBehaviour.Instance.CameraDevice.SetFocusMode() to ensure that a focus mode is set consistently across all platforms.
  • 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 the 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 such as Android devices typically provides the emulated storage as the primary location. This means that Vuforia will not usually record to a removable SD card.

iOS

  • An invalid license key used in an App is not reported by vuEngineCreate and will result in a blank screen as no frames are delivered by Vuforia. This issue will only occur during App development.
  • When using the Area Target Capture API, the Device Pose Observer may incorrectly relocalize after pause/resume. In this case, the preview mesh for the capture will appear in the wrong location. If the Device Pose Observer reports that it is tracking normally, but the capture remains stuck in relocalizing state for several seconds, then the following instructions to the user may help:
    • Go back to a previously captured area that is visually distinctive and pause/resume the application again. This forces the Device Pose Observer to make a new relocation attempt.
  • Pause/resume invoked too quickly may cause a wrong pose on iOS devices. If observed, it is recommended to provide an option to the user to reset the tracking, aka reset Device Pose Observer in the application.
  • 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

  • An invalid license key used in an App is not reported by vuEngineCreate and will result in a blank screen as no frames are delivered by Vuforia. This issue will only occur during App development.
  • 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
  • Under certain conditions, the Magic Leap One will stop delivering camera frames. The workaround is to restart the App.

Unity

Model Targets

  • Advanced Model Target databases with multiple targets can under rare circumstances (in particular after pause-resume cycles) get stuck in a non-TRACKING state. To recover, it is necessary to deactivate and reactivate all Model Target observers.
  • 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.

Android

  • 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

  • The Vuforia HoloLens sample requires to restart Unity after the asset has been completely imported into a project made with Unity 2020.3.24f1 and later.
  • 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 Unity HoloLens sample, some renderings errors are seen in scene view in the Unity Editor.
  • 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 Vuforia MagicLeap sample app does not fully terminate when pressing the "Exit" button. This issue affects any application built with the Lumin SDK v0.25.0 or above, including apps that don’t use the Vuforia Engine. The app can be force-closed either from the device or from The Lab.
  • 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

  • Selecting different CameraModes has no effect when using ARFoundation.
  • Setting the far clip plane to a large number can cause the video background image to flicker when using the URP in combination with GLES3.
  • 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.
  • 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.
  • 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.8.4

 

Bugfixes / Features 

 

All

General

  • Version macros have been added to the VuforiaEngine.h header file to allow developers to make compile-time decisions based on the Vuforia Engine library version.
    • The function vuEngineGetLibraryVersion() was renamed to vuEngineGetLibraryVersionInfo(). The fields of the VuLibraryVersionInfo data structure have been renamed to major, minor, patch, build.
  • vuCameraControllerGetFlashMode and vuCameraControllerGetFocusMode now require that the Vuforia Engine is started.
  • In an upcoming version of Vuforia Engine we will change the Engine behavior so that it will only check for OS-required runtime permissions and operations will fail if they have not been requested and granted. This changes the current behavior where Engine triggers the OS-specific runtime permission request UI itself. Once this change is implemented it will be required that Apps using Vuforia Engine obtain the needed runtime permissions before using Engine. Apps should be modified to make runtime permission requests themselves before the above change is implemented in Vuforia Engine. Note that the Vuforia Engine Unity extension will make the needed runtime permission requests for Apps developed in Unity.

Environments

  • The Area Target Capture API now generates Authoring Models with textured meshes.
  • The Mesh Observer in combination with Area Targets will provide a continuously updated mesh representing the occlusion model for the scene in view, and based on the occlusion mesh provided with the target.
    • Usage of VuMeshObservationBlock without VuMeshObservationBlock::transform and its associated VuPoseInfo::pose is deprecated. See Mesh Observer for details.
    • vuEngineCreateMeshObserverFromAreaTargetCaptureConfig and related structures were moved to AreaTargetCaptureController.h. This might be a breaking change for users that are relying on transitive inclusion of AreaTargetCaptureController.h through MeshObserver.h. For users using the Vuforia Engine umbrella header or correctly including both AreaTargetCaptureController.h and MeshObserver.h headers this change is not breaking.
    • Due to this forward-looking change of the format, Occlusion Mesh 3DT-s generated with SDK 10.8 can only be used with the SDK 10.8 and above. Older Area Targets with all their assets including occlusion continue to be functional.
  • The Area Target Capture can now scan spaces without an Internet connection. The capture is then saved as a 3DT for post-processing in the Area Target Generator. This change in behavior of the API with respect to the occlusion artifact means that starting with Vuforia Engine 10.8 and forward, the Area Target Capture API will generate the occlusion artifact together with the Area Target database.
  • The Vuforia Datasets to track Area Targets for newly generated targets are significantly smaller. This saves storage space of your application, but also improves other runtime KPIs.
  • Fixed an issue where Area Target Capture could get stuck in relocalizing state after pausing and resuming the capture.
  • vuAnchorObservationGetAnchorId() has been deprecated and will be removed in an upcoming Vuforia release. Please use vuAnchorObservationGetInfo() instead.
  • Improved Area Target localization and tracking performance for the cases when the provided location priors from external source have high uncertainty.

Model Targets

  • We improved the training length for Advanced Model Targets. Training length will now be automatically adjusted based on parameters like number of advanced views and recognition ranges. Any Model Target Training done with the Model Target Generator 10.5 or later will benefit from this improvement. The same applies for trainings done through the Model Target Web API using target SDK version 10.5 or later.
  • We further improved the recognition performance of Advanced Model Targets, in particular, for targets with multiple close-up advanced views. Any target trained with the Model Target Generator 10.7 or the Model Target Web API using target SDK 10.7 or later will benefit from this improvement.
  • Fixed an issue where a Model Target would no longer detect after switching from STATIC/DEFAULT to STATIC/CAR.
  • Fixed Guide View image rendering to properly react to changes to the Guide View, camera intrinsics or device orientation.
    • vuGuideViewSetPose will no longer implicitly re-render the Guide View image and therefore no longer destroy the previous Guide View image.
    • vuModelTargetObserverSetActiveGuideViewName will destroy the image of the previous active Guide View.
    • Added a recommendation regarding long running operations to vuGuideViewGetImage.
    • Added a new endpoint vuGuideViewIsImageOutdated to notify when the Guide View pose, camera intrinsics or device orientation have changed. If the returned value is VU_TRUE, the next call to vuGuideViewGetImage will render a new image. The previous Guide View image will be destroyed (if not acquired explicitly).
    • If the Guide View is not active, or it is an advanced view, the empty image returned by vuGuideViewGetImage will not have the image format VU_IMAGE_PIXEL_FORMAT_UNKNOWN and the buffer will be nullptr.

Session Recorder

  • Added an option to specify output directory for recordings.
  • Clarified API documentation to better describe that when using the Session Recorder, changing the device orientation while a recording is in progiress, will cause the recording to stop.

Android

  • The Vuforia native and Unity sample apps on Android are now using a new Android permission called android.permission.HIGH_SAMPLING_RATE_SENSORS in the AndroidManifest.xml to allow the Vuforia Engine to receive IMU sensor readings at a high rate, otherwise device tracking may not work correctly.
  • Addressed an issue where significant memory growth and eventual crash was observed when running Vuforia Engine in an App built with ARCore versions between 1.23 and 1.31 (inclusive).
    • These issues are resolved by upgrading to ARCore version 1.32 that contains significant stability improvements when used with Vuforia Engine.
  • Fixed a rare deadlock during video and audio recording on some Android devices.

iOS

  • Fixed an issue on iOS that prevented the Area Target Capture from running successfully if the active video mode was changed after starting Engine.
  • Fixed a rare deadlock when using the Session Recorder to make a recording that includes audio on iOS devices.
  • Fixed an issue when using File Driver on iOS to playback a recording. If Engine was previously created but not started, a subsequent run where Engine was created and started, led to playback in the wrong orientation.

UWP

  • Using Camera Mode QUALITY on HoloLens 2 will now improve the detection distance for Image Targets, VuMarks and other target types.
  • Area Target Capture mesh observations now behave correctly during the preparing phase when multiple captures are run in a single app session on HoloLens 2. Previously, it was possible for the preview mesh from the previous capture to show up before the new capture had finished preparing.
  • Fixed a problem where a capture with Status Info INTERRUPTED could not be correctly paused and resumed when using the Area Target Capture.
Lumin
  • Area Target Capture mesh observations now behave correctly during the preparing phase when multiple captures are run in a single app session on the Magic Leap 1. Previously, it was possible for the preview mesh from the previous capture to show up before the new capture had finished preparing.

Unity

  • Area Targets in Unity Editor exposes height-clipping to conveniently remove the ceiling from the authoring model during authoring.
  • We unified the way how target previews are handled in the Unity Editor. They are now managed by a dedicated Target Preview script and support generating an occlusion object that can be used to mask out the target at runtime for correct occlusion rendering for all target types. Existing projects can be easily upgraded to the new preview system.
  • We added a log level filter for the log messages written into the Unity log by the Vuforia Engine Unity Extension. This can be controlled through a dropdown in the Vuforia Configuration.
  • The Vuforia Engine Unity sample for HoloLens has been updated to MRTK 2.8.0
  • Fixed a bug that caused Unity Editor on Windows to freeze after Recording Play Mode was restarted multiple times.
  • Fixed an issue where the visual representation of a Ground Plane Stage was not shown in the Unity Editor.
  • Fixed a scene setting in the Vuforia VFX library that prevented height clipping in the minimap sample.
  • Fixed an issue with the DepthNormalContour shader occluding behavior in the Vuforia VFX library.
  • Code duplication in the Vuforia VFX Library has been addressed.
  • Changed Engine behavior to work around issues with some Android devices when using ARCore that would result in a blank screen (no camera frames being received).

 

Known Issues

 

All

Environments

  • The progress and time estimate reported by vuAreaTargetCaptureGetGenerationProgress() and vuAreaTargetCaptureGetGenerationTimeEstimate() do not advance smoothly during the texturing phase of the target generation.
  • 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

  • vuCameraControllerGetFocusMode is currently not supported when a Vuforia Driver is used.
  • VuCameraFocusMode: The focus modes VU_CAMERA_FOCUS_MODE_NORMAL and VU_CAMERA_FOCUS_MODE_TRIGGERAUTO have inconsistent behavior across different platforms.
  • Reported bounding-box size via vuObjectTargetObserverGetBoundingBox() API is in some cases not reflecting actual target size.
  • 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
  • vuCameraControllerSetFocusMode: When setting an unsupported focus mode, the call succeeds and sets the focus mode VU_CAMERA_FOCUS_MODE_CONTINUOUSAUTO instead of failing.
  • Vuforia Engine does not trigger continuous autofocus by default on ARCore as it does on other platforms. Use VuforiaBehaviour.Instance.CameraDevice.SetFocusMode() to ensure that a focus mode is set consistently across all platforms.
  • 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 the 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 such as Android devices typically provides the emulated storage as the primary location. This means that Vuforia will not usually record to a removable SD card.

iOS

  • vuCameraControllerSetFocusMode: When setting an unsupported focus mode, the call succeeds and sets the focus mode VU_CAMERA_FOCUS_MODE_CONTINUOUSAUTO instead of failing.
  • An invalid license key used in an App is not reported by vuEngineCreate and will result in a blank screen as no frames are delivered by Vuforia. This issue will only occur during App development.
  • When using the Area Target Capture API, the Device Pose Observer may incorrectly relocalize after pause/resume. In this case, the preview mesh for the capture will appear in the wrong location. If the Device Pose Observer reports that it is tracking normally, but the capture remains stuck in relocalizing state for several seconds, then the following instructions to the user may help:
    • Go back to a previously captured area that is visually distinctive and pause/resume the application again. This forces the Device Pose Observer to make a new relocation attempt.
  • Pause/resume invoked too quickly may cause a wrong pose on iOS devices. If observed, it is recommended to provide an option to the user to reset the tracking, aka reset Device Pose Observer in the application.
  • 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

  • An invalid license key used in an App is not reported by vuEngineCreate and will result in a blank screen as no frames are delivered by Vuforia. This issue will only occur during App development.
  • 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.

Android

  • 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

  • The Vuforia HoloLens sample requires to restart Unity after the asset has been completely imported into a project made with Unity 2020.3.24f1 and later.
  • 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 Unity HoloLens sample, some renderings errors are seen in scene view in the Unity Editor.
  • 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 Vuforia MagicLeap sample app does not fully terminate when pressing the "Exit" button. This issue affects any application built with the Lumin SDK v0.25.0 or above, including apps that don’t use the Vuforia Engine. The app can be force-closed either from the device or from The Lab.
  • 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

  • Selecting different CameraModes has no effect when using ARFoundation.
  • Setting the far clip plane to a large number can cause the video background image to flicker when using the URP in combination with GLES3.
  • 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.
  • 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.7.2

 

Bugfixes / Features 

 

All

General

  • We removed the deprecated Object Target feature from Vuforia Engine. Please use scanned Model Targets instead.

Environments

  • Fixed an issue where the bounding box of an Area Target generated with the Area Target Capture API may have been miscalculated and made too large.

Objects

  • We significantly reduced the size of Advanced Model Target datasets with multiple models, in particular if multiple views per target are set up.
  • The new Model Target Web API enables streamlined Model Target generation in custom pipelines.
  • Fixed a crash that could be triggered by resetting the Model Target Observer.

Session Recorder

  • The SessionRecorder API was redesigned to be more consistent and easier to use. Please see the API reference library and the API Overview for details.
  • The SessionRecorder API now allows more control over the data captured in a Session Recording.
  • Changed the default set of sources for the SessionRecorder for devices where a platform Device Pose Observer is not present. The sources will now include sensors by default.

Other

  • Fixed incorrect header documentation in VuImageInfo to document the buffer size in pixels instead of bytes.
  • The Sample Target PDF documents were renewed and are now consistent in multiple formats.
  • The Vuforia Engine lifecycle has now more detailed header documentation.

Android

  • Fixed an issue with AI powered (static car) tracking mode for Model Targets on Android devices, where a previously tracked target was not re-detected after moving far away from the target.
  • Model Targets AI powered tracking for low feature objects (static car mode) is now supported on Google Pixel 6 devices.
  • Fixed an issue with SessionRecoder failing on the Samsung Galaxy S21.
  • You must now provide a JavaVM pointer to vuEngineCreate() in the VuPlatformAndroidConfig. This will ensure that Vuforia Engine is using the same JavaVM instance as the rest of the App. This was previously obtained from the JNI_OnLoad() method located in libVuforiaEngine.so.
    • VuPlatformAndroidConfig contains a handle to the Java VM. Get the Java VM by implementing the JNI_OnLoad() function at the app level.
    • The native VuPlatoformAndroidConfigError has a new value: VU_ENGINE_CREATION_ERROR_PLATFORM_ANDROID_CONFIG_INVALID_JAVA_VM. In Unity, it is mapped to VuforiaInitError.PLATFORM_ANDROID_CONFIG_INVALID_JAVA_VM.

iOS

  • The minimum version of Xcode that Vuforia Engine supports has been updated to Xcode 13.2.1.

UWP

  • Model Target tracking for low-feature objects (static car mode introduced with Vuforia Engine 10) is now also supported in the Unity Play mode when playing back recorded sessions.
Lumin N/A

Unity

  • We fixed an issue in the Unity rendering sample where the video background was not distorted when tapped.
  • We fixed an issue in the Unity HoloLens sample related to controlling hand gaze in Unity Play Mode.
  • VFX Library now have harmonized camera settings across all the Model Target sample scenes.

 

Known Issues

 

All

Environments

  • 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.
  • 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
  • We are observing significant memory growth in the ARCore client when running Vuforia Engine in an app that was built with ARCore 1.23 and above that affects most Android devices. Memory growth is in the range of 10-100MB/min. We recommend that apps are not deployed to production with Vuforia Engine 10.3 that includes ARCore 1.23 and above. Instead, please use Vuforia Engine 10.4 or later in combination with ARCore 1.22 or lower. We expect that this issue will be fixed with ARCore 1.32.
  • Vuforia Engine does not trigger continuous autofocus by default on ARCore as it does on other platforms. Use VuforiaBehaviour.Instance.CameraDevice.SetFocusMode() to ensure that a focus mode is set consistently across all platforms.
  • 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 the 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 such as Android devices typically provides the emulated storage as the primary location. This means that Vuforia will not usually record to a removable SD card.

iOS

  • An invalid license key used in an App is not reported by vuEngineCreate and will result in a blank screen as no frames are delivered by Vuforia. This issue will only occur during App development.
  • When using the Area Target Capture API, the Device Pose Observer may incorrectly relocalize after pause/resume. In this case, the preview mesh for the capture will appear in the wrong location. If the Device Pose Observer reports that it is tracking normally, but the capture remains stuck in relocalizing state for several seconds, then the following instructions to the user may help:
    • Go back to a previously captured area that is visually distinctive and pause/resume the application again. This forces the Device Pose Observer to make a new relocation attempt.
  • Pause/resume invoked too quickly may cause a wrong pose on iOS devices. If observed, it is recommended to provide an option to the user to reset the tracking, aka reset Device Pose Observer in the application.
  • 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

  • An invalid license key used in an App is not reported by vuEngineCreate and will result in a blank screen as no frames are delivered by Vuforia. This issue will only occur during App development.
  • 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.

Android

  • 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

  • The Vuforia HoloLens sample requires to restart Unity after the asset has been completely imported into a project made with Unity 2020.3.24f1 and later.
  • 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 Unity HoloLens sample, some renderings errors are seen in scene view in the Unity Editor.
  • 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 Vuforia MagicLeap sample app does not fully terminate when pressing the "Exit" button. This issue affects any application built with the Lumin SDK v0.25.0 or above, including apps that don’t use the Vuforia Engine. The app can be force-closed either from the device or from The Lab.
  • 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.
  • 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.6.3

 

Bugfixes / Features 

 

All

General

  • The behavior of the Static Device Tracking has been updated, please refer to the documentation for details.
  • We have restored the ability to control the way the latest device calibration is fetched from the server during engine initialization. For details please see the API documentation for the VuDeviceCalibrationConfig struct.

Environments

  • The mesh from the Area Target Capture Mesh Observer has been updated to more accurately reflect the true extent of the captured space.
  • The memory consumption is reduced during Area Target Capture.
  • The tracking robustness of anchors created from interactive hit tests on devices using Vuforia VISLAM Fusion technology has been improved.

Objects

  • N/A

Session Recorder

  • The current SessionRecorderController API has been deprecated and will have breaking changes in a future release.

Other

  • N/A

Android

  • Vuforia Engine has increased the minimum supported API level for Android to 26 (Android 8.0 'Oreo').

iOS

  • Fixed an issue where scanned model targets with very large textures failed to load on iOS devices.
  • Fixed a crash on iOS at process termination. The crash only happened during process termination when camera permissions have been previously denied by the user.
  • iOS devices with iOS 13+ now have improved tracking performance for Model Targets when using the STATIC and CAR tracking combination.
  • Fixed a bug on iOS with the Metal render backend. When passing in a user provided texture through the vuRenderControllerUpdateVideoBackgroundTexture API the provided texture was actually ignored and instead an internally created texture was used.

    • Additionally fixed incorrect example code for the user provided texture in the native iOS Vuforia Sample app.

UWP

  • Fixed an error that was logged when starting the HoloLens Unity sample.
Lumin N/A

Unity

  • Fixed an issue where enabling Model Extraction in the Vuforia Configuration in Unity did not work as expected.
  • Fixed an issue that caused augmentations to flicker in Unity under specific circumstances when Device Tracking was disabled.
  • Fixed an issue where an error was logged when exiting the Model Targets scenes in the Unity Core Samples.
  • Fixed an issue where changing the Virtual Scene Scale in Unity at runtime did not work as expected.
  • Fixed an issue where the Mars Lander augmentation in the Unity Core Samples Model Target scene was not textured correctly.
  • The Model Target for the Polaris RZR toy in the Unity Core Samples has been updated to be more accurate. It is now also used in the Standard Model Targets Scene.
  • Disabled unnecessary lighting in the Vignette shader in the VFX library.
  • Unnecessary shadows from the VFX Library sample scenes have been removed.
  • Deprecated Object Target API calls has been removed from the VFX Library.

 

Known Issues

 

All

Environments

  • Area Targets generated with the Area Target Capture API may have a larger than expected bounding box. This is especially likely to occur in situations where an ongoing capture was paused.
  • 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.
  • 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
  • We are observing significant memory growth in the ARCore client when running Vuforia Engine in an app that was built with ARCore 1.23 and above that affects most Android devices. Memory growth is in the range of 10-100MB/min. We recommend that apps are not deployed to production with Vuforia Engine 10.3 or 10.4 that includes ARCore 1.23 and above. Instead, please use Vuforia Engine 10.5 in combination with ARCore 1.22.
  • Vuforia Engine does not trigger continuous autofocus by default on ARCore as it does on other platforms. Use VuforiaBehaviour.Instance.CameraDevice.SetFocusMode() to ensure that a focus mode is set consistently across all platforms.
  • 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 the 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 such as Android devices typically provides the emulated storage as the primary location. This means that Vuforia will not usually record to a removable SD card.

iOS

  • When using the Area Target Capture API, the Device Pose Observer may incorrectly relocalize after pause/resume. In this case, the preview mesh for the capture will appear in the wrong location. If the Device Pose Observer reports that it is tracking normally, but the capture remains stuck in relocalizing state for several seconds, then the following instructions to the user may help:
    • Go back to a previously captured area that is visually distinctive and pause/resume the application again. This forces the Device Pose Observer to make a new relocation attempt.
  • Pause/resume invoked too quickly may cause a wrong pose on iOS devices. If observed, it is recommended to provide an option to the user to reset the tracking, aka reset Device Pose Observer in the application.
  • 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 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

  • 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

  • The Vuforia HoloLens sample requires to restart Unity after the asset has been completely imported into a project made with Unity 2020.3.24f1 and later.
  • 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 Unity HoloLens sample, some renderings errors are seen in scene view in the Unity Editor.
  • 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 Vuforia MagicLeap sample app does not fully terminate when pressing the "Exit" button. This issue affects any application built with the Lumin SDK v0.25.0 or above, including apps that don’t use the Vuforia Engine. The app can be force-closed either from the device or from The Lab.
  • 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.
  • 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.5.5

 

Bugfixes / Features 

 

All

General

  • The Object Targets feature has been deprecated and will be removed in a future release. Please use scanned Model Targets instead.

Environments

  • Mesh Observations for an Area Target Capture are now pushed every frame. The version and timestamp of the observation data can be inspected to determine whether the mesh has changed.

  • The Area Target Capture API has been revised to provide better status information during capture, better error reporting in general, and a more flexible mechanism to generate Area Targets.

Objects

  • Improved recognition performance for Advanced Model Targets while significantly reducing dataset size at the same time. This in particular applies to Advanced Model Targets that are configured with multiple up-close entry points (advanced views).
  • Fixed an issue where VuMark instances where unnecessarily cloned instead of reused.

File Driver

  • FileDriver now supports configuring the playback behavior (start timestamp, end timestamp, loop playback) at runtime for XML and MP4 recordings. Additionally, vuPlatformControllerGetDriverLibraryHandle() has been added to the Vuforia API to make the native handle to the currently loaded driver library accessible.
  • An issue has been fixed where the screen would stay black after stopping and restarting engine while playing back a sequence without device poses using FileDriver.

Other

  • Fixed inconsistent library loading behavior for the Vuforia Driver. Driver libraries are now always loaded during Engine creation and retained until the Engine instance is destroyed.

Android

  • Sensor data recording for the Session Recorder is now disabled by default when ARCore is in as it interferes with tracking on some devices.
  • Fixed an issue that was seen on some Android devices (e.g. Galaxy S20) where starting a session recording severely reduced device tracking quality when using ARCore.

iOS

  • Fixed an issue on iOS where denying the camera permission by the user didn’t cause Engine creation to fail with a VU_ENGINE_CREATION_ERROR_PERMISSION_ERROR error code. Instead, Engine creation succeeded but then delivered only black camera frames. The documentation of vuEngineCreate has been updated to emphasize that it should be called from a background thread and not the main UI thread

UWP

N/A
Lumin N/A

Unity

  • The Vuforia VFX Library now adds brand-new effects for Area Targets (Axial, LightWave, and Minimap) and additional Model Target effects (with LightWave).

  • The camera focus mode can now be controlled globally in the Vuforia Configuration in the Unity Editor. By defaut, it is set to Continuous Autofocus on all platforms. Use the scripting API to change the focus mode dynamically at runtime.

  • The Session Recorder GameObject in Unity now allows simple sharing of recordings. Upload your recording to Dropbox or share it through Apple Airdrop to quickly access recordings from other devices.

  • Fixed an issue that was seen when enabling the Override Detection Position property on a Model Target Behaviour when the Guide View Mode is set to GuideView2D.

  • The Area Target Capture API StartCapture() and GenerateTarget() methods have been updated, as well as the enums delivered by AreaTargetCaptureStatus and AreaTargetCaptureStatusInfo. Please review their updated behaviour in the Unity API reference documentation.

  • The Vuforia VFX Library’s X-Ray shader now exposes more parameters for more fine-grained control of the appearance.

  • An issue has been fixed where the 3D Guide View in the Magic Leap Sample appeared to be rotated by 90 degrees on the device.

 

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.
  • 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
  • We are observing significant memory growth in the ARCore client when running Vuforia Engine in an app that was built with ARCore 1.23 and above that affects most Android devices. Memory growth is in the range of 10-100MB/min. We recommend that apps are not deployed to production with Vuforia Engine 10.3 or 10.4 that includes ARCore 1.23 and above. Instead, please use Vuforia Engine 10.5 in combination with ARCore 1.22.
  • Vuforia Engine does not trigger continuous autofocus by default on ARCore as it does on other platforms. Use VuforiaBehaviour.Instance.CameraDevice.SetFocusMode() to ensure that a focus mode is set consistently across all platforms.
  • 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 the 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 such as Android devices 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 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

  • 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

  • Using the build and run option to build a Unity app for UWP may result in Vuforia Engine not starting correctly. Instead, build and run the generated .sln file in Visual Studio
  • The Vuforia HoloLens sample requires to restart Unity after the asset has been completely imported into a project made with Unity 2020.3.24f1 and later.
  • 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 Unity HoloLens sample, some renderings errors are seen in scene view in the Unity Editor.
  • 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 Vuforia MagicLeap sample app does not fully terminate when pressing the "Exit" button. This issue affects any application built with the Lumin SDK v0.25.0 or above, including apps that don’t use the Vuforia Engine. The app can be force-closed either from the device or from The Lab.
  • 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.
  • 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.4.4

 

Bugfixes / Features 

 

All

General

  • The Vuforia Engine SDK has an updated behavior with respect to when the Vuforia Engine watermark is displayed. Please read the updated licensing terms.
  • The Vuforia Engine watermark design has been updated.

Environments

  • Area Targets now support environments under changing daylight or otherwise challenging conditions.
  • Area Target Capture API, Vuforia Area Target Creator app, and the Area Target Generator now produce the authoring artifact in 3DT format for all target sources.
  • Meshes delivered by the Mesh Observer now include vertex normals.
  • Improved generated authoring mesh quality on iOS devices.

Objects

  • Static Car Mode for Model Targets has been further improved to provide more accurate poses at detection time. This fixes various issues where the initial pose was incorrect, in particular for challenging, feature-poor and reflective objects.
  • Advanced Model Targets can now be trained with "Upside-Down" recognition orientation. This is useful if an object should be recognized when upside down, e.g. for maintenance use cases. See the Guide View article for details.
  • Model Target datasets created with Model Target Generator versions earlier than 7.5 are no longer supported.

Session Recorder

  • Recorded sessions can now be paused when playing them back in Unity Editor Play Mode.

Other

  • The enums VuCameraVideoModePreset and VuCameraFocusMode have been moved from the Core.h header to the CameraController.h header in the Vuforia API.

Android

  • Fixed an issue where session recording did not work correctly on the Google Pixel 3.

iOS

  • An issue where Vuforia Engine memory usage was too high on iOS causing apps to crash has been resolved. The problem was typically seen during app start or resume from a paused state and common on older devices with fewer RAM.
  • Shader compatibility issues observed on iOS when using the VFX Library has been resolved.

UWP

  • An issue where VuMarks were not working on UWP devices with the locale set to something different than English was resolved.
Lumin
  • An issue with shader compatibility issues observed on Magic Leap when running the Vuforia VFX Library assets have been resolved.

Unity

  • Native support for Apple Silicon has been for Unity Play Mode.
  • A new scene demonstrating the Area Targets feature has been added to the Unity Core samples. A prerecorded session is included to allow testing the sample from Unity Editor Play Mode.
  • Vuforia Engine is now properly excluded from Unity platforms it is not supported on. Building to these platforms (e.g. WebGL) will no longer cause build issues.
  • Fixed an issue in Unity where an error was encountered if the FIRST_TARGET World Center Mode was selected and the scene was reloaded.
  • Fixed an issue where the Field of View (FoV) was reported incorrectly in Unity in some cases.
  • Vuforia Engine fully supports development with the OpenXR Plugin in Unity 2020.3 and later.
  • The Unity HoloLens sample has been upgraded to MRTK 2.7.3 and is now using OpenXR. The sample is now compatible with newer versions of Unity. Support for HoloLens 1 is dropped from this sample.
  • A new API has been introduced when integrating with OpenXR on HoloLens. Please see the API documentation for the method vuPlatformControllerSetHolographicAppCSFromIUnknown in the UWP PlatformController.
  • Support for Single-Pass Instanced Rendering mode for RadialFade, X-Ray, UnlitColorTexture and VolumeTexture shaders in the VFX Library has been added.
  • An issue where ARCore was included a second time by Vuforia Engine, thus causing an error when integrating with ARFoundation in Unity has been resolved.
  • Unused fonts have been removed from the Unity Extension.

 

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.
  • Panorama location indicators may not show up properly above the floor when using Leica scans.
  • 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
  • We are observing significant memory growth in the ARCore client when running Vuforia Engine in an app that was built with ARCore 1.23 and above that affects most Android devices. Memory growth is in the range of 10-100MB/min. We recommend that apps are not deployed to production with Vuforia Engine 10.3 or 10.4 that includes ARCore 1.23 and above. Instead, please use Vuforia Engine 10.4 in combination with ARCore 1.22 or lower.
  • Vuforia Engine does not trigger continuous autofocus by default on ARCore as it does on other platforms. Use VuforiaBehaviour.Instance.CameraDevice.SetFocusMode() to ensure that a focus mode is set consistently across all platforms.
  • 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 the 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 such as Android devices 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 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

  • 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

  • Using the VFX Library effects on the HoloLens may lead to incorrect rendering and other visual artefacts.
  • The Vuforia HoloLens sample requires to restart Unity after the asset has been completely imported into a project made with Unity 2020.3.24f1 and later.
  • 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 Unity HoloLens sample, some renderings errors are seen in scene view in the Unity Editor.
  • 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 3D GuideView for Model Targets in the Magic Leap Sample appears rotated by 90 degrees on the device. However, this doesn’t affect the detection of the Model Target and will be fixed in a later release.
  • The Vuforia MagicLeap sample app does not fully terminate when pressing the "Exit" button. This issue affects any application built with the Lumin SDK v0.25.0 or above, including apps that don’t use the Vuforia Engine. The app can be force-closed either from the device or from The Lab.
  • 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.
  • 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.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