Add Vulkan renderer

client/CMakeLists.txt

@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.19)
 project(looking-glass-client C CXX)
 
 get_filename_component(PROJECT_TOP "${PROJECT_SOURCE_DIR}/.." ABSOLUTE)
@@ -33,6 +33,9 @@ add_feature_info(ENABLE_OPENGL ENABLE_OPENGL "Legacy OpenGL renderer.")
 option(ENABLE_EGL    "Enable the EGL renderer"          ON)
 add_feature_info(ENABLE_EGL ENABLE_EGL "EGL renderer.")
 
+option(ENABLE_VULKAN "Enable the Vulkan renderer"       OFF)
+add_feature_info(ENABLE_VULKAN ENABLE_VULKAN "Vulkan renderer.")
+
 option(ENABLE_BACKTRACE "Enable backtrace support on crash" ON)
 add_feature_info(ENABLE_BACKTRACE ENABLE_BACKTRACE "Backtrace support.")
 
@@ -74,6 +77,13 @@ if (ENABLE_EGL)
   add_definitions(-D ENABLE_EGL)
 endif()
 
+if (ENABLE_VULKAN)
+  add_definitions(-D ENABLE_VULKAN)
+
+  # Vulkan bindings are not present in the default generated bindings
+  set(CIMGUI_GEN_BINDINGS ON)
+endif()
+
 if(ENABLE_ASAN)
   add_compile_options("-fno-omit-frame-pointer" "-fsanitize=address")
   set(EXE_FLAGS "${EXE_FLAGS} -fno-omit-frame-pointer -fsanitize=address")
