Switch iOS renderer to Metal

Author: aperezro

UnleashedRecomp/CMakeLists.txt

@@ -465,14 +465,12 @@ if (CMAKE_SYSTEM_NAME STREQUAL "iOS" AND TARGET SDL2::SDL2main)
     list(PREPEND UNLEASHED_RECOMP_SDL_LIBS SDL2::SDL2main)
 endif()
 
-set(UNLEASHED_RECOMP_PLATFORM_LIBS)
-if (CMAKE_SYSTEM_NAME STREQUAL "iOS")
-    list(APPEND UNLEASHED_RECOMP_PLATFORM_LIBS MoltenVK)
-    target_link_options(UnleashedRecomp PRIVATE
-        "LINKER:-u,_vkGetInstanceProcAddr"
-        "LINKER:-ObjC"
-    )
-endif()
+set(UNLEASHED_RECOMP_PLATFORM_LIBS)
+if (CMAKE_SYSTEM_NAME STREQUAL "iOS")
+    target_link_options(UnleashedRecomp PRIVATE
+        "LINKER:-ObjC"
+    )
+endif()
 
 target_link_libraries(UnleashedRecomp PRIVATE
     fmt::fmt

UnleashedRecomp/gpu/video.cpp

@@ -100,24 +100,38 @@ extern "C"
 }
 #endif
 
+#if defined(UNLEASHED_RECOMP_IOS) && defined(__APPLE__) && !defined(SDL_VULKAN_ENABLED)
+#define UNLEASHED_RECOMP_USE_METAL 1
+#endif
+
 namespace plume
 {
 #ifdef UNLEASHED_RECOMP_D3D12
     extern std::unique_ptr<RenderInterface> CreateD3D12Interface();
 #endif
+#ifdef UNLEASHED_RECOMP_USE_METAL
+    extern std::unique_ptr<RenderInterface> CreateMetalInterface();
+#else
 #ifdef SDL_VULKAN_ENABLED
     extern std::unique_ptr<RenderInterface> CreateVulkanInterface(RenderWindow sdlWindow);
 #else
     extern std::unique_ptr<RenderInterface> CreateVulkanInterface();
 #endif
+#endif
 
+#ifdef UNLEASHED_RECOMP_USE_METAL
+    static std::unique_ptr<RenderInterface> CreateMetalInterfaceWrapper() {
+        return CreateMetalInterface();
+    }
+#else
     static std::unique_ptr<RenderInterface> CreateVulkanInterfaceWrapper() {
 #ifdef SDL_VULKAN_ENABLED
         return CreateVulkanInterface(GameWindow::s_renderWindow);
 #else
         return CreateVulkanInterface();
 #endif
     }
+#endif
 }
 
 #pragma pack(push, 1)
@@ -291,6 +305,15 @@ static bool g_vulkan = false;
 static constexpr bool g_vulkan = true;
 #endif
 
+static const char* GetGraphicsApiName()
+{
+#ifdef UNLEASHED_RECOMP_USE_METAL
+    return "Metal";
+#else
+    return g_vulkan ? "Vulkan" : "D3D12";
+#endif
+}
+
 static bool g_triangleStripWorkaround = false;
 
 static bool g_hardwareResolve = true;
@@ -1755,6 +1778,8 @@ bool Video::CreateHostDevice(const char *sdlVideoDriver, bool graphicsApiRetry)
 
     interfaceFunctions.push_back(g_vulkan ? CreateVulkanInterfaceWrapper : CreateD3D12Interface);
     interfaceFunctions.push_back(g_vulkan ? CreateD3D12Interface : CreateVulkanInterfaceWrapper);
+#elif defined(UNLEASHED_RECOMP_USE_METAL)
+    interfaceFunctions.push_back(CreateMetalInterfaceWrapper);
 #else
     interfaceFunctions.push_back(CreateVulkanInterfaceWrapper);
 #endif
@@ -2529,7 +2554,7 @@ static void DrawProfiler()
         ImGui::Text("Hardware Depth Resolve: %s", g_hardwareDepthResolve ? "Enabled" : "Disabled");
         ImGui::NewLine();
 
-        ImGui::Text("API: %s", g_vulkan ? "Vulkan" : "D3D12");
+        ImGui::Text("API: %s", GetGraphicsApiName());
         ImGui::Text("Device: %s", g_device->getDescription().name.c_str());
         ImGui::Text("Device Type: %s", DeviceTypeName(g_device->getDescription().type));
         ImGui::Text("VRAM: %.2f MiB", (double)(g_device->getDescription().dedicatedVideoMemory) / (1024.0 * 1024.0));

UnleashedRecomp/ui/game_window.cpp

@@ -6,6 +6,9 @@
 #include <app.h>
 #include <sdl_listener.h>
 #include <SDL_syswm.h>
+#ifdef __APPLE__
+#include <SDL_metal.h>
+#endif
 
 #if _WIN32
 #include <dwmapi.h>
@@ -227,8 +230,13 @@ void GameWindow::Init(const char* sdlVideoDriver)
 #elif defined(__linux__)
     s_renderWindow = { info.info.x11.display, info.info.x11.window };
 #elif defined(__APPLE__)
