REQUIREMENTS.md

Requirements

These samples require a Vulkan compliant graphics driver.

To compile the layers, a collocated glslang repository, and a collocated Vulkan-LoaderAndValidationLayers repository are needed. The paths for the collocated repositories will look as follows:

<path>/Vulkan-Samples/
<path>/Vulkan-LoaderAndValidationLayers/
<path>/glslang/

On Windows make sure that the <path> is no more than one folder deep to avoid running into maximum path depth compilation issues.

Windows

Windows 7+ with additional required software packages:

• Microsoft Visual Studio 2013 Professional.
  • Older versions may work, but this has not been tested.
• CMake (from http://www.cmake.org/download/).
  • Tell the installer to "Add CMake to the system PATH" environment variable.
• Python 3.3 or later (from https://www.python.org/downloads/).
  • Select to install the optional sub-package to add Python to the system PATH environment variable.
• Vulkan SDK for Windows (from https://vulkan.lunarg.com).
  • Verify that the VK_SDK_PATH environment variable is set.

Linux

A compatible Linux distribution.

• The samples have been tested with Ubuntu Linux 14.04 and later versions.
• Python 3.3 or later (sudo apt-get install python3).
• Vulkan SDK for Linux (from https://vulkan.lunarg.com).

Samples using Xlib typically require the following packages.

sudo apt-get install libx11-dev
sudo apt-get install libxxf86vm-dev
sudo apt-get install libxrandr-dev

Samples using XCB typically require the following packages:

sudo apt-get install libxcb1-dev
sudo apt-get install libxcb-keysyms1-dev
sudo apt-get install libxcb-icccm4-dev

Samples using Wayland typically require the following packages.

sudo apt-get install libwayland-dev
sudo apt-get install libinput-dev
sudo apt-get install libinput-tools

Samples using Mir typically require the following packages:

sudo apt-get install libmirclient-dev
sudo apt-get install mirlibmircommon-dev
sudo apt-get install mir-platform-input-evdev5

MacOS

Version 10.11 or later.

• Homebrew and components
  • Follow instructions on brew.sh to get homebrew installed. /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
• Make sure Homebrew is at the beginning of the PATH:
  • export PATH=/usr/local/bin:$PATH
• Additional packages.
  • brew install cmake python python3

Android

Android M or earlier.

• Android NDK Revision 11c or later (from https://github.com/android-ndk/ndk/wiki).
  • Older versions may work, but this has not been tested.
• Vulkan SDK for the host platform (from https://vulkan.lunarg.com).
  • Verify that the VK_SDK_PATH environment variable is set.

Android N or later.

• Android NDK Revision 13b or later (from https://github.com/android-ndk/ndk/wiki).
• Read the Android Vulkan guides for more details (from http://developer.android.com/ndk/guides/graphics/index.html).