v1.16.0

Cardboard SDK v1.16.0 (2022-06-17)

Breaking & behavioral changes

• Removed the fields vk_frame_buffer, vk_queue, vk_semaphore andvk_fence from structure CardboardVulkanDistortionRendererTarget.
• When using Vulkan, the field texture in CardboardEyeTextureDescription has changed its underlying type from VkImage * to VkImage.
• When using Vulkan, a client app is now responsible for calling vkQueueSubmit and vkQueuePresentKHR.

New APIs and capabilities

None.

Deprecations

None.

Other changes

• In iOS SDK, replaced legacy NSURLConnection class (currently deprecated) with NSURLSession class.
• Removed safe area workaround for Unity bug #1288515 since it has been fixed in Unity. See Unity Issue Tracker for the Unity versions that have the fix.

Bug fixes

• Fixed #286: Added a workaround for underlying issue Unity bug #1427493 by setting the focus lost option in the display provider to true to avoid the HUD flickering.
• Fixed bug in the native iOS sample app which prevents the VR view from getting properly updated when scanning a new QR code.

Known issues

• Vulkan distortion renderer is currently in alpha and subject to change.

Tested devices

• Android
  • Google Pixel 2XL (Android 8)
  • Google Pixel 3 (Android 9)
  • Google Pixel 4a (Android 11)
  • Google Pixel 4XL (Android 11)
  • Google Pixel 6 (Android 12)
  • Samsung Galaxy S8 (Android 9)
  • Samsung Galaxy S9 (Exynos) (Android 10)
  • Samsung Galaxy S10 (Exynos) (Android 10)
  • Samsung Galaxy S10+ (Qualcomm) (Android 10)
  • Samsung Galaxy S20 (Qualcomm) (Android 12)
• iOS
  • iPod Touch 7th gen (iOS 12.3)
  • iPhone 6s (iOS 12.5)
  • iPhone X (iOS 14.4)
  • iPhone XR (iOS 14.8)

v1.15.0

Cardboard SDK v1.15.0 (2022-05-03)

Breaking & behavioral changes

• Renamed the native plugin to GfxPluginCardboard from cardboard_api to enable the future Vulkan support in Unity.

New APIs and capabilities

None.

Deprecations

None.

Other changes

None.

Bug fixes

• Fixed #230 via #345: Support Unity Input System Package.

Known issues

• Vulkan distortion renderer is currently in alpha and subject to change.

Tested devices

• Android
  • Google Pixel 2XL (Android 8)
  • Google Pixel 3 (Android 9)
  • Google Pixel 4a (Android 11)
  • Google Pixel 4XL (Android 11)
  • Google Pixel 6 (Android 12)
  • Samsung Galaxy S8 (Android 9)
  • Samsung Galaxy S9 (Exynos) (Android 10)
  • Samsung Galaxy S10 (Exynos) (Android 10)
  • Samsung Galaxy S10+ (Qualcomm) (Android 10)
  • Samsung Galaxy S20 (Qualcomm) (Android 12)
• iOS
  • iPod Touch 6th gen (iOS 12.3)
  • iPhone 6 (iOS 12.5)
  • iPhone 8+ (iOS 11.3)
  • iPhone X (iOS 14.4)
  • iPhone SE (iOS 14.6)

v1.14.0

Cardboard SDK v1.14.0 (2022-04-04)

Breaking & behavioral changes

• Removed the field swapchain_image_count from structure CardboardVulkanDistortionRendererConfig.
• Removed the field vk_swapchain from structure CardboardVulkanDistortionRendererTarget.
• Added the field vk_swapchain to structure CardboardVulkanDistortionRendererConfig
• When using Vulkan, the underlying type of CardboardEyeTextureDescription.texture changed to VkImage* from VkImageView*.
• When using Vulkan, the default texture format change to VK_FORMAT_R8G8B8A8_SRGB from VK_FORMAT_R8G8B8A8_UNORM.

