Merge pull request #2483 from Starbuck5/showcursor-sdl3

Port SDL_ShowCursor to SDL3

Author: ankith26

src_c/_pygame.h

@@ -43,6 +43,10 @@
 #include <SDL.h>
 
 #if SDL_VERSION_ATLEAST(3, 0, 0)
+#define PG_ShowCursor SDL_ShowCursor
+#define PG_HideCursor SDL_HideCursor
+#define PG_CursorVisible SDL_CursorVisible
+
 #define PG_INIT_NOPARACHUTE 0
 
 // UINT16 audio no longer exists in SDL3
@@ -67,6 +71,9 @@
 #define PG_CreateSurfaceFrom SDL_CreateSurfaceFrom
 
 #else /* ~SDL_VERSION_ATLEAST(3, 0, 0)*/
+#define PG_ShowCursor() SDL_ShowCursor(SDL_ENABLE)
+#define PG_HideCursor() SDL_ShowCursor(SDL_DISABLE)
+#define PG_CursorVisible() SDL_ShowCursor(SDL_QUERY)
 
 #define PG_INIT_NOPARACHUTE SDL_INIT_NOPARACHUTE
 

src_c/event.c

@@ -1562,7 +1562,7 @@ set_grab(PyObject *self, PyObject *arg)
     if (win) {
         if (doit) {
             SDL_SetWindowGrab(win, SDL_TRUE);
-            if (SDL_ShowCursor(SDL_QUERY) == SDL_DISABLE)
+            if (PG_CursorVisible() == SDL_DISABLE)
                 SDL_SetRelativeMouseMode(1);
             else
                 SDL_SetRelativeMouseMode(0);

src_c/mouse.c

@@ -165,8 +165,7 @@ mouse_get_pressed(PyObject *self, PyObject *args, PyObject *kwargs)
 static PyObject *
 mouse_set_visible(PyObject *self, PyObject *args)
 {
-    int toggle;
-    int mode;
+    int toggle, prevstate;
     SDL_Window *win = NULL;
     Uint32 window_flags = 0;
 
@@ -176,7 +175,7 @@ mouse_set_visible(PyObject *self, PyObject *args)
 
     win = pg_GetDefaultWindow();
     if (win) {
-        mode = SDL_GetWindowGrab(win);
+        int mode = SDL_GetWindowGrab(win);
         if ((mode == SDL_ENABLE) & !toggle) {
             SDL_SetRelativeMouseMode(1);
         }
@@ -193,8 +192,20 @@ mouse_set_visible(PyObject *self, PyObject *args)
         }
     }
 
-    toggle = SDL_ShowCursor(toggle);
-    return PyBool_FromLong(toggle);
+    prevstate = PG_CursorVisible();
+
+    // Cursor visibility API **can** raise errors through SDL, but in
+    // practice it does not. (Ankith checked through the code)
+    // Historically we haven't error checked this, should that change in the
+    // future?
+    if (toggle) {
+        PG_ShowCursor();
+    }
+    else {
+        PG_HideCursor();
+    }
+
+    return PyBool_FromLong(prevstate);
 }
 
 static PyObject *
@@ -204,7 +215,7 @@ mouse_get_visible(PyObject *self, PyObject *_null)
 
     VIDEO_INIT_CHECK();
 
-    result = SDL_ShowCursor(SDL_QUERY);
+    result = PG_CursorVisible();
 
     if (0 > result) {
         return RAISE(pgExc_SDLError, SDL_GetError());