Oculus Mobile SDK (mirror)

This is a Git mirror of Oculus' Android SDK, provided so that it can be git submodule'd into other projects.

The VrSamples directory has been removed to keep file sizes small. If you wish to use the sample code, please download the ZIP directly from Oculus.

You must still agree to Oculus' licensing terms to use it.

About

The Oculus Mobile SDK includes libraries, tools, and resources for native C/C++ development of Android apps for the Oculus Quest and Oculus Go standalone devices. If you primarily use Unity or Unreal Engine for Android development, it is not necessary to download the Mobile SDK in most cases . For more information on Oculus Mobile development using Unity or Unreal Engine, see Mobile Development with Unity and Unreal.

For documentation on developing for Oculus devices that use Android, see our Mobile SDK Developer Guide.

For details on migrating to Mobile SDK 25.0 (API 1.42) from previous versions, see the Mobile SDK Migration Guide.

Contributing to this repo

When there's an update to the SDK, a new commit can be added to this repo thusly:

1. Head over to the SDK site and download the zip.
2. rm all non-dotfiles in this repo except this README
3. Unzip the zip into this folder
4. Remove VrSamples to get the repo size down.
5. Add an entry to 'Version History' below, copy-pasting from the SDK site
6. Make a nice commit and push away

Version history

Oculus Mobile SDK 25.0 (API 1.42.0) (2021-02-19)

API Changes

• Added a new entry point, vrapi_CreateAndroidSurfaceSwapchain3, for creating an Android surface backed swapchain by passing platform specific create flags defined in ovrAndroidSurfaceSwapChainFlags.
• The vrapi_SubmitFrame and associated structures have been marked deprecated and should no longer be used. The vrapi_SubmitFrame2 path should be used instead.
• The ovrModeFlag, VRAPI_MODE_FLAG_FRONT_BUFFER_PROTECTED, has been removed since protected mode is indicated at the swapchain level via ovrAndroidSurfaceSwapChainFlags flag VRAPI_ANDROID_SURFACE_SWAP_CHAIN_FLAG_PROTECTED.
• The ovrSystemStatus, VRAPI_SYS_STATUS_FRONT_BUFFER_PROTECTED, has been removed.

Bug Fixes

• There are no major bug fixes with this release.

Known SDK Issues

• When building samples, there is an issue when using the latest NDK release. Instead, use NDK 21 until the issue is resolved.

Oculus Mobile SDK 23.0 (API 1.40.0) (2020-12-19)

New Features

• 90 Hz mode is now supported. For information on using this feature, see the Refresh Rate topic.

API Changes

• The ovrDeviceType value, VRAPI_DEVICE_TYPE_OCULUSQUEST2 has been added to the API.
• The ovrTouch bit flags, ovrTouch_ThumbRest, ovrTouch_LThumbRest, and ovrTouch_RThumbRest have been added to the API.
• The ovrEventType value, VRAPI_EVENT_DISPLAY_REFRESH_RATE_CHANGE, has been added to the API. This event is sent when the display refresh rate is * changed by the system.
• The ovrSystemStatus value, VRAPI_SYS_STATUS_SYSTEM_UX_ACTIVE, has been removed from the API.
• The ovrSystemProperty value, VRAPI_SYS_PROP_VIDEO_DECODER_LIMIT, and corresponding structure, ovrVideoDecoderLimit, have been removed from the * API.

Bug Fixes

• There are no major bug fixes with this release.

Known SDK Issues

• There are no known issues with this release.

Oculus Mobile SDK 20.0 (API 1.37.0) (2020-09-02)

API Changes

• The ovrDeviceType values, VRAPI_DEVICE_TYPE_OCULUSGO and VRAPI_DEVICE_TYPE_MIVR_STANDALONE, have been removed from the API.
• The ovrModeFlags flag, VRAPI_MODE_FLAG_FRONT_BUFFER_565, has been removed from the API.
• The ovrSystemStatus value, VRAPI_SYS_STATUS_FRONT_BUFFER_565, has been removed from the API.
• The ovrProperty, VRAPI_BLOCK_REMOTE_BUTTONS_WHEN_NOT_EMULATING_HMT, has been removed from the API.
• The ovrSystemUIType types, VRAPI_SYS_UI_KEYBOARD_MENU and VRAPI_SYS_UI_FILE_DIALOG_MENU, have been removed from the API.
• vrapi_ShowFatalError is now marked deprecated and should no longer be used.
• The deprecated vrapi_ShowSystemUIWithExtra entry point has been removed from the API.

Bug Fixes

• There are no major bug fixes with this release.

Known SDK Issues

• There are no known issues with this release.

Oculus Mobile SDK 19.0 (API 1.36) (2020-08-03)

For details on migrating to Mobile SDK 19.0 (API 1.36) from previous versions, see the Mobile SDK Migration Guide.

API Changes

• A new ovrTextureSwapChain creation method, vrapi_CreateTextureSwapchain4, and corresponding structure, ovrSwapChainCreateInfo, have been added to the API.
• A new ovrControllerType, ovrControllerType_StandardPointer, and corresponding structure, ovrInputStandardPointerCapabilities, have been added to the API.
• The vrapi_SetRemoteEmulation function has been removed from the API and should no longer be used.

Oculus Mobile SDK 15.0 (API 1.32.0) (2020-04-06)

For details on migrating to Mobile SDK 15.0 (API 1.32) from previous versions, see the Mobile SDK Migration Guide.

API Changes

• A new ovrSystemStatus, VRAPI_SYS_STATUS_SCREEN_CAPTURE_RUNNING, has been added, which returns true when recording is enabled
• ovrControllerType_Headset and associated structures have been removed.
• The permission flag in the Android manifest to use hand tracking functionality has changed to: <uses-permission android:name="com.oculus.permission.HAND_TRACKING" />