Port mouse.c to SDL3

Author: ankith26

src_c/meson.build

@@ -57,8 +57,6 @@ key = py.extension_module(
     subdir: pg,
 )
 
-# TODO: support SDL3
-if sdl_api != 3
 mouse = py.extension_module(
     'mouse',
     'mouse.c',
@@ -67,7 +65,6 @@ mouse = py.extension_module(
     install: true,
     subdir: pg,
 )
-endif
 
 rect = py.extension_module(
     'rect',

src_c/mouse.c

@@ -65,7 +65,14 @@ mouse_set_pos(PyObject *self, PyObject *args)
 static PyObject *
 mouse_get_pos(PyObject *self, PyObject *args, PyObject *kwargs)
 {
+#if SDL_VERSION_ATLEAST(3, 0, 0)
+    /* SDL3 changed the mouse API to deal with float coordinates, for now we
+     * still truncate the result to int before returning to python side.
+     * This can be changed in a breaking release in the future if needed. */
+    float x, y;
+#else
     int x, y;
+#endif
     int desktop = 0;
 
     static char *kwids[] = {"desktop", NULL};
@@ -90,12 +97,27 @@ mouse_get_pos(PyObject *self, PyObject *args, PyObject *kwargs)
                 SDL_RenderGetScale(sdlRenderer, &scalex, &scaley);
                 SDL_RenderGetViewport(sdlRenderer, &vprect);
 
+#if SDL_VERSION_ATLEAST(3, 0, 0)
+                x = x / scalex;
+                y = y / scaley;
+#else
                 x = (int)(x / scalex);
                 y = (int)(y / scaley);
+#endif
 
                 x -= vprect.x;
                 y -= vprect.y;
 
+#if SDL_VERSION_ATLEAST(3, 0, 0)
+                if (x < 0)
+                    x = 0;
+                if (x >= vprect.w)
+                    x = (float)vprect.w - 1;
+                if (y < 0)
+                    y = 0;
+                if (y >= vprect.h)
+                    y = (float)vprect.h - 1;
+#else
                 if (x < 0)
                     x = 0;
                 if (x >= vprect.w)
@@ -104,17 +126,29 @@ mouse_get_pos(PyObject *self, PyObject *args, PyObject *kwargs)
                     y = 0;
                 if (y >= vprect.h)
                     y = vprect.h - 1;
+#endif
             }
         }
     }
 
+#if SDL_VERSION_ATLEAST(3, 0, 0)
+    return pg_tuple_couple_from_values_int((int)x, (int)y);
+#else
     return pg_tuple_couple_from_values_int(x, y);
+#endif
 }
 
 static PyObject *
 mouse_get_rel(PyObject *self, PyObject *_null)
 {
+#if SDL_VERSION_ATLEAST(3, 0, 0)
+    /* SDL3 changed the mouse API to deal with float coordinates, for now we
+     * still truncate the result to int before returning to python side.
+     * This can be changed in a breaking release in the future if needed. */
+    float x, y;
+#else
     int x, y;
+#endif
 
     VIDEO_INIT_CHECK();
 
@@ -132,7 +166,11 @@ mouse_get_rel(PyObject *self, PyObject *_null)
             y/=scaley;
         }
     */
+#if SDL_VERSION_ATLEAST(3, 0, 0)
+    return pg_tuple_couple_from_values_int((int)x, (int)y);
+#else
     return pg_tuple_couple_from_values_int(x, y);
+#endif
 }
 
 static PyObject *
@@ -216,21 +254,26 @@ mouse_set_visible(PyObject *self, PyObject *args)
 {
     int toggle, prevstate;
     SDL_Window *win = NULL;
-    Uint32 window_flags = 0;
+    SDL_WindowFlags window_flags = 0;
 
     if (!PyArg_ParseTuple(args, "i", &toggle))
         return NULL;
     VIDEO_INIT_CHECK();
 
     win = pg_GetDefaultWindow();
     if (win) {
+#if SDL_VERSION_ATLEAST(3, 0, 0)
+        SDL_SetWindowRelativeMouseMode(win,
+                                       SDL_GetWindowMouseGrab(win) && !toggle);
+#else
         int mode = SDL_GetWindowGrab(win);
         if ((mode == SDL_ENABLE) & !toggle) {
             SDL_SetRelativeMouseMode(1);
         }
         else {
             SDL_SetRelativeMouseMode(0);
         }
+#endif
         window_flags = SDL_GetWindowFlags(win);
         if (!toggle && (window_flags & PG_WINDOW_FULLSCREEN_INCLUSIVE)) {
             SDL_SetHint(SDL_HINT_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN, "0");
@@ -263,7 +306,13 @@ mouse_get_visible(PyObject *self, PyObject *_null)
 
     VIDEO_INIT_CHECK();
 
+#if SDL_VERSION_ATLEAST(3, 0, 0)
+    SDL_Window *win = pg_GetDefaultWindow();
+    result =
+        win ? (PG_CursorVisible() && !SDL_GetWindowRelativeMouseMode(win)) : 0;
+#else
     result = (PG_CursorVisible() && !SDL_GetRelativeMouseMode());
+#endif
 
     if (0 > result) {
         return RAISE(pgExc_SDLError, SDL_GetError());
@@ -527,7 +576,12 @@ mouse_get_cursor(PyObject *self, PyObject *_null)
 static PyObject *
 mouse_get_relative_mode(PyObject *self)
 {
+#if SDL_VERSION_ATLEAST(3, 0, 0)
+    SDL_Window *win = pg_GetDefaultWindow();
+    return PyBool_FromLong(win ? SDL_GetWindowRelativeMouseMode(win) : 0);
+#else
     return PyBool_FromLong(SDL_GetRelativeMouseMode());
+#endif
 }
 
 static PyObject *
@@ -537,9 +591,20 @@ mouse_set_relative_mode(PyObject *self, PyObject *arg)
     if (mode == -1) {
         return NULL;
     }
+#if SDL_VERSION_ATLEAST(3, 0, 0)
+    SDL_Window *win = pg_GetDefaultWindow();
+    if (!win) {
+        return RAISE(pgExc_SDLError,
+                     "display.set_mode has not been called yet.");
+    }
+    if (!SDL_SetWindowRelativeMouseMode(win, (bool)mode)) {
+        return RAISE(pgExc_SDLError, SDL_GetError());
+    }
+#else
     if (SDL_SetRelativeMouseMode((SDL_bool)mode)) {
         return RAISE(pgExc_SDLError, SDL_GetError());
     }
+#endif
     Py_RETURN_NONE;
 }