1 # The name of our project is "VULKAN". CMakeLists files in this project can
2 # refer to the root source directory of the project as ${VULKAN_SOURCE_DIR} and
3 # to the root binary directory of the project as ${VULKAN_BINARY_DIR}.
4 cmake_minimum_required(VERSION 2.8.11)
6 # set (CMAKE_VERBOSE_MAKEFILE 1)
8 # The API_NAME allows renaming builds to avoid conflicts with installed SDKs
9 # The MAJOR number of the version we're building, used in naming
10 # <api-name>-<major>.dll (and other files).
11 set(API_NAME "Vulkan" CACHE STRING "API name to use when building")
13 string(TOLOWER ${API_NAME} API_LOWERCASE)
15 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
16 find_package(PythonInterp 3 REQUIRED)
18 if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
19 set(FALLBACK_CONFIG_DIRS "/etc/xdg" CACHE STRING
20 "Search path to use when XDG_CONFIG_DIRS is unset or empty or the current process is SUID/SGID. Default is freedesktop compliant.")
21 set(FALLBACK_DATA_DIRS "/usr/local/share:/usr/share" CACHE STRING
22 "Search path to use when XDG_DATA_DIRS is unset or empty or the current process is SUID/SGID. Default is freedesktop compliant.")
24 include(FindPkgConfig)
25 option(BUILD_WSI_XCB_SUPPORT "Build XCB WSI support" ON)
26 option(BUILD_WSI_XLIB_SUPPORT "Build Xlib WSI support" ON)
27 option(BUILD_WSI_WAYLAND_SUPPORT "Build Wayland WSI support" ON)
28 option(BUILD_WSI_MIR_SUPPORT "Build Mir WSI support" OFF)
29 set(DEMOS_WSI_SELECTION "XCB" CACHE STRING "Select WSI target for demos (XCB, XLIB, WAYLAND, MIR, DISPLAY)")
31 if (BUILD_WSI_XCB_SUPPORT)
32 find_package(XCB REQUIRED)
35 if (BUILD_WSI_XLIB_SUPPORT)
36 find_package(X11 REQUIRED)
39 if (BUILD_WSI_WAYLAND_SUPPORT)
40 find_package(Wayland REQUIRED)
43 if (BUILD_WSI_MIR_SUPPORT)
44 find_package(Mir REQUIRED)
47 # This option can be used to suppress the installation of artifacts from the
48 # Vulkan-LoaderAndValidationLayers repo while running "make install" for the
49 # VulkanTools and VulkanSamples repos. This can be used to prevent the
50 # overwriting of LVL artifacts when installing these downstream repos.
51 option(INSTALL_LVL_FILES "Install content from LoaderAndValidationLayers repo" ON)
54 set(SCRIPTS_DIR "${CMAKE_CURRENT_SOURCE_DIR}/scripts")
56 # Header file for CMake settings
57 include_directories("${PROJECT_SOURCE_DIR}/include")
59 if (CMAKE_COMPILER_IS_GNUCC OR CMAKE_C_COMPILER_ID MATCHES "Clang")
60 set(COMMON_COMPILE_FLAGS "-Wall -Wextra -Wno-unused-parameter -Wno-missing-field-initializers")
61 set(COMMON_COMPILE_FLAGS "${COMMON_COMPILE_FLAGS} -fno-strict-aliasing -fno-builtin-memcmp")
63 # For GCC version 7.1 or greater, we need to disable the implicit fallthrough warning since
64 # there's no consistent way to satisfy all compilers until they all accept the C++17 standard
65 if (CMAKE_COMPILER_IS_GNUCC AND NOT (CMAKE_CXX_COMPILER_VERSION LESS 7.1))
66 set(COMMON_COMPILE_FLAGS "${COMMON_COMPILE_FLAGS} -Wimplicit-fallthrough=0")
69 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=c99 ${COMMON_COMPILE_FLAGS}")
70 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMMON_COMPILE_FLAGS} -std=c++11 -fno-rtti")
72 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fvisibility=hidden")
73 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fvisibility=hidden")
78 # Treat warnings as errors
79 add_compile_options("$<$<CXX_COMPILER_ID:MSVC>:/WX>")
81 add_compile_options("$<$<CXX_COMPILER_ID:MSVC>:/GR->")
82 # Warn about nested declarations
83 add_compile_options("$<$<CXX_COMPILER_ID:MSVC>:/w34456>")
84 # Warn about potentially uninitialized variables
85 add_compile_options("$<$<CXX_COMPILER_ID:MSVC>:/w34701>")
86 add_compile_options("$<$<CXX_COMPILER_ID:MSVC>:/w34703>")
88 if (NOT MSVC_VERSION LESS 1900)
89 # Enable control flow guard
90 message(STATUS "Building with control flow guard")
91 add_compile_options("$<$<CXX_COMPILER_ID:MSVC>:/guard:cf>")
92 set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} /guard:cf")
93 set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} /guard:cf")
98 set (BUILDTGT_DIR build)
100 set (LIBSOURCE_DIR Lib)
102 option(DISABLE_BUILD_PATH_DECORATION "Disable the decoration of the gslang and SPIRV-Tools build path with MSVC build type info" OFF)
103 option(DISABLE_BUILDTGT_DIR_DECORATION "Disable the decoration of the gslang and SPIRV-Tools build path with target info" OFF)
105 # For Windows, since 32-bit and 64-bit items can co-exist, we build each in its own build directory.
106 # 32-bit target data goes in build32, and 64-bit target data goes into build. So, include/link the
107 # appropriate data at build time.
108 if (DISABLE_BUILDTGT_DIR_DECORATION)
109 set (BUILDTGT_DIR "")
111 set (LIBSOURCE_DIR "")
113 set (BUILDTGT_DIR build)
114 set (BINDATA_DIR Bin)
115 set (LIBSOURCE_DIR Lib)
117 set (BUILDTGT_DIR build32)
118 set (BINDATA_DIR Bin32)
119 set (LIBSOURCE_DIR Lib32)
123 option(BUILD_LOADER "Build loader" ON)
124 option(BUILD_TESTS "Build tests" ON)
125 option(BUILD_LAYERS "Build layers" ON)
126 option(BUILD_DEMOS "Build demos" ON)
127 option(BUILD_VKJSON "Build vkjson" ON)
128 option(CUSTOM_GLSLANG_BIN_ROOT "Use the user defined GLSLANG_BINARY_ROOT" OFF)
129 option(CUSTOM_SPIRV_TOOLS_BIN_ROOT "Use the user defined SPIRV_TOOLS_BINARY_ROOT" OFF)
131 #Choose natural default paths for glslang and SPIRV-Tools binaries to support custom definition by the user on the CMake command line or in the GUI
132 set(GLSLANG_BINARY_ROOT "${CMAKE_BINARY_DIR}/../glslang" CACHE STRING "User defined path to the glslang binaries for this project")
133 set(SPIRV_TOOLS_BINARY_ROOT "${CMAKE_BINARY_DIR}/../SPIRV-Tools" CACHE STRING "User defined path to the SPIRV-Tools binaries for this project")
135 # Define a variable for a default root location to the gslang, SPIRV-Tools and other external sources and cache it to allow the user to customize it as needed
136 set(EXTERNAL_SOURCE_ROOT "${CMAKE_SOURCE_DIR}/external" CACHE STRING "Root path to external sources such as glslang and SPIRV-Tools")
140 if(CUSTOM_GLSLANG_BIN_ROOT)
141 set(GSLANG_FINAL_BINARY_PATH ${GLSLANG_BINARY_ROOT}/${BUILDTGT_DIR})
143 set(GSLANG_FINAL_BINARY_PATH "${EXTERNAL_SOURCE_ROOT}/glslang/${BUILDTGT_DIR}")
146 if(DISABLE_BUILD_PATH_DECORATION)
147 set (DEBUG_DECORATION "")
148 set (RELEASE_DECORATION "")
150 set (DEBUG_DECORATION "Debug")
151 set (RELEASE_DECORATION "Release")
154 # Take some steps to set up a variable pointing to the final glslang binaries given the variety of input options
155 set (GLSLANG_SEARCH_PATH "${GSLANG_FINAL_BINARY_PATH}/glslang/${RELEASE_DECORATION}"
156 "${GSLANG_FINAL_BINARY_PATH}/glslang/OSDependent/Windows/${RELEASE_DECORATION}"
157 "${GSLANG_FINAL_BINARY_PATH}/hlsl/${RELEASE_DECORATION}"
158 "${GSLANG_FINAL_BINARY_PATH}/OGLCompilersDLL/${RELEASE_DECORATION}"
159 "${GSLANG_FINAL_BINARY_PATH}/SPIRV/${RELEASE_DECORATION}" )
161 set (GLSLANG_DEBUG_SEARCH_PATH "${GSLANG_FINAL_BINARY_PATH}/glslang/${DEBUG_DECORATION}"
162 "${GSLANG_FINAL_BINARY_PATH}/glslang/OSDependent/Windows/${DEBUG_DECORATION}"
163 "${GSLANG_FINAL_BINARY_PATH}/hlsl/${DEBUG_DECORATION}"
164 "${GSLANG_FINAL_BINARY_PATH}/OGLCompilersDLL/${DEBUG_DECORATION}"
165 "${GSLANG_FINAL_BINARY_PATH}/SPIRV/${DEBUG_DECORATION}")
167 if(CUSTOM_SPIRV_TOOLS_BIN_ROOT)
168 set (SPIRV_TOOLS_SEARCH_PATH "${SPIRV_TOOLS_BINARY_ROOT}/${BUILDTGT_DIR}/source/${RELEASE_DECORATION}")
169 set (SPIRV_TOOLS_DEBUG_SEARCH_PATH "${SPIRV_TOOLS_BINARY_ROOT}/${BUILDTGT_DIR}/source/${DEBUG_DECORATION}")
171 set (SPIRV_TOOLS_SEARCH_PATH "${EXTERNAL_SOURCE_ROOT}/spirv-tools/${BUILDTGT_DIR}/source/${RELEASE_DECORATION}")
172 set (SPIRV_TOOLS_DEBUG_SEARCH_PATH "${EXTERNAL_SOURCE_ROOT}/spirv-tools/${BUILDTGT_DIR}/source/${DEBUG_DECORATION}")
176 if(CUSTOM_GLSLANG_BIN_ROOT)
177 set (GLSLANG_SEARCH_PATH "${GLSLANG_BINARY_ROOT}/install/lib"
178 "${GLSLANG_BINARY_ROOT}/glslang"
179 "${GLSLANG_BINARY_ROOT}/glslang/OSDependent/Unix"
180 "${GLSLANG_BINARY_ROOT}/OGLCompilersDLL"
181 "${GLSLANG_BINARY_ROOT}/SPIRV"
182 "${GLSLANG_BINARY_ROOT}/hlsl"
183 "${GLSLANG_BINARY_ROOT}/StandAlone")
185 set (GLSLANG_SEARCH_PATH "${EXTERNAL_SOURCE_ROOT}/glslang/${BUILDTGT_DIR}/install/lib" "${CMAKE_SOURCE_DIR}/../x86_64/lib/glslang" )
188 if(CUSTOM_SPIRV_TOOLS_BIN_ROOT)
189 set (SPIRV_TOOLS_SEARCH_PATH "${SPIRV_TOOLS_BINARY_ROOT}/source" )
191 set (SPIRV_TOOLS_SEARCH_PATH "${EXTERNAL_SOURCE_ROOT}/spirv-tools/${BUILDTGT_DIR}/source" "${CMAKE_SOURCE_DIR}/../x86_64/lib/spirv-tools" )
195 find_program(GLSLANG_VALIDATOR NAMES glslangValidator
196 HINTS "${CMAKE_SOURCE_DIR}/external/glslang/${BUILDTGT_DIR}/install/bin"
197 "${GLSLANG_BINARY_ROOT}/StandAlone"
198 "${PROJECT_SOURCE_DIR}/external/${BINDATA_DIR}")
200 find_path(GLSLANG_SPIRV_INCLUDE_DIR SPIRV/spirv.hpp HINTS "${EXTERNAL_SOURCE_ROOT}/glslang"
201 "${CMAKE_SOURCE_DIR}/../glslang"
202 DOC "Path to SPIRV/spirv.hpp")
204 find_path(SPIRV_TOOLS_INCLUDE_DIR spirv-tools/libspirv.h HINTS "${EXTERNAL_SOURCE_ROOT}/spirv-tools/include"
205 "${EXTERNAL_SOURCE_ROOT}/SPIRV-Tools/include"
206 "${CMAKE_SOURCE_DIR}/../spirv-tools/include"
207 "${CMAKE_SOURCE_DIR}/../SPIRV-Tools/include"
208 "${EXTERNAL_SOURCE_ROOT}/source/spirv-tools/external/include"
209 DOC "Path to spirv-tools/libspirv.h")
211 find_library(GLSLANG_LIB NAMES glslang
212 HINTS ${GLSLANG_SEARCH_PATH} )
214 find_library(OGLCompiler_LIB NAMES OGLCompiler
215 HINTS ${GLSLANG_SEARCH_PATH} )
217 find_library(OSDependent_LIB NAMES OSDependent
218 HINTS ${GLSLANG_SEARCH_PATH} )
220 find_library(HLSL_LIB NAMES HLSL
221 HINTS ${GLSLANG_SEARCH_PATH} )
223 find_library(SPIRV_LIB NAMES SPIRV
224 HINTS ${GLSLANG_SEARCH_PATH} )
226 find_library(SPIRV_REMAPPER_LIB NAMES SPVRemapper
227 HINTS ${GLSLANG_SEARCH_PATH} )
229 find_library(SPIRV_TOOLS_LIB NAMES SPIRV-Tools
230 HINTS ${SPIRV_TOOLS_SEARCH_PATH} )
233 add_library(glslang STATIC IMPORTED)
234 add_library(OGLCompiler STATIC IMPORTED)
235 add_library(OSDependent STATIC IMPORTED)
236 add_library(HLSL STATIC IMPORTED)
237 add_library(SPIRV STATIC IMPORTED)
238 add_library(SPVRemapper STATIC IMPORTED)
239 add_library(Loader STATIC IMPORTED)
240 add_library(SPIRV-Tools STATIC IMPORTED)
242 find_library(GLSLANG_DLIB NAMES glslangd
243 HINTS ${GLSLANG_DEBUG_SEARCH_PATH} )
244 find_library(OGLCompiler_DLIB NAMES OGLCompilerd
245 HINTS ${GLSLANG_DEBUG_SEARCH_PATH} )
246 find_library(OSDependent_DLIB NAMES OSDependentd
247 HINTS ${GLSLANG_DEBUG_SEARCH_PATH} )
248 find_library(HLSL_DLIB NAMES HLSLd
249 HINTS ${GLSLANG_DEBUG_SEARCH_PATH} )
250 find_library(SPIRV_DLIB NAMES SPIRVd
251 HINTS ${GLSLANG_DEBUG_SEARCH_PATH} )
252 find_library(SPIRV_REMAPPER_DLIB NAMES SPVRemapperd
253 HINTS ${GLSLANG_DEBUG_SEARCH_PATH} )
254 find_library(SPIRV_TOOLS_DLIB NAMES SPIRV-Tools
255 HINTS ${SPIRV_TOOLS_DEBUG_SEARCH_PATH} )
257 set_target_properties(glslang PROPERTIES
258 IMPORTED_LOCATION "${GLSLANG_LIB}"
259 IMPORTED_LOCATION_DEBUG "${GLSLANG_DLIB}")
260 set_target_properties(OGLCompiler PROPERTIES
261 IMPORTED_LOCATION "${OGLCompiler_LIB}"
262 IMPORTED_LOCATION_DEBUG "${OGLCompiler_DLIB}")
263 set_target_properties(OSDependent PROPERTIES
264 IMPORTED_LOCATION "${OSDependent_LIB}"
265 IMPORTED_LOCATION_DEBUG "${OSDependent_DLIB}")
266 set_target_properties(HLSL PROPERTIES
267 IMPORTED_LOCATION "${HLSL_LIB}"
268 IMPORTED_LOCATION_DEBUG "${HLSL_DLIB}")
269 set_target_properties(SPIRV PROPERTIES
270 IMPORTED_LOCATION "${SPIRV_LIB}"
271 IMPORTED_LOCATION_DEBUG "${SPIRV_DLIB}")
272 set_target_properties(SPVRemapper PROPERTIES
273 IMPORTED_LOCATION "${SPIRV_REMAPPER_LIB}"
274 IMPORTED_LOCATION_DEBUG "${SPIRV_REMAPPER_DLIB}")
275 set_target_properties(SPIRV-Tools PROPERTIES
276 IMPORTED_LOCATION "${SPIRV_TOOLS_LIB}"
277 IMPORTED_LOCATION_DEBUG "${SPIRV_TOOLS_DLIB}")
279 set (GLSLANG_LIBRARIES glslang OGLCompiler OSDependent HLSL SPIRV SPVRemapper)
280 set (SPIRV_TOOLS_LIBRARIES SPIRV-Tools)
282 set (GLSLANG_LIBRARIES ${GLSLANG_LIB} ${OGLCompiler_LIB} ${OSDependent_LIB} ${HLSL_LIB} ${SPIRV_LIB} ${SPIRV_REMAPPER_LIB})
283 set (SPIRV_TOOLS_LIBRARIES ${SPIRV_TOOLS_LIB})
286 set (PYTHON_CMD ${PYTHON_EXECUTABLE})
288 # Define macro used for building vkxml generated files
289 macro(run_vk_xml_generate dependency output)
290 add_custom_command(OUTPUT ${output}
291 COMMAND ${PYTHON_CMD} ${SCRIPTS_DIR}/lvl_genvk.py -registry ${SCRIPTS_DIR}/vk.xml ${output}
292 DEPENDS ${SCRIPTS_DIR}/vk.xml ${SCRIPTS_DIR}/generator.py ${SCRIPTS_DIR}/${dependency} ${SCRIPTS_DIR}/lvl_genvk.py ${SCRIPTS_DIR}/reg.py
296 # Custom target for generated vulkan helper file dependencies
297 add_custom_target(generate_helper_files DEPENDS
298 vk_enum_string_helper.h
299 vk_struct_size_helper.h
300 vk_struct_size_helper.c
304 vk_layer_dispatch_table.h
305 vk_dispatch_table_helper.h
306 vk_extension_helper.h
309 # Rules to build generated helper files
310 run_vk_xml_generate(loader_extension_generator.py vk_layer_dispatch_table.h)
311 run_vk_xml_generate(dispatch_table_helper_generator.py vk_dispatch_table_helper.h)
312 run_vk_xml_generate(helper_file_generator.py vk_safe_struct.h)
313 run_vk_xml_generate(helper_file_generator.py vk_safe_struct.cpp)
314 run_vk_xml_generate(helper_file_generator.py vk_struct_size_helper.h)
315 run_vk_xml_generate(helper_file_generator.py vk_struct_size_helper.c)
316 run_vk_xml_generate(helper_file_generator.py vk_enum_string_helper.h)
317 run_vk_xml_generate(helper_file_generator.py vk_object_types.h)
318 run_vk_xml_generate(helper_file_generator.py vk_extension_helper.h)
321 include(GNUInstallDirs)
323 add_definitions(-DFALLBACK_CONFIG_DIRS="${FALLBACK_CONFIG_DIRS}")
324 add_definitions(-DFALLBACK_DATA_DIRS="${FALLBACK_DATA_DIRS}")
325 add_definitions(-DSYSCONFDIR="${CMAKE_INSTALL_FULL_SYSCONFDIR}")
327 # Make sure /etc is searched by the loader
328 if(NOT (CMAKE_INSTALL_FULL_SYSCONFDIR STREQUAL "/etc"))
329 add_definitions(-DEXTRASYSCONFDIR="/etc")
334 if(INSTALL_LVL_FILES)
335 install(DIRECTORY "${PROJECT_SOURCE_DIR}/include/vulkan" DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
340 "${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in"
341 "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake"
344 add_custom_target(uninstall
345 COMMAND ${CMAKE_COMMAND} -P ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake)
348 # loader: Generic VULKAN ICD loader
349 # tests: VULKAN tests
351 add_subdirectory(loader)
355 add_subdirectory(tests)
359 add_subdirectory(layers)
363 add_subdirectory(demos)
367 add_subdirectory(libs/vkjson)