Linux: Add CMake find module for wayland + make wayland optional (#572)

CMakeLists.txt

@@ -70,6 +70,10 @@ if (APPLE)
     enable_language(OBJC OBJCXX)
 endif()
 
+if (UNIX AND NOT APPLE)
+	option(ENABLE_WAYLAND "Build with Wayland support" ON)
+endif()
+
 option(ENABLE_OPENGL "Enables the OpenGL backend" ON)
 option(ENABLE_VULKAN "Enables the Vulkan backend" ON)
 option(ENABLE_DISCORD_RPC "Enables the Discord Rich Presence feature" ON)
@@ -114,6 +118,10 @@ endif()
 
 if (UNIX AND NOT APPLE)
 	find_package(X11 REQUIRED)
+	if (ENABLE_WAYLAND)
+		find_package(Wayland REQUIRED)
+		add_compile_definitions(HAS_WAYLAND)
+	endif()
 	find_package(GTK3 REQUIRED)
 endif()
 

cmake/FindWayland.cmake

@@ -0,0 +1,14 @@
+find_package(PkgConfig)
+
+pkg_search_module(WAYLAND_CLIENT IMPORTED_TARGET wayland-client)
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(Wayland
+    REQUIRED_VARS
+        WAYLAND_CLIENT_LIBRARIES
+    VERSION_VAR WAYLAND_CLIENT_VERSION
+)
+
+if (Wayland_FOUND)
+    add_library(Wayland::client ALIAS PkgConfig::WAYLAND_CLIENT)
+endif()

src/CMakeLists.txt

@@ -27,8 +27,10 @@ elseif(UNIX)
 		add_compile_definitions(
 			VK_USE_PLATFORM_XLIB_KHR # legacy. Do we need to support XLIB surfaces?
 			VK_USE_PLATFORM_XCB_KHR
-			VK_USE_PLATFORM_WAYLAND_KHR
 		)
+		if (ENABLE_WAYLAND)
+			add_compile_definitions(VK_USE_PLATFORM_WAYLAND_KHR)
+		endif()
 	endif()
 	add_compile_options(-maes)
 	# warnings

src/Cafe/CMakeLists.txt

@@ -502,6 +502,11 @@ target_link_libraries(CemuCafe PRIVATE
 	zstd::zstd
 )
 
+if (ENABLE_WAYLAND)
+	# PUBLIC because wayland-client.h is included in VulkanAPI.h
+  target_link_libraries(CemuCafe PUBLIC Wayland::client)
+endif()
+
 if (ENABLE_WXWIDGETS)
 	target_link_libraries(CemuCafe PRIVATE wx::base wx::core)
 endif()

src/Cafe/HW/Latte/Renderer/Vulkan/VulkanAPI.h

@@ -129,8 +129,10 @@ VKFUNC_DEVICE(vkCmdBindPipeline);
 #if BOOST_OS_LINUX
 VKFUNC_INSTANCE(vkCreateXlibSurfaceKHR);
 VKFUNC_INSTANCE(vkCreateXcbSurfaceKHR);
+#ifdef HAS_WAYLAND
 VKFUNC_INSTANCE(vkCreateWaylandSurfaceKHR);
 #endif
+#endif
 
 #if BOOST_OS_WINDOWS
 VKFUNC_INSTANCE(vkCreateWin32SurfaceKHR);

src/Cafe/HW/Latte/Renderer/Vulkan/VulkanRenderer.cpp

@@ -110,8 +110,10 @@ std::vector<VulkanRenderer::DeviceInfo> VulkanRenderer::GetDevices()
 	auto backend = gui_getWindowInfo().window_main.backend;
 	if(backend == WindowHandleInfo::Backend::X11)
 		requiredExtensions.emplace_back(VK_KHR_XLIB_SURFACE_EXTENSION_NAME);
+	#ifdef HAS_WAYLAND
 	else if (backend == WindowHandleInfo::Backend::WAYLAND)
 		requiredExtensions.emplace_back(VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME);
+	#endif
 	#elif BOOST_OS_MACOS
 	requiredExtensions.emplace_back(VK_EXT_METAL_SURFACE_EXTENSION_NAME);
 	#endif
@@ -1156,8 +1158,10 @@ std::vector<const char*> VulkanRenderer::CheckInstanceExtensionSupport(FeatureCo
 	auto backend = gui_getWindowInfo().window_main.backend;
 	if(backend == WindowHandleInfo::Backend::X11)
 		requiredInstanceExtensions.emplace_back(VK_KHR_XLIB_SURFACE_EXTENSION_NAME);
+	#if HAS_WAYLAND
 	else if (backend == WindowHandleInfo::Backend::WAYLAND)
 		requiredInstanceExtensions.emplace_back(VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME);
+	#endif
 	#elif BOOST_OS_MACOS
 	requiredInstanceExtensions.emplace_back(VK_EXT_METAL_SURFACE_EXTENSION_NAME);
 	#endif
@@ -1275,7 +1279,7 @@ VkSurfaceKHR VulkanRenderer::CreateXcbSurface(VkInstance instance, xcb_connectio
 
     return result;
 }
-
+#ifdef HAS_WAYLAND
 VkSurfaceKHR VulkanRenderer::CreateWaylandSurface(VkInstance instance, wl_display* display, wl_surface* surface)
 {
     VkWaylandSurfaceCreateInfoKHR sci{};
@@ -1294,7 +1298,8 @@ VkSurfaceKHR VulkanRenderer::CreateWaylandSurface(VkInstance instance, wl_displa
 
     return result;
 }
-#endif
+#endif // HAS_WAYLAND
+#endif // BOOST_OS_LINUX
 
 VkSurfaceKHR VulkanRenderer::CreateFramebufferSurface(VkInstance instance, struct WindowHandleInfo& windowInfo)
 {
@@ -1303,8 +1308,10 @@ VkSurfaceKHR VulkanRenderer::CreateFramebufferSurface(VkInstance instance, struc
 #elif BOOST_OS_LINUX
 	if(windowInfo.backend == WindowHandleInfo::Backend::X11)
 		return CreateXlibSurface(instance, windowInfo.xlib_display, windowInfo.xlib_window);
+	#ifdef HAS_WAYLAND
 	if(windowInfo.backend == WindowHandleInfo::Backend::WAYLAND)
 		return CreateWaylandSurface(instance, windowInfo.display, windowInfo.surface);
+	#endif
 	return {};
 #elif BOOST_OS_MACOS
 	return CreateCocoaSurface(instance, windowInfo.handle);

src/Cafe/HW/Latte/Renderer/Vulkan/VulkanRenderer.h

@@ -201,8 +201,10 @@ public:
 #if BOOST_OS_LINUX
 	static VkSurfaceKHR CreateXlibSurface(VkInstance instance, Display* dpy, Window window);
     static VkSurfaceKHR CreateXcbSurface(VkInstance instance, xcb_connection_t* connection, xcb_window_t window);
+	#ifdef HAS_WAYLAND
 	static VkSurfaceKHR CreateWaylandSurface(VkInstance instance, wl_display* display, wl_surface* surface);
 	#endif
+#endif
 
 	static VkSurfaceKHR CreateFramebufferSurface(VkInstance instance, struct WindowHandleInfo& windowInfo);
 

src/gui/CMakeLists.txt

@@ -150,6 +150,9 @@ target_link_libraries(CemuGui PRIVATE
 if(ENABLE_WXWIDGETS AND UNIX AND NOT APPLE)
 	# PUBLIC because gdk/gdkkeysyms.h is included in guiWrapper.h
 	target_link_libraries(CemuGui PUBLIC GTK3::gtk)
+  if (ENABLE_WAYLAND)
+    target_link_libraries(CemuGui PRIVATE Wayland::client)
+  endif()
 endif()
 
 if(ENABLE_CUBEB)

src/gui/canvas/VulkanCanvas.cpp

@@ -2,6 +2,10 @@
 #include "Cafe/HW/Latte/Renderer/Vulkan/VulkanRenderer.h"
 #include "gui/guiWrapper.h"
 
+#if BOOST_OS_LINUX && HAS_WAYLAND
+#include "gui/helpers/wxWayland.h"
+#endif
+
 #include <wx/msgdlg.h>
 
 VulkanCanvas::VulkanCanvas(wxWindow* parent, const wxSize& size, bool is_main_window)
@@ -14,7 +18,7 @@ VulkanCanvas::VulkanCanvas(wxWindow* parent, const wxSize& size, bool is_main_wi
 	{
 		WindowHandleInfo& canvasMain = gui_getWindowInfo().canvas_main;
 		gui_initHandleContextFromWxWidgetsWindow(canvasMain, this);
-		#if BOOST_OS_LINUX
+		#if BOOST_OS_LINUX && HAS_WAYLAND
 		if(canvasMain.backend == WindowHandleInfo::Backend::WAYLAND)
 		{	
 			m_subsurface = std::make_unique<wxWlSubsurface>(this);
@@ -65,7 +69,7 @@ void VulkanCanvas::OnPaint(wxPaintEvent& event)
 
 void VulkanCanvas::OnResize(wxSizeEvent& event)
 {
-#if BOOST_OS_LINUX
+#if BOOST_OS_LINUX && HAS_WAYLAND
 	if(m_subsurface)
 	{
 		int32_t x,y;

src/gui/canvas/VulkanCanvas.h

@@ -6,14 +6,11 @@
 
 #include "Cafe/HW/Latte/Renderer/Vulkan/VulkanAPI.h"
 #include <set>
-#if BOOST_OS_LINUX
-#include "gui/helpers/wxWayland.h"
-#endif
 
 class VulkanCanvas : public IRenderCanvas, public wxWindow
 {
-#if BOOST_OS_LINUX
+#if BOOST_OS_LINUX && HAS_WAYLAND
-	std::unique_ptr<wxWlSubsurface> m_subsurface;
+	std::unique_ptr<class wxWlSubsurface> m_subsurface;
 #endif
 public:
 	VulkanCanvas(wxWindow* parent, const wxSize& size, bool is_main_window);

src/gui/guiWrapper.cpp

@@ -3,8 +3,10 @@
 #include <gdk/gdk.h>
 #include <gdk/gdkwindow.h>
 #include <gdk/gdkx.h>
+#ifdef HAS_WAYLAND
 #include <gdk/gdkwayland.h>
 #endif
+#endif
 
 #include "gui/wxgui.h"
 #include "gui/guiWrapper.h"
@@ -219,16 +221,18 @@ void gui_initHandleContextFromWxWidgetsWindow(WindowHandleInfo& handleInfoOut, c
 			cemuLog_log(LogType::Force, "Unable to get xlib display");
 		}
 	}
-	else if(GDK_IS_WAYLAND_WINDOW(gdkWindow))
+	else 
+#ifdef HAS_WAYLAND
+	if(GDK_IS_WAYLAND_WINDOW(gdkWindow))
 	{
 		handleInfoOut.backend = WindowHandleInfo::Backend::WAYLAND;
 		handleInfoOut.surface = gdk_wayland_window_get_wl_surface(gdkWindow);
 		handleInfoOut.display = gdk_wayland_display_get_wl_display(gdkDisplay);
 	}
 	else
+#endif
 	{
 		cemuLog_log(LogType::Force, "Unsuported GTK backend");
-
 	}
 #else
 	handleInfoOut.handle = wxw->GetHandle();

src/gui/guiWrapper.h

@@ -5,7 +5,6 @@
 #if BOOST_OS_LINUX
 #include "xcb/xproto.h"
 #include <gdk/gdkkeysyms.h>
-#include <wayland-client.h>
 #endif
 
 #if BOOST_OS_MACOS
@@ -29,9 +28,10 @@ struct WindowHandleInfo
 	// XCB (not used by GTK so we cant retrieve these without making our own window)
 	//xcb_connection_t* xcb_con{};
 	//xcb_window_t xcb_window{};
-	// Wayland
+	#ifdef HAS_WAYLAND
-	wl_display* display;
+	struct wl_display* display;
-	wl_surface* surface;
+	struct wl_surface* surface;
+	#endif // HAS_WAYLAND
 #else
 	void* handle;
 #endif