On this page
-
+
- Add Validation Layers to Project
- Getting Layer Source -
- Android Studio Integration - - -
- Integrating on the Command Line - -
- Verifying Layer Build
- Enabling Layers
- Enabling the Debug Callback @@ -52,272 +41,94 @@ during development.
- Integrate NDK's Layer Binaries.
- Get source code for validation layers. -
- Build the layers. -
- Incorporate the layers into your app. +
- Verifying Layer Build. +
- Enabling Layers in Vulkan Application. +
-
-Clone the Vulkan directory by entering the following command in your terminal window:
-
-
-$ git clone git@github.com:KhronosGroup/Vulkan-LoaderAndValidationLayers.git -
- -Note: You must have a private SSH key associated with -GitHub, or this command fails with a {@code Permission denied (publickey)} message.
-
-
- -
-Navigate to the directory containing the layer source code, and
-check out the repo's stable Android branch, called {@code android_layers}:
-
-
-$ cd Vulkan-LoaderAndValidationLayers -$ git checkout android_layers -
-
-
- -
-Begin preparation for building by entering the following commands on the command line:
-
-
-
- For Linux or OS X:
-
-
-
-
-
-$ cd build-android -$ ./android-generate
-
-
-
- -
-
- For Windows:
-
-
-
-
-
-> cd build-android -> android-generate.bat
-
-
- -
-
-
- - For Linux or OS X:
-
- -Continue by following the build instructions for your platform. -These instructions are in the {@code BUILD.md} file contained in the local instance of the -repository you cloned. - - - -
-
-Add layers to your Android Studio application's project by specifying their corresponding
-Gradle projects in {@code settings.gradle}, which is normally a peer to app directory.
-The following example shows how to do this, based on the assumption that you're
-using the {@code build.gradle} files from the NDK.
-
-
-// configure your path to the source code generated on your machine -def layerProjRoot = file('/path/to/ndk-root/.../build-android/generated/gradle-build') -String[] layers = ['threading', - 'parameter_validation', - 'object_tracker', - 'core_validation', - 'device_limits', - 'image', - 'swapchain', - 'unique_objects'] -for (layer in layers) { - include ":"+ layer - project(":" + layer.toString()).projectDir = new File("${layerProjRoot}/${layer}") -} --
-
-Your next step is to provide the built layers to the app by installing them.
-
- -
-To install your layers, add the layer Gradle projects to your application's jniLibs dependencies
-in your {@code build.gradle} module. This module normally resides under the {@code app/} directory.
-The following example shows how to do this:
-
-
-android.sources { - main { - jni { ... } - jniLibs { - dependencies { - project ":threading" - project ":parameter_validation" - project ":object_tracker" - project ":core_validation" - project ":device_limits" - project ":image" - project ":swapchain" - project ":unique_objects" - } - } - } -} // android.sources --
- - -Develop, build, and debug as you usually would. When you build, Android Studio automatically -builds the layers and copies them into your APK. - -
- -Debug your application. Android Studio allows you to trace through the layer source code. - -
- -For best performance, remove the layers before you do your release build. - -
This page explains how to:
-
+
Add Validation Layers to Project
+ ++ NDK release 12 and higher includes pre-built validation layer binaries. At + instance and device creation time, when requested by your application, the + Vulkan loader finds them in the APK installed location and loads them. +
+ ++ To use the pre-built validation layer binaries, either modify the gradle build + configuration of your project or manually add the binaries into the JNI + libraries directory of your project. +
+ + +Adding validation layers with Gradle
+ ++ You can add the validation layer your project using either Andorid Studio's + support for CMake and Ndk-build, or using Studio's experimental plugin for + Gradle. In general, you should use the CMake and Ndk-build configuration. +
+ + ++ To add the libraries using Android Studio's support for CMake/Ndk-build, + add the following to your project's gradle configuration: +
+ +
+sourceSets {
+ main {
+ jniLibs {
+ srcDir "${your-ndk-dir}/sources/third_party/vulkan/src/build-android/jniLibs"
+ }
+ }
+}
+
++ To add the libraries using Android Studio's experimental plugin for Gradle, + add the following to your project's gradle configuration: +
+ +
+sources {
+ main {
+ jniLibs {
+ source.srcDir "${your-ndk-dir}/sources/third_party/vulkan/src/build-android/jniLibs"
+ }
+ }
+}
+
+
+Adding validation layers to JNI libraries
+ ++ If configuring your project's gradle build file is not working, you can + manually add the validation layer binaries to your project's JNI libraries + directory by using the following command line options: +
+ +
+$ cd ${your-app-project-root}
+$ mkdir -p app/src/main
+$ cp -fr ${your-ndk-dir}/sources/third_party/vulkan/src/build-android/jniLibs app/src/main/
+
+
+
Getting Layer Source
-This section explains how to build layers from source. -If you have precompiled layers, you can skip this section, and instead read about how to -install your layers using Android Studio or from the -command line. -
-From the NDK (Recommended)
- --NDK Revision 12 and later contains source -code for Android validation layers that is known-good, and ready to build. This code resides under -the {@code <ndk-root>/sources/third_party/vulkan/src/build-android/generated/gradle-build} -directory. This version of the layers should be sufficient for most needs. If so, your next task is -to build them. Alternatively, you can pull source code from the -Khronos Group repository. - -
- -From the repository
- --Although we recommend that you use the source code provided with the NDK, you can also pull more -recent versions of the source code directly from the +If your app needs the latest validation layer, you can pull the latest source from the Khronos Group -GitHub repository belonging to the Khronos Group. To do so, perform the following steps. +GitHub repository and follow the build instructions there.
--
-
Android Studio Integration
--Android Studio builds the validation layers when it builds the rest of the app. -This flow makes it easier for you to trace through the layers at runtime. Each layer's -source code corresponds to a single Gradle project, which you can specify directly in your Android -Studio app. For example, there is a {@code build.gradle} project for threading, and another -one for parameter validation. -
- -Building layers
- --To integrate layers directory into Android Studio application, perform these steps: -
-Installing layers
- -From the Command Line
- -This section explains how to build and install your layers if your project does not use -Android Studio. - -Building layers
- --To build validation layers on Linux or OS X, enter these commands on the command line: -
--
-
-
-Using Gradle:
-
-$ cd generated/gradle-build -$ # configure SDK and NDK path in local.properties -$ gradlew assembleAllDebug -
-
- -
-Using Android makefiles:
-
-$ ndk-build
-
-
-To build validation layers on Windows, enter these commands on the command line: -
--
-
-
-Using Gradle:
-
-> cd generated\gradle-build -> REM configure SDK and NDK path in local.properties -> gradlew.bat assembleAllDebug -
-
- -
-Using Android makefiles:
-
-> ndk-build.cmd -
-
-