GPU Wayland Display: set mouse cursor to default instead of being undefined

Author: davidrohr

GPU/GPUTracking/display/CMakeLists.txt

@@ -78,7 +78,7 @@ if(GPUCA_EVENT_DISPLAY_VULKAN)
   if(GPUCA_EVENT_DISPLAY_WAYLAND)
     set(WAYLAND_PROTOCOL_HEADERS)
     set(WAYLAND_PROTOCOL_SOURCES)
-    foreach(xml stable/xdg-shell/xdg-shell.xml stable/viewporter/viewporter.xml unstable/xdg-decoration/xdg-decoration-unstable-v1.xml staging/fractional-scale/fractional-scale-v1.xml)
+    foreach(xml ${O2GPUWayland_PROTOCOLS}) # List and existence check in dependencies/FindO2GPUWayland.cmake
       get_filename_component(name ${xml} NAME_WE)
       string(REGEX REPLACE "(-unstable)?-v[0-9]+$" "" name ${name})
       set(header ${CMAKE_CURRENT_BINARY_DIR}/xdg-gen/${name}-client-protocol.h)

GPU/GPUTracking/display/frontend/GPUDisplayFrontendWayland.cxx

@@ -39,6 +39,7 @@
 #include "xdg-shell-client-protocol.h"
 #include "xdg-decoration-client-protocol.h"
 #include "viewporter-client-protocol.h"
+#include "cursor-shape-client-protocol.h"
 #include <xkbcommon/xkbcommon.h>
 #include <linux/input-event-codes.h>
 
