Vulkan: use VK_EXT_metal_surface extension on Apple platforms

TheMostDiligent · TheMostDiligent · commit fed9573fc414 · 2024-08-24T17:17:38.000-07:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -222,21 +222,28 @@ endif()
 if(PLATFORM_IOS OR PLATFORM_TVOS)
     if(VULKAN_SDK OR MOLTENVK_LIBRARY)
         if(NOT MOLTENVK_LIBRARY)
-            set(MoltenVK_FRAMEWORK "${VULKAN_SDK}/MoltenVK/MoltenVK.xcframework")
-            if(PLATFORM_IOS)
-                if(CMAKE_OSX_SYSROOT STREQUAL "iphonesimulator" OR PLATFORM_IOS_SIMULATOR)
-                    set(MOLTENVK_LIBRARY "${MoltenVK_FRAMEWORK}/ios-arm64_x86_64-simulator/libMoltenVK.a")
-                else()
-                    set(MOLTENVK_LIBRARY "${MoltenVK_FRAMEWORK}/ios-arm64/libMoltenVK.a")
-                endif()
-            elseif(PLATFORM_TVOS)
-                if(CMAKE_OSX_SYSROOT STREQUAL "appletvsimulator" OR PLATFORM_TVOS_SIMULATOR)
-                    set(MOLTENVK_LIBRARY "${MoltenVK_FRAMEWORK}/tvos-arm64_x86_64-simulator/libMoltenVK.a")
+            set(MoltenVK_FRAMEWORK "${VULKAN_SDK}/macOS/lib/MoltenVK.xcframework")
+            if(NOT EXISTS "${MoltenVK_FRAMEWORK}")
+                set(MoltenVK_FRAMEWORK "${VULKAN_SDK}/MoltenVK/MoltenVK.xcframework")
+            endif()
+            if(EXISTS "${MoltenVK_FRAMEWORK}")
+                if(PLATFORM_IOS)
+                    if(CMAKE_OSX_SYSROOT STREQUAL "iphonesimulator" OR PLATFORM_IOS_SIMULATOR)
+                        set(MOLTENVK_LIBRARY "${MoltenVK_FRAMEWORK}/ios-arm64_x86_64-simulator/libMoltenVK.a")
+                    else()
+                        set(MOLTENVK_LIBRARY "${MoltenVK_FRAMEWORK}/ios-arm64/libMoltenVK.a")
+                    endif()
+                elseif(PLATFORM_TVOS)
+                    if(CMAKE_OSX_SYSROOT STREQUAL "appletvsimulator" OR PLATFORM_TVOS_SIMULATOR)
+                        set(MOLTENVK_LIBRARY "${MoltenVK_FRAMEWORK}/tvos-arm64_x86_64-simulator/libMoltenVK.a")
+                    else()
+                        set(MOLTENVK_LIBRARY "${MoltenVK_FRAMEWORK}/tvos-arm64_arm64e/libMoltenVK.a")
+                    endif()
                 else()
-                    set(MOLTENVK_LIBRARY "${MoltenVK_FRAMEWORK}/tvos-arm64_arm64e/libMoltenVK.a")
+                    message(FATAL_ERROR "Unexpected platform")
                 endif()
             else()
-                message(FATAL_ERROR "Unexpected platform")
+                message(WARNING "Unable to find MoltenVK.xcframework at ${VULKAN_SDK}/macOS/lib or ${VULKAN_SDK}/MoltenVK")
             endif()
         endif()
 
diff --git a/Graphics/GraphicsEngineVulkan/CMakeLists.txt b/Graphics/GraphicsEngineVulkan/CMakeLists.txt
@@ -298,9 +298,9 @@ if(PLATFORM_WIN32)
 elseif(PLATFORM_LINUX)
     set(PRIVATE_COMPILE_DEFINITIONS VK_USE_PLATFORM_XCB_KHR=1 VK_USE_PLATFORM_XLIB_KHR=1 DILIGENT_USE_VOLK=1)
 elseif(PLATFORM_MACOS)
-    set(PRIVATE_COMPILE_DEFINITIONS VK_USE_PLATFORM_MACOS_MVK=1 DILIGENT_USE_VOLK=1)
+    set(PRIVATE_COMPILE_DEFINITIONS VK_USE_PLATFORM_METAL_EXT=1 DILIGENT_USE_VOLK=1)
 elseif(PLATFORM_IOS OR PLATFORM_TVOS)
