Vulkan: use standalone volk library instead of headers to avoid link conflicts

Author: TheMostDiligent

BuildTools/CMake/VulkanUtils.cmake

@@ -0,0 +1,25 @@
+# Returns platform-specific Vulkan definitions
+function(get_vulkan_platform_definitions OutVarName)
+    if(PLATFORM_WIN32)
+        set(Defs
+            VK_USE_PLATFORM_WIN32_KHR=1
+        )
+    elseif(PLATFORM_LINUX)
+        set(Defs
+            VK_USE_PLATFORM_XCB_KHR=1
+            VK_USE_PLATFORM_XLIB_KHR=1
+        )
+    elseif(PLATFORM_APPLE)
+        set(Defs
+            VK_USE_PLATFORM_METAL_EXT=1
+        )
+    elseif(PLATFORM_ANDROID)
+        set(Defs
+            VK_USE_PLATFORM_ANDROID_KHR=1
+        )
+    else()
+        message(FATAL_ERROR "Unsupported platform")
+    endif()
+
+    set(${OutVarName} ${Defs} PARENT_SCOPE)
+endfunction()

Graphics/GraphicsEngineVulkan/CMakeLists.txt

@@ -1,5 +1,7 @@
 cmake_minimum_required (VERSION 3.10)
 
+include(../../BuildTools/CMake/VulkanUtils.cmake)
+
 project(Diligent-GraphicsEngineVk CXX)
 
 set(INCLUDE
@@ -248,9 +250,9 @@ else()
 endif()
 
 if(PLATFORM_WIN32)
-    list(APPEND PRIVATE_DEPENDENCIES volk::volk_headers)
+    list(APPEND PRIVATE_DEPENDENCIES volk::volk)
 elseif(PLATFORM_MACOS)
-    list(APPEND PRIVATE_DEPENDENCIES volk::volk_headers)
+    list(APPEND PRIVATE_DEPENDENCIES volk::volk)
 elseif(PLATFORM_IOS OR PLATFORM_TVOS)
     find_library(CORE_GRAPHICS CoreGraphics)
     find_library(METAL_LIBRARY Metal)
@@ -260,9 +262,9 @@ elseif(PLATFORM_IOS OR PLATFORM_TVOS)
     # Note that volk may be defined by external CMake, but we don't use it on iOS/tvOS
     list(APPEND PRIVATE_DEPENDENCIES ${MOLTENVK_LIBRARY} ${CORE_GRAPHICS} ${METAL_LIBRARY} ${QUARTZ_CORE} ${UI_KIT} ${IO_SURFACE})
 elseif(PLATFORM_LINUX)
-    list(APPEND PRIVATE_DEPENDENCIES volk::volk_headers)
+    list(APPEND PRIVATE_DEPENDENCIES volk::volk)
 elseif(PLATFORM_ANDROID)
-    list(APPEND PRIVATE_DEPENDENCIES volk::volk_headers)
+    list(APPEND PRIVATE_DEPENDENCIES volk::volk)
 else()
     find_library(Vulkan_LIBRARY NAMES vulkan)
     list(APPEND PRIVATE_DEPENDENCIES ${Vulkan_LIBRARY})
@@ -299,18 +301,19 @@ if (MINGW_BUILD)
 endif()
 
 if(PLATFORM_WIN32)
-    set(PRIVATE_COMPILE_DEFINITIONS VK_USE_PLATFORM_WIN32_KHR=1 NOMINMAX DILIGENT_USE_VOLK=1)
+    set(PRIVATE_COMPILE_DEFINITIONS NOMINMAX DILIGENT_USE_VOLK=1)
 elseif(PLATFORM_LINUX)
-    set(PRIVATE_COMPILE_DEFINITIONS VK_USE_PLATFORM_XCB_KHR=1 VK_USE_PLATFORM_XLIB_KHR=1 DILIGENT_USE_VOLK=1)
+    set(PRIVATE_COMPILE_DEFINITIONS DILIGENT_USE_VOLK=1)
 elseif(PLATFORM_MACOS)
-    set(PRIVATE_COMPILE_DEFINITIONS VK_USE_PLATFORM_METAL_EXT=1 DILIGENT_USE_VOLK=1)
+    set(PRIVATE_COMPILE_DEFINITIONS DILIGENT_USE_VOLK=1)
 elseif(PLATFORM_IOS OR PLATFORM_TVOS)
-    set(PRIVATE_COMPILE_DEFINITIONS VK_USE_PLATFORM_METAL_EXT=1)
 elseif(PLATFORM_ANDROID)
-    set(PRIVATE_COMPILE_DEFINITIONS VK_USE_PLATFORM_ANDROID_KHR=1 DILIGENT_USE_VOLK=1)
+    set(PRIVATE_COMPILE_DEFINITIONS DILIGENT_USE_VOLK=1)
 else()
     message(FATAL_ERROR "Unknown platform")
 endif()
+get_vulkan_platform_definitions(VULKAN_PLATFORM_DEFINES)
+list(APPEND PRIVATE_COMPILE_DEFINITIONS ${VULKAN_PLATFORM_DEFINES})
 
 if (${DILIGENT_NO_GLSLANG})
     message("GLSLang is not being built. Vulkan backend will only be able to consume SPIRV byte code.")

Graphics/GraphicsEngineVulkan/src/VulkanUtilities/Instance.cpp

@@ -34,7 +34,6 @@
 #include <array>
 
 #if DILIGENT_USE_VOLK
-#    define VOLK_IMPLEMENTATION
 #    include "volk.h"
 #endif
 

Tests/GPUTestFramework/CMakeLists.txt

@@ -111,7 +111,7 @@ if(PLATFORM_LINUX)
 endif()
 
 if(VULKAN_SUPPORTED)
-    target_link_libraries(Diligent-GPUTestFramework PUBLIC Vulkan::Headers volk::volk_headers)
+    target_link_libraries(Diligent-GPUTestFramework PUBLIC Vulkan::Headers volk::volk)
 
     if(PLATFORM_LINUX)
         target_link_libraries(Diligent-GPUTestFramework

Tests/GPUTestFramework/src/Vulkan/TestingEnvironmentVk.cpp

@@ -32,7 +32,6 @@
 
 #include "GLSLangUtils.hpp"
 
-#define VOLK_IMPLEMENTATION
 #include "volk.h"
 
 namespace Diligent

ThirdParty/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required (VERSION 3.11)
+cmake_minimum_required (VERSION 3.13)
 
 # cmake_minimum_required(VERSION) resets all policies to their default
 # values for the VERSION, so calling cmake_policy(SET CMP0063 NEW) has
@@ -150,16 +150,22 @@ if (VULKAN_SUPPORTED OR METAL_SUPPORTED OR WEBGPU_SUPPORTED OR (ARCHIVER_SUPPORT
         CXX_VISIBILITY_PRESET hidden # -fvisibility=hidden
         C_VISIBILITY_PRESET hidden # -fvisibility=hidden
         VISIBILITY_INLINES_HIDDEN TRUE
-     )
+    )
 else()
     set(DILIGENT_USE_SPIRV_TOOLCHAIN FALSE CACHE INTERNAL "")
 endif()
 
-if (VULKAN_SUPPORTED AND (PLATFORM_WIN32 OR PLATFORM_LINUX OR PLATFORM_MACOS OR PLATFORM_ANDROID) AND (NOT TARGET volk::volk_headers))
+if (VULKAN_SUPPORTED AND (PLATFORM_WIN32 OR PLATFORM_LINUX OR PLATFORM_MACOS OR PLATFORM_ANDROID) AND (NOT TARGET volk::volk))
+    include(../BuildTools/CMake/VulkanUtils.cmake)
     set(VOLK_PULL_IN_VULKAN OFF)
     set(VOLK_INSTALL OFF)
-    set(VOLK_HEADERS_ONLY ON)
+    set(VOLK_HEADERS_ONLY OFF)
     add_subdirectory(volk)
+    target_link_libraries(volk PRIVATE Vulkan::Headers)
+    get_vulkan_platform_definitions(VULKAN_PLATFORM_DEFINES)
+    target_compile_definitions(volk PRIVATE ${VULKAN_PLATFORM_DEFINES})
+    set_common_target_properties(volk)
+    set_directory_root_folder("volk" "DiligentCore/ThirdParty")
     install(FILES "${volk_SOURCE_DIR}/LICENSE.md" DESTINATION "Licenses/ThirdParty/${DILIGENT_CORE_DIR}" RENAME Volk-License.md)
 endif()