+    s_metalView = SDL_Metal_CreateView(s_pWindow);
+#ifdef UNLEASHED_RECOMP_IOS
+    s_renderWindow.window = s_metalView;
+#else
     s_renderWindow.window = info.info.cocoa.window;
-    s_renderWindow.view = SDL_Metal_GetLayer(SDL_Metal_CreateView(s_pWindow));
+#endif
+    s_renderWindow.view = s_metalView != nullptr ? SDL_Metal_GetLayer(s_metalView) : nullptr;
 #else
     static_assert(false, "Unknown platform.");
 #endif
@@ -449,6 +457,8 @@ uint32_t GameWindow::GetWindowFlags()
 
 #ifdef SDL_VULKAN_ENABLED
     flags |= SDL_WINDOW_VULKAN;
+#elif defined(__APPLE__)
+    flags |= SDL_WINDOW_METAL;
 #endif
 
     return flags;

UnleashedRecomp/ui/game_window.h

@@ -3,6 +3,9 @@
 #include <plume_render_interface_types.h>
 #include <user/config.h>
 #include <sdl_events.h>
+#ifdef __APPLE__
+#include <SDL_metal.h>
+#endif
 
 #define DEFAULT_WIDTH 1280
 #define DEFAULT_HEIGHT 720
@@ -14,6 +17,9 @@ class GameWindow
 public:
     static inline SDL_Window* s_pWindow = nullptr;
     static inline plume::RenderWindow s_renderWindow;
+#ifdef __APPLE__
+    static inline SDL_MetalView s_metalView = nullptr;
+#endif
 
     static inline int s_x;
     static inline int s_y;

thirdparty/CMakeLists.txt

@@ -15,7 +15,10 @@ set(SDL2MIXER_OPUS OFF)
 set(SDL2MIXER_VORBIS "VORBISFILE")
 set(SDL2MIXER_WAVPACK OFF)
 
-if (CMAKE_SYSTEM_NAME MATCHES "Linux" OR CMAKE_SYSTEM_NAME STREQUAL "iOS")
+if (CMAKE_SYSTEM_NAME STREQUAL "iOS")
+    set(SDL_VULKAN_ENABLED OFF CACHE BOOL "" FORCE)
+    set(SDL_VULKAN OFF CACHE BOOL "" FORCE)
+elseif (CMAKE_SYSTEM_NAME MATCHES "Linux")
     set(SDL_VULKAN_ENABLED ON CACHE BOOL "")
 endif()
 
@@ -38,8 +41,9 @@ endif()
 add_subdirectory("${UNLEASHED_RECOMP_THIRDPARTY_ROOT}/o1heap")
 add_subdirectory("${UNLEASHED_RECOMP_THIRDPARTY_ROOT}/SDL")
 add_subdirectory("${UNLEASHED_RECOMP_THIRDPARTY_ROOT}/SDL_mixer")
-add_subdirectory("${UNLEASHED_RECOMP_THIRDPARTY_ROOT}/plume")
 
 if (APPLE)
     add_subdirectory("${UNLEASHED_RECOMP_THIRDPARTY_ROOT}/MoltenVK")
 endif()
+
+add_subdirectory("${UNLEASHED_RECOMP_THIRDPARTY_ROOT}/plume")

tools/apply_ios_submodule_patches.sh

@@ -3,11 +3,9 @@ set -euo pipefail
 
 ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
 PLUME_DIR="$ROOT/thirdparty/plume"
-PLUME_PATCH_FILE="$ROOT/tools/patches/plume-ios-sdl-vulkan.patch"
+PLUME_PATCH_FILE="$ROOT/tools/patches/plume-ios-metal.patch"
 XENON_RECOMP_DIR="$ROOT/tools/XenonRecomp"
 XENON_RECOMP_PATCH_FILE="$ROOT/tools/patches/xenonrecomp-ios-streaming-memory-map.patch"
-PLUME_VOLK_HEADER="$PLUME_DIR/contrib/volk/volk.h"
-PLUME_VOLK_RENAME_HEADER="$PLUME_DIR/plume_volk_rename_ios.h"
 
 if [[ ! -d "$PLUME_DIR/.git" && ! -f "$PLUME_DIR/.git" ]]; then
     printf 'Missing Plume submodule. Run: git submodule update --init --recursive\n' >&2
@@ -31,18 +29,6 @@ else
     fi
 fi
 
-if [[ ! -f "$PLUME_VOLK_HEADER" ]]; then
-    printf 'Missing Plume volk header: %s\n' "$PLUME_VOLK_HEADER" >&2
-    exit 1
-fi
-
-{
-    printf '#pragma once\n\n'
-    printf '// Keep Plume'\''s embedded volk function-pointer globals from colliding with statically linked MoltenVK on iOS.\n'
-    awk '/^extern PFN_vk/ { name = $3; sub(/;$/, "", name); print "#define " name " plumeVolk_" name }' "$PLUME_VOLK_HEADER"
-} > "$PLUME_VOLK_RENAME_HEADER"
-printf 'Generated Plume iOS volk rename header.\n'
-
 if git -C "$XENON_RECOMP_DIR" apply --check "$XENON_RECOMP_PATCH_FILE" >/dev/null 2>&1; then
     git -C "$XENON_RECOMP_DIR" apply "$XENON_RECOMP_PATCH_FILE"
     printf 'Applied XenonRecomp iOS patch.\n'