New APIs and capabilities

None

Deprecations

None

Other changes

• Merged #326: Simplify code in CameraSource class.

Bug fixes

• Fixed #199: Now the eyes are correctly renderer when using the Cardboard XR Plugin with URP and Linear Color Space.

Known issues

• Vulkan distortion renderer is currently in alpha and subject to change.

Tested devices

• Android
  • Google Pixel 2XL (Android 8)
  • Google Pixel 3 (Android 9)
  • Google Pixel 4XL (Android 11)
  • Google Pixel 6 (Android 12)
  • Samsung Galaxy S8 (Android 9)
  • Samsung Galaxy S9 (Exynos) (Android 10)
  • Samsung Galaxy S10 (Exynos) (Android 10)
  • Samsung Galaxy S10+ (Qualcomm) (Android 11)
  • Samsung Galaxy S20 (Qualcomm) (Android 11)
• iOS
  • iPod Touch 6th gen (iOS 12.3)
  • iPhone 6 (iOS 12.5)
  • iPhone XR (iOS 14.8)
  • iPhone XS Max (iOS 14.4)

v1.13.0

Cardboard SDK v1.13.0 (2022-03-02)

Breaking & behavioral changes

• Upgraded dependencies in Android SDK and native android sample app:
  • Upgraded androidx.appcompat:appcompat to 1.3.1 from 1.0.0.
  • Upgraded com.google.android.gms:play-services-vision to 20.1.3 from 15.0.2.
  • Upgraded com.google.android.material:material to 1.4.0 from 1.0.0.
  • Upgraded com.google.protobuf:protobuf-javalite to 3.19.4 from 3.10.0.
  • Upgraded com.google.protobuf:protoc to 3.19.4 from 3.10.0.
  • Upgraded Protobuf Gradle Plugin to 0.8.18 from 0.8.16.
• Removed the fields render_pass, command_buffers, image_width and image_height from structure CardboardVulkanDistortionRendererConfig.
• Added the fields vk_render_pass, vk_command_buffer and vk_frame_buffer to structure CardboardVulkanDistortionRendererTarget.

New APIs and capabilities

None

Deprecations

None

Other changes

None

Bug fixes

• Merged #273: Modernize Android SDK and native Android sample app.

Known issues

• Vulkan distortion renderer is currently in alpha and subject to change.

Tested devices

• Android
  • Google Pixel 3A (Android 11)
  • Google Pixel 3XL (Android 12)
  • Google Pixel 5 (Android 12)
  • Google Pixel 5A 5G (Android 12)
  • Google Pixel 6 (Android 12)
  • Samsung Galaxy S8+ (Android 9)
  • Samsung Galaxy S9 (Exynos) (Android 10)
  • Samsung Galaxy S9 (Qualcomm) (Android 9)
• iOS
  • iPod Touch 7th gen (iOS 12.3)
  • iPhone 6 (iOS 12.5)
  • iPhone X (iOS 14.4)
  • iPhone XR (iOS 14.8)

v1.12.0

Cardboard SDK v1.12.0 (2022-02-01)

Breaking & behavioral changes

• Changed Gradle version to 7.3.2 from 6.8.3 in Android SDK and native Android sample app.
• Changed Android Gradle Plugin version to 4.2.2 from 3.6.1 in Android SDK and native Android sample app.
• Changed Protobuf Gradle Plugin version to 0.8.16 from 0.8.15 in Android SDK and native Android sample app.

New APIs and capabilities

• Updated third_party/unity_plugin_api to the version from Unity 2020.3.25f1.

Deprecations

None

Other changes

