Merge pull request #2816 from Damus666/display-getset-window-pos

Add pygame.display.get/set_window_position()

Author: oddbookworm

buildconfig/stubs/pygame/display.pyi

@@ -82,6 +82,8 @@ def get_caption() -> Tuple[str, str]: ...
 def set_palette(palette: Sequence[ColorValue], /) -> None: ...
 def get_num_displays() -> int: ...
 def get_window_size() -> Tuple[int, int]: ...
+def get_window_position() -> Tuple[int, int]:...
+def set_window_position(position: Coordinate) -> None:...
 def get_allow_screensaver() -> bool: ...
 def set_allow_screensaver(value: bool = True) -> None: ...
 def get_desktop_sizes() -> List[Tuple[int, int]]: ...

docs/reST/ref/display.rst

@@ -724,6 +724,31 @@ required).
 
    .. ## pygame.display.get_window_size ##
 
+.. function:: get_window_position
+
+   | :sl:`Return the position of the window or screen`
+   | :sg:`get_window_position() -> tuple`
+
+   Returns the position of the window initialized with :func:`pygame.display.set_mode()`.
+   The position will change when the user moves the window or when the position is set manually with :func:`pygame.display.set_window_position()`.
+   Coordinates could be negative or outside the desktop size bounds.
+   The position is relative to the topleft of the primary monitor and the y coordinate ignores the window frame.
+
+   .. ## pygame.display.get_window_position ##
+
+.. function:: set_window_position
+
+   | :sl:`Set the current window position`
+   | :sg:`set_window_position((x, y)) -> None`
+
+   Sets the position of the window initialized with :func:`pygame.display.set_mode()`.
+   This differs from updating environment variables as this function can be called after the display has been initialised.
+   The position is expected to be relative to the topleft of the primary monitor.
+   The y coordinate will ignore the window frame (y = 0 means the frame is hidden).
+   The user will still be able to move the window after this call. See also :func:`pygame.display.get_window_position()`.
+
+   .. ## pygame.display.set_window_position ##
+
 .. function:: get_allow_screensaver
 
    | :sl:`Return whether the screensaver is allowed to run.`

src_c/display.c

@@ -1430,6 +1430,39 @@ pg_window_size(PyObject *self, PyObject *_null)
     return pg_tuple_couple_from_values_int(w, h);
 }
 
+static PyObject *
+pg_get_window_position(PyObject *self, PyObject *_null)
+{
+    SDL_Window *win = pg_GetDefaultWindow();
+    int x, y = 0;
+    if (!win)
+        return RAISE(pgExc_SDLError, "No open window");
+    SDL_GetWindowPosition(win, &x, &y);
+    return pg_tuple_couple_from_values_int(x, y);
+}
+
+static PyObject *
+pg_set_window_position(PyObject *self, PyObject *arg)
+{
+    SDL_Window *win = pg_GetDefaultWindow();
+    PyObject *pos = NULL;
+    int x, y = 0;
+
+    if (!PyArg_ParseTuple(arg, "O", &pos))
+        return NULL;
+
+    if (pos != NULL) {
+        if (!pg_TwoIntsFromObj(pos, &x, &y))
+            return RAISE(PyExc_TypeError, "position must be two numbers");
+    }
+
+    if (win)
+        /* Will raise errors with SDL 3, deal with it during the porting */
+        SDL_SetWindowPosition(win, x, y);
+
+    Py_RETURN_NONE;
+}
+
 static PyObject *
 pg_mode_ok(PyObject *self, PyObject *args, PyObject *kwds)
 {
@@ -2888,6 +2921,10 @@ static PyMethodDef _pg_display_methods[] = {
      DOC_DISPLAY_GETSURFACE},
     {"get_window_size", (PyCFunction)pg_window_size, METH_NOARGS,
      DOC_DISPLAY_GETWINDOWSIZE},
+    {"set_window_position", pg_set_window_position, METH_VARARGS,
+     DOC_DISPLAY_SETWINDOWPOSITION},
+    {"get_window_position", (PyCFunction)pg_get_window_position, METH_NOARGS,
+     DOC_DISPLAY_GETWINDOWPOSITION},
 
     {"set_mode", (PyCFunction)pg_set_mode, METH_VARARGS | METH_KEYWORDS,
      DOC_DISPLAY_SETMODE},

src_c/doc/display_doc.h

@@ -26,6 +26,8 @@
 #define DOC_DISPLAY_SETPALETTE "set_palette(palette=None, /) -> None\nSet the display color palette for indexed displays"
 #define DOC_DISPLAY_GETNUMDISPLAYS "get_num_displays() -> int\nReturn the number of displays"
 #define DOC_DISPLAY_GETWINDOWSIZE "get_window_size() -> tuple\nReturn the size of the window or screen"
+#define DOC_DISPLAY_GETWINDOWPOSITION "get_window_position() -> tuple\nReturn the position of the window or screen"
+#define DOC_DISPLAY_SETWINDOWPOSITION "set_window_position((x, y)) -> None\nSet the current window position"
 #define DOC_DISPLAY_GETALLOWSCREENSAVER "get_allow_screensaver() -> bool\nReturn whether the screensaver is allowed to run."
 #define DOC_DISPLAY_SETALLOWSCREENSAVER "set_allow_screensaver(bool) -> None\nSet whether the screensaver may run"
 #define DOC_DISPLAY_ISFULLSCREEN "is_fullscreen() -> bool\nReturns True if the pygame window created by pygame.display.set_mode() is in full-screen mode"

test/display_test.py

@@ -679,6 +679,13 @@ def test_toggle_fullscreen(self):
                     (test_surf.get_width(), test_surf.get_height()), width_height
                 )
 
+    def test_get_set_window_position(self):
+        pygame.display.set_mode((500, 500))
+        pygame.display.set_window_position((420, 360))
+        position = pygame.display.get_window_position()
+        self.assertEqual(position[0], 420)
+        self.assertEqual(position[1], 360)
+
 
 class DisplayUpdateTest(unittest.TestCase):
     def question(self, qstr):