Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 2.31 KB

BUILD.md

File metadata and controls

39 lines (25 loc) · 2.31 KB
Raw

Building

The repository contains everything required to compile and build the examples on Windows, Linux and Android using a C++ compiler that supports C++11. All required dependencies are included.

Windows

Build status

Use the provided CMakeLists.txt with CMake to generate a build configuration for your favorite IDE or compiler, e.g.:

cmake -G "Visual Studio 14 2015 Win64"

Linux

Build Status

Use the provided CMakeLists.txt with CMake to generate a build configuration for your favorite IDE or compiler.

Window system integration
  • XCB: Default WSI (if no cmake option is specified)
  • Wayland: Use cmake option USE_WAYLAND_WSI (-DUSE_WAYLAND_WSI=ON)
  • DirectToDisplay: Use cmake option USE_D2D_WSI (-DUSE_D2D_WSI=ON)

Android

Building on Android is done using the Gradle Build Tool. Put the bin directory of it somewhere in your path and from the root of the repository run:

cd android
gradle assembleDebug

This will build all samples and output the apks to android\examples\bin.

If you want to build and install on a connected device or emulator image, run gradle installDebug instead.

iOS and macOS

Building for iOS and macOS is done using the examples Xcode project found in the xcode directory. These examples use the MoltenVK Vulkan driver to provide Vulkan support on iOS and macOS, and require an iOS or macOS device that supports Metal. Please see the MoltenVK Examples readme for more info on acquiring MoltenVK and building and deploying the examples on iOS and macOS.