• Removed unneeded Gradle property buildToolsVersion (not required when using AGP 3.1.0 or higher, see https://developer.android.com/studio/releases/gradle-plugin.html#3-1-0).
• Removed unneeded Gradle properties compileOptions.sourceCompatibility and compileOptions.targetCompatibility (not required when using AGP 4.2.0 or higher, see https://developer.android.com/studio/releases/gradle-plugin#java-8-default).
• Migrated Java repository to Maven Central from JCenter since it has been deprecated and marked as read-only on March 31st, 2021 (see https://developer.android.com/studio/build/jcenter-migration).
• Removed unneeded Java dependency androidx.constraintlayout:constraintlayout.

Bug fixes

• Fixed #54: Now the culling matches the FOV.

Known issues

• Vulkan distortion renderer is currently in alpha and subject to change.

Tested devices

• Android
  • Google Pixel 3A (Android 11)
  • Google Pixel 3XL (Android 11)
  • Google Pixel 4XL (Android 11)
  • Google Pixel 5 (Android 11)
  • Google Pixel 5A 5G (Android 12)
  • Samsung Galaxy S8+ (Android 8)
  • Samsung Galaxy S9 (Exynos) (Android 10)
  • Samsung Galaxy S9 (Qualcomm) (Android 8)
• iOS
  • iPod Touch 7th gen (iOS 12.3)
  • iPhone 6 (iOS 12.5)
  • iPhone X (iOS 14.4)
  • iPhone XR (iOS 14.8)

v1.11.0

Cardboard SDK v1.11.0 (2021-12-14)

Breaking & behavioral changes

• Changed the C API:
  • Renamed the structure CardboardDistortionRendererTargetConfig to CardboardMetalDistortionRendererTargetConfig.
  • Removed the fields texture_sampler, vk_submits_info, and vk_present_info from structure CardboardVulkanDistortionRendererTarget.
  • Added the fields vk_semaphore and vk_swapchain to structure CardboardVulkanDistortionRendererTarget.

New APIs and capabilities

None

Deprecations

None

Other changes

None

Bug fixes

• Fixed #309 via #312: Fixed Metal validation error in the Cardboard XR Plugin.
• Fixed #186: Fixed camera parameters when VR mode is exited in VrMode sample scene.

Known issues

None

Tested devices

• Android
  • Google Pixel 3A (Android 11)
  • Google Pixel 3XL (Android 11)
  • Google Pixel 4XL (Android 11)
  • Google Pixel 5 (Android 11)
  • Google Pixel 5A 5G (Android 12)
  • Samsung Galaxy S8+ (Android 8)
  • Samsung Galaxy S9 (Exynos) (Android 10)
  • Samsung Galaxy S9 (Qualcomm) (Android 8)
• iOS
  • iPod Touch 7th gen (iOS 12.3)
  • iPhone 6 (iOS 12.5)
  • iPhone X (iOS 14.4)
  • iPhone XR (iOS 14.8)
  • iPhone SE (iOS 14.6)

v1.10.0

Cardboard SDK v1.10.0 (2021-11-30)

Breaking & behavioral changes

• Changed Android minimum SDK version to 24 from 18 in Android SDK, sample app, and Unity SDK. If you want to maintain a lower minimum SDK, you must remove Vulkan support by making the following changes. All the locations can be found by searching for "#vulkan":
  • Set minSdkVersion to 16 in sdk/build.gradle.
  • Set minSdkVersion to 16 in hellocardboard-android/build.gradle.
  • Remove all the sources, definitions and dl library requirement that relate to Vulkan from CMakeLists.txt.
• Bitcode is now enabled in the iOS native sample app.

New APIs and capabilities

• Added Vulkan distortion renderer (alpha).

Deprecations

None

Other changes

• Removed bitcode disabling step from Unity build post processor.
• Changed Protobuf dependency version to 3.10.0 from 3.8.0 in Android SDK, native Android sample app and XR Plugin for Android.
• Removed const qualifier from method RenderEyeToDisplay in C++ class DistortionRenderer.

Bug fixes

• Fixed #257: Added a workaround for underlying issue Unity bug #1184957 by using the Unity build post processor to remove the Cardboard SDK .meta files from the bundle.
• Fixed #258: Fixed runtime crash when using the SDK on Android 6 or lower by bumping the Protobuf dependency version.

Known issues

None

Tested devices

• Android
  • Google Pixel 3A (Android 11)
  • Google Pixel 3XL (Android 12)
  • Google Pixel 4XL (Android 12)
  • Google Pixel 5 (Android 11)
  • Google Pixel 5A 5G (Android 12)
  • Samsung Galaxy S8+ (Android 8)
  • Samsung Galaxy S9 (Exynos) (Android 10)
  • Samsung Galaxy S9 (Qualcomm) (Android 9)
• iOS
  • iPod Touch 7th gen (iOS 12.3)
  • iPhone 6 (iOS 12.5)
  • iPhone X (iOS 14.4)
  • iPhone SE (iOS 14.6)

v1.9.0

Cardboard SDK v1.9.0 (2021-10-19)

Breaking & behavioral changes

None

New APIs and capabilities

• Added support for 2021 iPhones (iPhone 13, iPhone 13 Mini, iPhone 13 Pro, iPhone 13 Pro Max).

Deprecations

None

Other changes

• On iOS the C++ SDK no longer uses a prebuilt Protocol Buffers binary. It now uses a CocoaPods Podfile to pull the dependency into the Xcode project at build time. To update your native iOS app, follow the steps in the Download and build the demo app section of the quickstart.
• On iOS updated the Protocol Buffers version to 3.18.0 from 3.10.1.
• The size of the iOS Cardboard library for native and Unity has increased by about 55MB due to the above changes.

Bug fixes

• Fixed a bug that causes a shift in the yaw angle of the head tracker when the viewport orientation changes.
• Fixed #84: Bitcode is now enabled in our iOS SDK project as well as the prepackaged binary distributed with the Unity SDK. It is not enabled in the iOS sample app, but that will be done in the next release.
• Fixed #260, #294: Cardboard SDK and Cardboard XR Plugin can now run on the iOS simulator.

Known issues

None

v1.8.0

Cardboard SDK v1.8.0 (2021-09-10)

Breaking & behavioral changes

• Changed the iOS minimum version to 12.0 from 11.4.

New APIs and capabilities

• Added new properties IsTriggerHeldPressed, MinTriggerHeldPressedTime to the Unity API. These properties detect long holds of the Cardboard trigger and customize the long hold time.

Deprecations

None.

Other changes

• UpdateScreenParams in the Unity API now detects screen orientation changes when autorotation is enabled.
• Added recenter functionality to the Unity sample when holding the Cardboard trigger for three seconds.

Bug fixes

• Fixed #282 via #21: Set descriptive names for Display and Input XR Subsystems.

Known issues

None.

v1.7.0

Cardboard SDK v1.7.0 (2021-07-27)

Breaking & behavioral changes

None.

New APIs and capabilities

• Merged #250: Added multiple orientation support via new parameter to CardboardHeadTracker_getPose (C). In Unity this is automatically used.

Deprecations

None.

Other changes

• URLs with HTTP schemes can now be passed to CardboardQrCode_saveDeviceParams (C), Api.SaveDeviceParams (Unity) since they are internally modified to use HTTPS instead.
• The iOS SDK was modified to perform only HTTPS requests when trying to get the device parameters from a certain URI.

Bug fixes

• Fixed bug in the Unity sample scene which causes the availability of collectable geodesic spheres to be inconsistent.
• Fixed Unity bug #1329845: Metal support now works on Unity 2019.4.27f1 onwards.
• Fixed #253: Fixed eye textures and widgets location when the app is launched on devices with a notch.

Known issues

• #257 and Unity bug #1346978: When importing the Cardboard XR Plugin package and building an Xcode project, the Unity meta files aren't deleted from the bundle directory. This could cause issues when trying to sign the iOS app binary and can be avoided by manually removing the aforementioned meta files from the generated Xcode project.