-    set(PRIVATE_COMPILE_DEFINITIONS VK_USE_PLATFORM_IOS_MVK=1)
+    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)
 else()
diff --git a/Graphics/GraphicsEngineVulkan/src/SwapChainVkImpl.cpp b/Graphics/GraphicsEngineVulkan/src/SwapChainVkImpl.cpp
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -89,23 +89,14 @@ void SwapChainVkImpl::CreateSurface()
 
         err = vkCreateAndroidSurfaceKHR(m_VulkanInstance->GetVkInstance(), &surfaceCreateInfo, NULL, &m_VkSurface);
     }
-#elif defined(VK_USE_PLATFORM_IOS_MVK)
-    if (m_Window.pCALayer != nullptr)
+#elif defined(VK_USE_PLATFORM_METAL_EXT)
+    if (void* pLayer = m_Window.GetLayer())
     {
-        VkIOSSurfaceCreateInfoMVK surfaceCreateInfo{};
-        surfaceCreateInfo.sType = VK_STRUCTURE_TYPE_IOS_SURFACE_CREATE_INFO_MVK;
-        surfaceCreateInfo.pView = m_Window.pCALayer;
+        VkMetalSurfaceCreateInfoEXT surfaceCreateInfo{};
+        surfaceCreateInfo.sType  = VK_STRUCTURE_TYPE_METAL_SURFACE_CREATE_INFO_EXT;
+        surfaceCreateInfo.pLayer = pLayer;
 
-        err = vkCreateIOSSurfaceMVK(m_VulkanInstance->GetVkInstance(), &surfaceCreateInfo, nullptr, &m_VkSurface);
-    }
-#elif defined(VK_USE_PLATFORM_MACOS_MVK)
-    if (m_Window.pNSView != nullptr)
-    {
-        VkMacOSSurfaceCreateInfoMVK surfaceCreateInfo{};
-        surfaceCreateInfo.sType = VK_STRUCTURE_TYPE_MACOS_SURFACE_CREATE_INFO_MVK;
-        surfaceCreateInfo.pView = m_Window.pNSView;
-
-        err = vkCreateMacOSSurfaceMVK(m_VulkanInstance->GetVkInstance(), &surfaceCreateInfo, NULL, &m_VkSurface);
+        err = vkCreateMetalSurfaceEXT(m_VulkanInstance->GetVkInstance(), &surfaceCreateInfo, NULL, &m_VkSurface);
     }
 #elif defined(VK_USE_PLATFORM_WAYLAND_KHR)
     if (m_Window.pDisplay != nullptr)
@@ -765,6 +756,17 @@ void SwapChainVkImpl::Present(Uint32 SyncInterval)
             m_SemaphoreIndex = m_SwapChainDesc.BufferCount - 1; // To start with 0 index when acquire next image
 
             res = AcquireNextImage(pImmediateCtxVk);
+
+#if PLATFORM_APPLE
+            // For some reason, on MoltenVk we may get VK_SUBOPTIMAL_KHR first time we
+            // acquire the image after the swap chain has been recreated.
+            // Recreating it yet again seems to fix the problem.
+            if (res == VK_SUBOPTIMAL_KHR)
+            {
+                RecreateVulkanSwapchain(pImmediateCtxVk);
+                res = AcquireNextImage(pImmediateCtxVk);
+            }
+#endif
         }
         DEV_CHECK_ERR(res == VK_SUCCESS, "Failed to acquire next swap chain image");
     }
diff --git a/Graphics/GraphicsEngineVulkan/src/VulkanUtilities/VulkanInstance.cpp b/Graphics/GraphicsEngineVulkan/src/VulkanUtilities/VulkanInstance.cpp
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -246,11 +246,8 @@ VulkanInstance::VulkanInstance(const CreateInfo& CI) :
 #if defined(VK_USE_PLATFORM_XCB_KHR)
         InstanceExtensions.push_back(VK_KHR_XCB_SURFACE_EXTENSION_NAME);
 #endif
-#if defined(VK_USE_PLATFORM_IOS_MVK)
-        InstanceExtensions.push_back(VK_MVK_IOS_SURFACE_EXTENSION_NAME);
-#endif
-#if defined(VK_USE_PLATFORM_MACOS_MVK)
-        InstanceExtensions.push_back(VK_MVK_MACOS_SURFACE_EXTENSION_NAME);
+#if defined(VK_USE_PLATFORM_METAL_EXT)
+        InstanceExtensions.push_back(VK_EXT_METAL_SURFACE_EXTENSION_NAME);
 #endif
     };
 
