Skip to content

Latest commit

 

History

History
327 lines (221 loc) · 8.83 KB

build.md

File metadata and controls

327 lines (221 loc) · 8.83 KB
Raw

Build Guides

Contents

CMake Options

The following options are used to change the build configuration

VKB_<sample_name>

Choose whether to include a sample at build time.

  • ON - Build Sample
  • OFF - Exclude Sample

Default: ON

VKB_BUILD_SAMPLES

Choose whether to build the samples.

  • ON - Build All Samples
  • OFF - Skip building Samples

Default: ON

VKB_BUILD_TESTS

Choose whether to build the tests

  • ON - Build All Tests
  • OFF - Skip building Tests

Default: OFF

VKB_SYMLINKS

Rather than changing the working directory inside the IDE, VKB_SYMLINKS will enable symlink creation pointing to the root directory which exposes the assets and outputs folders to the samples.

Default: OFF

VKB_ENTRYPOINTS

Generate a build project for each application so that they can be run separately

Default: OFF

VKB_VALIDATION_LAYERS

Enable Validation Layers

Default: OFF

VKB_WARNINGS_AS_ERRORS

Treat all warnings as errors

Default: ON

3D models

Before you build the project make sure you download the 3D models this project uses. Run the helper script bldsys/scripts/download_assets.py. You should now have a scenes folder containing all the 3D scenes the project uses.

On Android, Gradle will run CMake which will sync assets to the device if there has been a change.

However, to sync them manually you may run the following command to ensure up to date assets are on the device:

adb push --sync assets /sdcard/Android/data/com.arm.vulkan_best_practice/files/
adb push --sync shaders /sdcard/Android/data/com.arm.vulkan_best_practice/files/

Performance data

In order for performance data to be displayed, profiling needs to be enabled on the device. Some devices may disable it by default.

Profiling can be enabled via adb:

adb shell setprop security.perf_harden 0

Performance data is captured using HWCPipe. For details on this project and how to integrate it in your pipeline, visit: https://github.com/ARM-software/HWCPipe

Windows

Dependencies

Clang Format and Visual Studio

Visual Studio comes with clang-format-6 which is incompatible with some of the styles we use in our .clang-format file. It is recommended to point to a clang-format-8.exe binary within the in-built clang formatter, or disable it and use a third party extension that is more up to date.

Go to the LLVM downloads page to get clang.

Build with CMake

Please make sure, when running any sample, that you either:

  • Enable Developer Mode
  • Run Command Prompt or Visual Studio as administrator

Step 1. The following command will generate the VS project

cmake -G"Visual Studio 15 2017 Win64" -H. -Bbuild/windows

Step 2. Build the Visual Studio project

cmake --build build/windows --config Release --target vulkan_best_practice

Step 3. Run the Vulkan Best Practice application

build\windows\vulkan_best_practice\bin\Release\AMD64\vulkan_best_practice.exe

Linux

Dependencies

sudo apt-get install cmake g++ xorg-dev libglu1-mesa-dev

Build with CMake

Step 1. The following command will generate the project

cmake -G "Unix Makefiles" -H. -Bbuild/linux -DCMAKE_BUILD_TYPE=Release

Step 2. Build the project

cmake --build build/linux --config Release --target vulkan_best_practice -- -j4

Step 3. Run the Vulkan Best Practice application to display the help message

./build/linux/vulkan_best_practice/bin/Release/x86_64/vulkan_best_practice --help

Mac

Dependencies

Build with CMake

Step 1. The following command will generate the project

cmake -H. -Bbuild/mac -DCMAKE_BUILD_TYPE=Release

Step 2. Build the project

cmake --build build/mac --config Release --target vulkan_best_practice -- -j4

Step 3. Run the Vulkan Best Practice application to display the help message

./build/mac/vulkan_best_practice/bin/Release/x86_64/vulkan_best_practice --help

Android

Dependencies

For all dependencies set the following environment variables.

  • CMake v3.10+
  • JDK 8+ JAVA_HOME=<SYSTEM_DIR>/java
  • Android NDK r18+ ANDROID_NDK_ROOT=<WORK_DIR>/android-ndk
  • Android SDK ANDROID_HOME=<WORK_DIR>/android-sdk
  • Gradle 5+ GRADLE_HOME=<WORK_DIR>/gradle
  • CMake Options
  • 3D models
  • Performance data

Build with Gradle

Step 1. Generate the gradle project using the internal script by running the following command

Windows 
bldsys/scripts/generate_android_gradle.bat
Linux 
./bldsys/scripts/generate_android_gradle.sh

A new folder will be created in the root directory at build\android_gradle

Step 2. Build the project

cd build/android_gradle
gradle assembleDebug

Step 3. You can now run the apk on a connected device

adb install build/outputs/apk/debug/vulkan_best_practice-debug.apk

Alternatively, you may open the build/android_gradle folder in Android Studio and run the project from here

Build with CMake

Step 1. Select a generator which supports custom compiler like Unix Makefiles or Ninja.

Step 2. Run the command below in the root directory of the project.

cmake -G "Unix Makefiles" -H. -Bbuild/android -DCMAKE_TOOLCHAIN_FILE=bldsys/toolchain/android_gradle.cmake

Step 3. Build the project using the command below

cmake --build build/android --config Release --target vulkan_best_practice_package

Step 4. You can now run the apk on a connected device

cd build/android/vulkan_best_practice/vulkan_best_practice_package
adb install build/outputs/apk/debug/vulkan_best_practice-debug.apk

Building Individual Samples

Step 1. When generating cmake set the VKB_ENTRYPOINTS flag to ON

cmake -B"build" -H"." -DVKB_ENTRYPOINTS=ON

CMake

Step 2. Set the target to <samplename>_app. For example:

cmake --build build --config Debug --target afbc_app

Visual Studio

Step 2. In the Solution Explorer there now is an Entrypoints folder. Select the <sample>_app you would like to run and set it as the Start Up Project