@@ -138,6 +148,20 @@ set(SOURCES
 # Force cimgui to build as a static library.
 set(IMGUI_STATIC "yes" CACHE STRING "Build as a static library")
 
+# Only generate cimgui bindings if the defaults are not sufficient. This avoids
+# a potentially unnecessary dependency on LuaJIT
+if(CIMGUI_GEN_BINDINGS)
+  message(STATUS "Generating cimgui bindings")
+  file(LOCK "${PROJECT_TOP}/repos/cimgui/generator" DIRECTORY GUARD FILE)
+  execute_process(
+    COMMAND luajit ./generator.lua gcc internal opengl2 opengl3 vulkan
+    WORKING_DIRECTORY "${PROJECT_TOP}/repos/cimgui/generator"
+    OUTPUT_QUIET
+    ERROR_QUIET
+    COMMAND_ERROR_IS_FATAL ANY
+  )
+endif()
+
 add_subdirectory("${PROJECT_TOP}/resources"       "${CMAKE_BINARY_DIR}/resources")
 add_subdirectory("${PROJECT_TOP}/common"          "${CMAKE_BINARY_DIR}/common"   )
 add_subdirectory("${PROJECT_TOP}/repos/LGMP/lgmp" "${CMAKE_BINARY_DIR}/LGMP"     )

client/displayservers/Wayland/CMakeLists.txt

@@ -22,6 +22,7 @@ add_library(displayserver_Wayland STATIC
   presentation.c
   state.c
   registry.c
+  vulkan.c
   wayland.c
   window.c
 )

client/displayservers/Wayland/input.c

@@ -303,7 +303,7 @@ static const struct wl_keyboard_listener keyboardListener = {
 
 static void waylandCleanUpPointer(void)
 {
-  INTERLOCKED_SECTION(wlWm.confineLock, {
+  INTERLOCKED_SECTION(wlWm.surfaceLock, {
     if (wlWm.lockedPointer)
     {
       zwp_locked_pointer_v1_destroy(wlWm.lockedPointer);
@@ -419,15 +419,12 @@ bool waylandInputInit(void)
   wl_seat_add_listener(wlWm.seat, &seatListener, NULL);
   wl_display_roundtrip(wlWm.display);
 
-  LG_LOCK_INIT(wlWm.confineLock);
-
   return true;
 }
 
 void waylandInputFree(void)
 {
   waylandUngrabPointer();
-  LG_LOCK_FREE(wlWm.confineLock);
 
   if (wlWm.pointer)
     waylandCleanUpPointer();
@@ -463,7 +460,7 @@ void waylandGrabPointer(void)
       &relativePointerListener, NULL);
   }
 
-  INTERLOCKED_SECTION(wlWm.confineLock,
+  INTERLOCKED_SECTION(wlWm.surfaceLock,
   {
     if (!wlWm.confinedPointer && !wlWm.lockedPointer)
     {
@@ -477,7 +474,7 @@ void waylandGrabPointer(void)
 inline static void internalUngrabPointer(bool lock)
 {
   if (lock)
-    LG_LOCK(wlWm.confineLock);
+    LG_LOCK(wlWm.surfaceLock);
 
   if (wlWm.confinedPointer)
   {
@@ -486,7 +483,7 @@ inline static void internalUngrabPointer(bool lock)
   }
 
   if (lock)
-    LG_UNLOCK(wlWm.confineLock);
+    LG_UNLOCK(wlWm.surfaceLock);
 
   if (!wlWm.warpSupport)
   {
@@ -517,7 +514,7 @@ void waylandCapturePointer(void)
     return;
   }
 
-  INTERLOCKED_SECTION(wlWm.confineLock,
+  INTERLOCKED_SECTION(wlWm.surfaceLock,
   {
     if (wlWm.confinedPointer)
     {
@@ -533,7 +530,7 @@ void waylandCapturePointer(void)
 
 void waylandUncapturePointer(void)
 {
-  INTERLOCKED_SECTION(wlWm.confineLock,
+  INTERLOCKED_SECTION(wlWm.surfaceLock,
   {
     if (wlWm.lockedPointer)
     {
@@ -582,11 +579,11 @@ void waylandWarpPointer(int x, int y, bool exiting)
   if (!wlWm.pointerInSurface || wlWm.lockedPointer)
     return;
 
-  INTERLOCKED_SECTION(wlWm.confineLock,
+  INTERLOCKED_SECTION(wlWm.surfaceLock,
   {
     if (wlWm.lockedPointer)
     {
-      LG_UNLOCK(wlWm.confineLock);
+      LG_UNLOCK(wlWm.surfaceLock);
       return;
     }
 

client/displayservers/Wayland/vulkan.c

@@ -0,0 +1,75 @@
+/**
+ * Looking Glass
+ * Copyright © 2017-2024 The Looking Glass Authors
+ * https://looking-glass.io
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 2 of the License, or (at your option)
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc., 59
+ * Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+#ifdef ENABLE_VULKAN
+#include "wayland.h"
+
+#include <vulkan/vulkan_wayland.h>
+
+const char * waylandGetVulkanSurfaceExtension(void)
+{
+  return "VK_KHR_wayland_surface";
+}
+
+VkSurfaceKHR waylandCreateVulkanSurface(VkInstance instance)
+{
+  struct VkWaylandSurfaceCreateInfoKHR createInfo =
+  {
+    .sType = VK_STRUCTURE_TYPE_WAYLAND_SURFACE_CREATE_INFO_KHR,
+    .display = wlWm.display,
+    .surface = wlWm.surface
+  };
+
+  VkSurfaceKHR surface;
+  VkResult result = vkCreateWaylandSurfaceKHR(instance, &createInfo, NULL,
+      &surface);
+  if (result != VK_SUCCESS)
+  {
+    DEBUG_ERROR("Failed to create Vulkan Wayland surface (VkResult: %d)",
+        result);
+    return NULL;
+  }
+
+  return surface;
+}
+
+bool waylandVulkanPresent(VkQueue queue, struct VkPresentInfoKHR * presentInfo)
+{
+  waylandPresentationFrame();
+
+  // vkQueuePresentKHR issues a batch of Wayland requests terminated with a
+  // commit. This must be isolated from anything else that may issue a commit
+  // otherwise a half-completed batch may be committed, resulting in a protocol
+  // error and the present operation failing
+  VkResult result;
+  INTERLOCKED_SECTION(wlWm.surfaceLock,
+  {
+    result = vkQueuePresentKHR(queue, presentInfo);
+  });
+
+  if (result != VK_SUCCESS)
+  {
+    DEBUG_ERROR("Failed to present swapchain image (VkResult: %d)", result);
+    return false;
+  }
+
+  return true;
+}
+#endif

client/displayservers/Wayland/wayland.c

@@ -171,6 +171,8 @@ static bool waylandInit(const LG_DSInitParams params)
     return false;
 #endif
 
+  LG_LOCK_INIT(wlWm.surfaceLock);
+
   return true;
 }
 
@@ -184,6 +186,7 @@ static void waylandShutdown(void)
 
 static void waylandFree(void)
 {
+  LG_LOCK_FREE(wlWm.surfaceLock);
   waylandIdleFree();
   waylandWindowFree();
   waylandPresentationFree();
@@ -252,6 +255,12 @@ struct LG_DisplayServerOps LGDS_Wayland =
   .glSetSwapInterval   = waylandGLSetSwapInterval,
   .glSwapBuffers       = waylandGLSwapBuffers,
 #endif
+
+#ifdef ENABLE_VULKAN
+  .getVulkanSurfaceExtension = waylandGetVulkanSurfaceExtension,
+  .createVulkanSurface = waylandCreateVulkanSurface,
+  .vulkanPresent       = waylandVulkanPresent,
+#endif
   .waitFrame           = waylandWaitFrame,
   .skipFrame           = waylandSkipFrame,
   .stopWaitFrame       = waylandStopWaitFrame,

client/displayservers/Wayland/wayland.h

@@ -107,6 +107,7 @@ struct WaylandDSState
   struct wl_seat * seat;
   struct wl_shm * shm;
   struct wl_compositor * compositor;
+  LG_Lock surfaceLock;
 
   wl_fixed_t scale;
   bool fractionalScale;
@@ -163,7 +164,6 @@ struct WaylandDSState
   struct zwp_locked_pointer_v1 * lockedPointer;
   bool showPointer;
   uint32_t pointerEnterSerial;
-  LG_Lock confineLock;
 
   struct zwp_idle_inhibit_manager_v1 * idleInhibitManager;
   struct zwp_idle_inhibitor_v1 * idleInhibitor;
@@ -259,6 +259,12 @@ void waylandGLSetSwapInterval(int interval);
 void waylandGLSwapBuffers(void);
 #endif
 
+#ifdef ENABLE_VULKAN
+const char * waylandGetVulkanSurfaceExtension(void);
+VkSurfaceKHR waylandCreateVulkanSurface(VkInstance instance);
+bool waylandVulkanPresent(VkQueue queue, struct VkPresentInfoKHR * presentInfo);
+#endif
+
 // idle module
 bool waylandIdleInit(void);
 void waylandIdleFree(void);

client/displayservers/X11/x11.c

@@ -51,6 +51,10 @@
 #include "eglutil.h"
 #endif
 
+#ifdef ENABLE_VULKAN
+#include <vulkan/vulkan_xlib.h>
+#endif
+
 #include "app.h"
 #include "common/debug.h"
 #include "common/time.h"
@@ -1563,6 +1567,47 @@ static void x11GLSwapBuffers(void)
 }
 #endif
 
+#ifdef ENABLE_VULKAN
+static const char * x11GetVulkanSurfaceExtension(void)
+{
+  return "VK_KHR_xlib_surface";
+}
+
+static VkSurfaceKHR x11CreateVulkanSurface(VkInstance instance)
+{
+  struct VkXlibSurfaceCreateInfoKHR createInfo =
+  {
+    .sType = VK_STRUCTURE_TYPE_XLIB_SURFACE_CREATE_INFO_KHR,
+    .dpy = x11.display,
+    .window = x11.window
+  };
+
+  VkSurfaceKHR surface;
+  VkResult result = vkCreateXlibSurfaceKHR(instance, &createInfo, NULL,
+      &surface);
+  if (result != VK_SUCCESS)
+  {
+    DEBUG_ERROR("Failed to create Vulkan Xlib surface (VkResult: %d)", result);
+    return NULL;
+  }
+
+  return surface;
+}
+
+static bool x11VulkanPresent(VkQueue queue,
+    struct VkPresentInfoKHR * presentInfo)
+{
+  VkResult result = vkQueuePresentKHR(queue, presentInfo);
+  if (result != VK_SUCCESS)
+  {
+    DEBUG_ERROR("Failed to present swapchain image (VkResult: %d)", result);
+    return false;
+  }
+
+  return true;
+}
+#endif
+
 static bool x11WaitFrame(void)
 {
   /* wait until we are woken up by the present event */
@@ -2008,6 +2053,11 @@ struct LG_DisplayServerOps LGDS_X11 =
   .glMakeCurrent      = x11GLMakeCurrent,
   .glSetSwapInterval  = x11GLSetSwapInterval,
   .glSwapBuffers      = x11GLSwapBuffers,
+#endif
+#ifdef ENABLE_VULKAN
+  .getVulkanSurfaceExtension = x11GetVulkanSurfaceExtension,
+  .createVulkanSurface = x11CreateVulkanSurface,
+  .vulkanPresent       = x11VulkanPresent,
 #endif
   .waitFrame           = x11WaitFrame,
   .stopWaitFrame       = x11StopWaitFrame,

client/include/app.h

@@ -86,6 +86,12 @@ void app_glSetSwapInterval(int interval);
 void app_glSwapBuffers(void);
 #endif
 
+#ifdef ENABLE_VULKAN
+const char * app_getVulkanSurfaceExtension(void);
+VkSurfaceKHR app_createVulkanSurface(VkInstance instance);
+bool app_vulkanPresent(VkQueue queue, struct VkPresentInfoKHR * presentInfo);
+#endif
+
 #define MAX_OVERLAY_RECTS 10
 void app_registerOverlay(const struct LG_OverlayOps * ops, const void * params);
 void app_initOverlays(void);

client/include/interface/displayserver.h

@@ -26,6 +26,10 @@
 #include "common/types.h"
 #include "common/debug.h"
 
+#ifdef ENABLE_VULKAN
+#include <vulkan/vulkan.h>
+#endif
+
 typedef enum LG_ClipboardData
 {
   LG_CLIPBOARD_DATA_TEXT = 0,
@@ -158,6 +162,13 @@ struct LG_DisplayServerOps
   void (*glSwapBuffers)(void);
 #endif
 
+#ifdef ENABLE_VULKAN
+  /* Vulkan support */
+  const char * (*getVulkanSurfaceExtension)(void);
+  VkSurfaceKHR (*createVulkanSurface)(VkInstance instance);
+  bool (*vulkanPresent)(VkQueue queue, struct VkPresentInfoKHR * presentInfo);
+#endif
+
   /* Waits for a good time to render the next frame in time for the next vblank.
    * This is optional and a display server may choose to not implement it.
    *