feat: add molten-vk conan dependency

Author: FlyAndNotDown

Engine/Source/RHI-Vulkan/CMakeLists.txt

@@ -4,10 +4,7 @@ if (${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
     set(platform_sources Src/Platform/Win32Surface.cpp)
 elseif (${CMAKE_SYSTEM_NAME} STREQUAL "Darwin")
     set(platform_sources Src/Platform/MacosSurface.mm)
-    set(platform_ext_libs
-        "-framework Cocoa"
-        "-framework IOKit"
-        "-framework CoreFoundation")
+    set(platform_ext_libs molten-vk::molten-vk "-framework Cocoa" "-framework IOKit" "-framework CoreFoundation")
 endif()
 
 exp_add_library(

Engine/Source/RHI-Vulkan/Src/Instance.cpp

@@ -60,6 +60,10 @@ namespace RHI::Vulkan {
 
     VulkanInstance::VulkanInstance()
     {
+#if PLATFORM_MACOS
+        Common::PlatformUtils::SetEnvVar("VK_DRIVER_FILES", "MoltenVK_icd.json");
+#endif
+
 #if BUILD_CONFIG_DEBUG
         PrepareLayers();
 #endif

Sample/CMakeLists.txt

@@ -37,6 +37,7 @@ function(add_sample)
         RES ${paths}
         NOT_INSTALL
     )
+    add_dependencies(${arg_NAME} ${platform_dep_target})
 endfunction()
 
 if (${CMAKE_SYSTEM_NAME} STREQUAL "Darwin")

ThirdParty/CMakeLists.txt

@@ -28,8 +28,7 @@ if (${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
     set_target_properties(dxc::dxc PROPERTIES RUNTIME_DEP "${dxc_INCLUDE_DIR}/../bin/dxil.dll;${dxc_INCLUDE_DIR}/../bin/dxcompiler.dll")
     set_target_properties(vulkan-validationlayers::vulkan-validationlayers PROPERTIES RUNTIME_DEP "${VulkanValidationLayers_INCLUDE_DIR}/../bin/VkLayer_khronos_validation.dll;${VulkanValidationLayers_INCLUDE_DIR}/../bin/VkLayer_khronos_validation.json")
 elseif (${CMAKE_SYSTEM_NAME} STREQUAL "Darwin")
+    find_package(MoltenVK REQUIRED GLOBAL)
     set_target_properties(vulkan-validationlayers::vulkan-validationlayers PROPERTIES RUNTIME_DEP "${VulkanValidationLayers_INCLUDE_DIR}/../lib/libVkLayer_khronos_validation.dylib;${VulkanValidationLayers_INCLUDE_DIR}/../share/vulkan/explicit_layer.d/VkLayer_khronos_validation.json")
+    set_target_properties(molten-vk::molten-vk PROPERTIES RUNTIME_DEP "${MoltenVK_INCLUDE_DIR}/../lib/libMoltenVK.dylib;${MoltenVK_INCLUDE_DIR}/../lib/MoltenVK_icd.json")
 endif ()
-
-# TODO macos vulkan validation layers runtime dep
-# TODO molten vk

ThirdParty/ConanRecipes/molten-vk/conandata.yml

@@ -0,0 +1,3 @@
+sources:
+  "1.4.1-exp":
+    commit: "db445ff2042d9ce348c439ad8451112f354b8d2a"

ThirdParty/ConanRecipes/molten-vk/conanfile.py

@@ -0,0 +1,88 @@
+import re
+
+from conan import ConanFile
+from conan.tools.build import check_min_cppstd, can_run
+from conan.tools.cmake import cmake_layout, CMakeToolchain, CMakeDeps, CMake
+from conan.tools.files import apply_conandata_patches, copy
+from conan.tools.scm import Git
+import os
+import shutil
+
+required_conan_version = ">=2.0.9"
+
+class MoltenVKConan(ConanFile):
+    name = "molten-vk"
+    description = "molten vk (vulkan driver on macos)"
+    license = "https://github.com/KhronosGroup/MoltenVK?tab=Apache-2.0-1-ov-file"
+    url = "https://github.com/conan-io/conan-center-index"
+    homepage = "https://github.com/KhronosGroup/MoltenVK"
+    topics = ("vulkan", "driver", "macos")
+    package_type = "shared-library"
+    settings = "os", "arch", "compiler", "build_type"
+    options = {}
+    default_options = {}
+
+    def layout(self):
+        cmake_layout(self, src_folder="src")
+
+    def validate(self):
+        check_min_cppstd(self, 17)
+
+    def build_requirements(self):
+        self.tool_requires("ninja/[>=1.12]")
+        self.tool_requires("cmake/[>=3.16]")
+
+    def source(self):
+        git = Git(self)
+        git.clone("https://github.com/KhronosGroup/MoltenVK", target=".")
+        git.checkout(self.conan_data["sources"][self.version]["commit"])
+        apply_conandata_patches(self)
+
+    def generate(self):
+        cmake_toolchain = CMakeToolchain(self, generator="Ninja")
+        cmake_toolchain.generate()
+
+        deps = CMakeDeps(self)
+        deps.generate()
+
+    def build(self):
+        cmake = CMake(self)
+        install_folder = os.path.join(self.build_folder, "installed")
+        cmake.configure(cli_args=[f"-DCMAKE_INSTALL_PREFIX={install_folder}"])
+        cmake.build()
+        cmake.install(cli_args=["--prefix", install_folder])
+
+        lib_root = os.path.join(install_folder, "lib")
+        for entry in os.listdir(lib_root):
+            entry_path = os.path.join(lib_root, entry)
+            if os.path.isdir(entry_path):
+                shutil.rmtree(entry_path)
+            elif os.path.islink(entry_path):
+                os.remove(entry_path)
+            elif entry.startswith("libMoltenVK"):
+                os.rename(entry_path, os.path.join(lib_root, "libMoltenVK.dylib"))
+
+        icd_descriptor_json = os.path.join(install_folder, "etc", "vulkan", "icd.d", "MoltenVK_icd.json")
+        new_icd_descriptor_json = os.path.join(install_folder, "lib", "MoltenVK_icd.json")
+        with open(icd_descriptor_json, "r") as file:
+            content = file.read()
+        new_content = re.sub(r"\"library_path\": \".+\"", "\"library_path\": \"libMoltenVK.dylib\"", content)
+        with open(new_icd_descriptor_json, "w") as file:
+            file.write(new_content)
+
+    def package(self):
+        install_folder = os.path.join(self.build_folder, "installed")
+        copy(self, "*", install_folder, self.package_folder)
+        os.mkdir(os.path.join(self.package_folder, "include"))
+
+    def package_info(self):
+        self.cpp_info.set_property("cmake_file_name", "MoltenVK")
+        self.cpp_info.bindirs = ["bin"]
+        self.cpp_info.includedirs = ["include"]
+        self.cpp_info.libs = []
+        self.cpp_info.libdirs = []
+
+    def test(self):
+        if can_run(self):
+            bin_path = os.path.join(self.cpp.build.bindirs[0], "test_package")
+            self.run(bin_path, env="conanrun")

ThirdParty/ConanRecipes/molten-vk/test_package/CMakeLists.txt

@@ -0,0 +1,12 @@
+cmake_minimum_required(VERSION 3.15)
+project(test_package LANGUAGES CXX)
+
+find_package(MoltenVK REQUIRED)
+
+add_executable(${PROJECT_NAME} test_package.cpp)
+target_link_libraries(${PROJECT_NAME} PRIVATE molten-vk::molten-vk)
+add_custom_command(
+    TARGET ${PROJECT_NAME} POST_BUILD
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${MoltenVK_INCLUDE_DIR}/../lib/libMoltenVK.dylib $<TARGET_FILE_DIR:${PROJECT_NAME}>/libMoltenVK.dylib
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${MoltenVK_INCLUDE_DIR}/../lib/MoltenVK_icd.json $<TARGET_FILE_DIR:${PROJECT_NAME}>/MoltenVK_icd.json
+)

ThirdParty/ConanRecipes/molten-vk/test_package/conanfile.py

@@ -0,0 +1,25 @@
+from conan import ConanFile
+from conan.tools.build import can_run
+from conan.tools.cmake import cmake_layout, CMake
+import os
+
+
+class TestPackageConan(ConanFile):
+    settings = "os", "arch", "compiler", "build_type"
+    generators = "CMakeDeps", "CMakeToolchain"
+
+    def layout(self):
+        cmake_layout(self)
+
+    def requirements(self):
+        self.requires(self.tested_reference_str)
+
+    def build(self):
+        cmake = CMake(self)
+        cmake.configure()
+        cmake.build()
+
+    def test(self):
+        if can_run(self):
+            bin_path = os.path.join(self.cpp.build.bindir, "test_package")
+            self.run(bin_path, env="conanrun")

ThirdParty/ConanRecipes/molten-vk/test_package/test_package.cpp

@@ -0,0 +1,4 @@
+int main(int argc, char* argv[])
+{
+    return 0;
+}

conanfile.py

@@ -15,7 +15,6 @@ def requirements(self):
         self.requires("vulkan-loader/1.4.313.0")
         self.requires("vulkan-memory-allocator/3.3.0")
         self.requires("spirv-cross/1.4.313.0")
-
         if self.settings.os == "Windows":
             self.requires("directx-headers/1.610.2")
 
@@ -28,5 +27,5 @@ def requirements(self):
         self.requires("clipp/1.2.3-exp")
         self.requires("dxc/1.8.2505.1-exp")
         self.requires("vulkan-validationlayers/1.4.313.0-exp")
-
-        # TODO molten-vk
+        if self.settings.os == "Macos":
+            self.requires("molten-vk/1.4.1-exp")