@@ -157,6 +158,13 @@ int32_t GPUDisplayFrontendWayland::FrontendMain()
   }
 
   auto pointer_enter = [](void* data, wl_pointer* wl_pointer, uint32_t serial, wl_surface* surface, wl_fixed_t surface_x, wl_fixed_t surface_y) {
+    GPUDisplayFrontendWayland* me = (GPUDisplayFrontendWayland*)data;
+    if (!me->mCursorShapeDevice && me->mCursorShapeManager) {
+      me->mCursorShapeDevice = wp_cursor_shape_manager_v1_get_pointer(me->mCursorShapeManager, wl_pointer);
+    }
+    if (me->mCursorShapeDevice) {
+      wp_cursor_shape_device_v1_set_shape(me->mCursorShapeDevice, serial, WP_CURSOR_SHAPE_DEVICE_V1_SHAPE_DEFAULT);
+    }
   };
   auto pointer_leave = [](void* data, wl_pointer* wl_pointer, uint32_t serial, wl_surface* wl_surface) {
     GPUDisplayFrontendWayland* me = (GPUDisplayFrontendWayland*)data;
@@ -355,6 +363,8 @@ int32_t GPUDisplayFrontendWayland::FrontendMain()
       wl_seat_add_listener(me->mSeat, &me->mSeatListener, me);
     } else if (strcmp(interface, zxdg_decoration_manager_v1_interface.name) == 0) {
       me->mDecManager = (zxdg_decoration_manager_v1*)wl_registry_bind(registry, name, &zxdg_decoration_manager_v1_interface, 1);
+    } else if (strcmp(interface, wp_cursor_shape_manager_v1_interface.name) == 0) {
+      me->mCursorShapeManager = (wp_cursor_shape_manager_v1*)wl_registry_bind(registry, name, &wp_cursor_shape_manager_v1_interface, 1);
     } else if (strcmp(interface, wp_viewporter_interface.name) == 0) {
       me->mViewporter = (wp_viewporter*)wl_registry_bind(registry, name, &wp_viewporter_interface, 1);
     } else if (strcmp(interface, wp_fractional_scale_manager_v1_interface.name) == 0) {
@@ -600,6 +610,14 @@ int32_t GPUDisplayFrontendWayland::FrontendMain()
   mDisplayRunning = false;
   pthread_mutex_unlock(&mSemLockExit);
 
+  if (mCursorShapeDevice) {
+    wp_cursor_shape_device_v1_destroy(mCursorShapeDevice);
+    mCursorShapeDevice = nullptr;
+  }
+  if (mCursorShapeManager) {
+    wp_cursor_shape_manager_v1_destroy(mCursorShapeManager);
+    mCursorShapeManager = nullptr;
+  }
   if (mPointer) {
     mSeatVersion >= WL_POINTER_RELEASE_SINCE_VERSION ? wl_pointer_release(mPointer) : wl_pointer_destroy(mPointer);
     mPointer = nullptr;

GPU/GPUTracking/display/frontend/GPUDisplayFrontendWayland.h

@@ -26,6 +26,8 @@
 struct zxdg_decoration_manager_v1;
 struct wp_viewporter;
 struct wp_viewport;
+struct wp_cursor_shape_manager_v1;
+struct wp_cursor_shape_device_v1;
 struct zxdg_toplevel_decoration_v1;
 struct xkb_context;
 struct xkb_keymap;
@@ -106,6 +108,8 @@ class GPUDisplayFrontendWayland : public GPUDisplayFrontend
 
   wp_viewporter* mViewporter = nullptr; // Fractional scaling (if both are available): buffer scale 1, buffer at physical size, viewport destination = logical size
   wp_fractional_scale_manager_v1* mFractionalScaleManager = nullptr;
+  wp_cursor_shape_manager_v1* mCursorShapeManager = nullptr; // Sets the default cursor on pointer enter, otherwise the cursor image is undefined
+  wp_cursor_shape_device_v1* mCursorShapeDevice = nullptr;
   wp_viewport* mViewport = nullptr;
   wp_fractional_scale_v1* mFractionalScale = nullptr;
 

dependencies/FindO2GPUWayland.cmake

@@ -25,10 +25,18 @@ find_program(${PKGNAME}_SCANNER wayland-scanner)
 find_package(PkgConfig)
 if(PkgConfig_FOUND)
   pkg_get_variable(${PKGNAME}_PROTOCOLS_DIR wayland-protocols pkgdatadir)
-  if(NOT ${PKGNAME}_PROTOCOLS_DIR OR NOT EXISTS "${${PKGNAME}_PROTOCOLS_DIR}/stable/xdg-shell/xdg-shell.xml" OR NOT EXISTS "${${PKGNAME}_PROTOCOLS_DIR}/unstable/xdg-decoration/xdg-decoration-unstable-v1.xml" OR NOT EXISTS "${${PKGNAME}_PROTOCOLS_DIR}/stable/viewporter/viewporter.xml" OR NOT EXISTS "${${PKGNAME}_PROTOCOLS_DIR}/staging/fractional-scale/fractional-scale-v1.xml")
-    message(STATUS "wayland xdg protocol missing in ${${PKGNAME}_PROTOCOLS_DIR}")
-    unset(${PKGNAME}_PROTOCOLS_DIR)
-  endif()
+  set(${PKGNAME}_PROTOCOLS stable/xdg-shell/xdg-shell.xml
+                           stable/viewporter/viewporter.xml
+                           stable/tablet/tablet-v2.xml
+                           unstable/xdg-decoration/xdg-decoration-unstable-v1.xml
+                           staging/fractional-scale/fractional-scale-v1.xml
+                           staging/cursor-shape/cursor-shape-v1.xml)
+  foreach(xml ${${PKGNAME}_PROTOCOLS})
+    if(${PKGNAME}_PROTOCOLS_DIR AND NOT EXISTS "${${PKGNAME}_PROTOCOLS_DIR}/${xml}")
+      message(STATUS "wayland protocol ${xml} missing in ${${PKGNAME}_PROTOCOLS_DIR}")
+      unset(${PKGNAME}_PROTOCOLS_DIR)
+    endif()
+  endforeach()
 endif()
 
 include(FindPackageHandleStandardArgs)