diff --git a/Graphics/ShaderTools/src/GLSLangUtils.cpp b/Graphics/ShaderTools/src/GLSLangUtils.cpp
@@ -32,7 +32,7 @@
 #include <memory>
 #include <array>
 
-#if (defined(VK_USE_PLATFORM_IOS_MVK) || defined(VK_USE_PLATFORM_MACOS_MVK))
+#ifdef VK_USE_PLATFORM_METAL_EXT
 #    include <MoltenGLSLToSPIRVConverter/GLSLToSPIRVConverter.h>
 #else
 #    ifndef ENABLE_HLSL
diff --git a/Platforms/Apple/CMakeLists.txt b/Platforms/Apple/CMakeLists.txt
@@ -26,6 +26,10 @@ set(SOURCE
     ../Linux/src/LinuxFileSystem.cpp
 )
 
+if(PLATFORM_MACOS)
+	list(APPEND SOURCE src/MacOSNativeWindow.mm)
+endif()
+
 add_library(Diligent-ApplePlatform ${SOURCE} ${INTERFACE} ${PLATFORM_INTERFACE_HEADERS})
 set_common_target_properties(Diligent-ApplePlatform)
 
diff --git a/Platforms/Apple/interface/IOSNativeWindow.h b/Platforms/Apple/interface/IOSNativeWindow.h
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -42,6 +42,11 @@ struct IOSNativeWindow
     explicit IOSNativeWindow(void* _pCALayer) noexcept :
         pCALayer{_pCALayer}
     {}
+
+    void* GetLayer() const
+    {
+        return pCALayer;
+    }
 #endif
 };
 
diff --git a/Platforms/Apple/interface/MacOSNativeWindow.h b/Platforms/Apple/interface/MacOSNativeWindow.h
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -42,6 +42,8 @@ struct MacOSNativeWindow
     explicit MacOSNativeWindow(void* _pNSView) noexcept :
         pNSView(_pNSView)
     {}
+
+    void* GetLayer() const;
 #endif
 };
 
diff --git a/Platforms/Apple/interface/TVOSNativeWindow.h b/Platforms/Apple/interface/TVOSNativeWindow.h
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2024 Diligent Graphics LLC
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -41,6 +41,11 @@ struct TVOSNativeWindow
     explicit TVOSNativeWindow(void* _pCALayer) noexcept :
         pCALayer{_pCALayer}
     {}
+
+    void* GetLayer() const
+    {
+        return pCALayer;
+    }
 #endif
 };
 
diff --git a/Platforms/Apple/src/MacOSNativeWindow.mm b/Platforms/Apple/src/MacOSNativeWindow.mm
@@ -0,0 +1,37 @@
+/*
+ *  Copyright 2024 Diligent Graphics LLC
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF ANY PROPRIETARY RIGHTS.
+ *
+ *  In no event and under no legal theory, whether in tort (including negligence),
+ *  contract, or otherwise, unless required by applicable law (such as deliberate
+ *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
+ *  liable for any damages, including any direct, indirect, special, incidental,
+ *  or consequential damages of any character arising as a result of this License or
+ *  out of the use or inability to use the software (including but not limited to damages
+ *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and
+ *  all other commercial damages or losses), even if such Contributor has been advised
+ *  of the possibility of such damages.
+ */
+
+#include "MacOSNativeWindow.h"
+
+#import <AppKit/AppKit.h>
+
+namespace Diligent 
+{
+
+void* MacOSNativeWindow::GetLayer() const
+{
+    return pNSView ? (__bridge void*)((__bridge NSView*)pNSView).layer : nullptr;
+}
+
+} // namespace Diligent

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,10 @@ set(SOURCE`
`26`	`26`	`../Linux/src/LinuxFileSystem.cpp`
`27`	`27`	`)`
`28`	`28`
	`29`	`+if(PLATFORM_MACOS)`
	`30`	`+ list(APPEND SOURCE src/MacOSNativeWindow.mm)`
	`31`	`+endif()`
	`32`	`+`
`29`	`33`	`add_library(Diligent-ApplePlatform ${SOURCE} ${INTERFACE} ${PLATFORM_INTERFACE_HEADERS})`
`30`	`34`	`set_common_target_properties(Diligent-ApplePlatform)`
`31`	`35`