Hello VK is an Android C++ sample that draws the simple, but traditional Hello World Triangle.
Aside from the base functionality the source code also covers convenient features such as:
- Vulkan validation layers. See section below for information on how to enable these
- Vulkan pre-rotation to enable fast and seamless screen rotation implemented on the application side. You can read more about it here: https://developer.android.com/games/optimize/vulkan-prerotation
- Android Studio 4.2+ with NDK bundle.
- Download Android Studio
- Launch Android Studio.
- Open the sample directory.
- Open File/Project Structure...
- Click Download or Select NDK location.
- Click File/Sync Project with Gradle Files.
- Click Run/Run 'app'.
As the validation layer is a sizeable download, we chose to not ship them within the apk. As such in order to enable validation layer, please follow the simple steps below:
- Download the latest android binaries from: https://github.com/KhronosGroup/Vulkan-ValidationLayers/releases
- Place them in their respective ABI folders located in: app/src/main/jniLibs
- Go to hellovk.h, search for 'bool enableValidationLayers = false' and toggle that to true.
As Vulkan is well documented we will not provide detailed instructions regarding the innerworkings of Vulkan. You should however, find useful comments and references regarding the android to vulkan bridge. We chose to use Android Glue for a seamless experience. More details here: https://developer.android.com/reference/games/game-activity/group/android-native-app-glue
These vulkan tutorials should hopefully cover everything needed to understand the workings of the Vulkan app: https://vulkan-tutorial.com https://vkguide.dev/docs/chapter-1/vulkan_init_flow/
Lastly, you will notice that the Kotlin file is somewhat redundant. Luckily, if you do not require any additional/custom application behaviour, the Android(Kotlin) source files can be completely removed and the AndroidManifest.xml tweaked as specified here: https://developer.android.com/ndk/samples/sample_na
If you've found an error in these samples, please file an issue.
Patches are encouraged, and may be submitted by forking this project and submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.