Merge pull request #2071 from durkisneer1/durk-getFRect

Create Surface.get_frect method

Author: Matiiss

buildconfig/stubs/pygame/surface.pyi

@@ -2,7 +2,7 @@ from typing import Any, List, Optional, Sequence, Tuple, Union, overload, Iterab
 
 from pygame.bufferproxy import BufferProxy
 from pygame.color import Color
-from pygame.rect import Rect
+from pygame.rect import Rect, FRect
 
 from ._common import ColorValue, Coordinate, Literal, RectValue, RGBAOutput
 
@@ -139,6 +139,7 @@ class Surface:
     def get_width(self) -> int: ...
     def get_height(self) -> int: ...
     def get_rect(self, **kwargs: Any) -> Rect: ...
+    def get_frect(self, **kwargs: Any) -> FRect: ...
     def get_bitsize(self) -> int: ...
     def get_bytesize(self) -> int: ...
     def get_flags(self) -> int: ...

docs/reST/ref/surface.rst

@@ -709,6 +709,21 @@
 
       .. ## Surface.get_rect ##
 
+   .. method:: get_frect
+
+      | :sl:`get the rectangular area of the Surface`
+      | :sg:`get_frect(\**kwargs) -> FRect`
+      
+      This is the same as :meth:`Surface.get_rect` but returns an FRect. FRect is similar
+      to Rect, except it stores float values instead.
+
+      You can pass keyword argument values to this function. These named values
+      will be applied to the attributes of the FRect before it is returned. An
+      example would be ``mysurf.get_frect(center=(100.5, 100.5))`` to create a
+      rectangle for the Surface centered at a given position.
+
+      .. ## Surface.get_frect ##
+
    .. method:: get_bitsize
 
       | :sl:`get the bit depth of the Surface pixel format`

src_c/doc/surface_doc.h

@@ -37,6 +37,7 @@
 #define DOC_SURFACE_GETWIDTH "get_width() -> width\nget the width of the Surface"
 #define DOC_SURFACE_GETHEIGHT "get_height() -> height\nget the height of the Surface"
 #define DOC_SURFACE_GETRECT "get_rect(**kwargs) -> Rect\nget the rectangular area of the Surface"
+#define DOC_SURFACE_GETFRECT "get_frect(**kwargs) -> FRect\nget the rectangular area of the Surface"
 #define DOC_SURFACE_GETBITSIZE "get_bitsize() -> int\nget the bit depth of the Surface pixel format"
 #define DOC_SURFACE_GETBYTESIZE "get_bytesize() -> int\nget the bytes used per Surface pixel"
 #define DOC_SURFACE_GETFLAGS "get_flags() -> int\nget the additional flags used for the Surface"

src_c/surface.c

@@ -196,6 +196,8 @@ surf_get_pitch(PyObject *self, PyObject *args);
 static PyObject *
 surf_get_rect(PyObject *self, PyObject *args, PyObject *kwargs);
 static PyObject *
+surf_get_frect(PyObject *self, PyObject *args, PyObject *kwargs);
+static PyObject *
 surf_get_width(PyObject *self, PyObject *args);
 static PyObject *
 surf_get_shifts(PyObject *self, PyObject *args);
@@ -356,6 +358,8 @@ static struct PyMethodDef surface_methods[] = {
     {"get_height", surf_get_height, METH_NOARGS, DOC_SURFACE_GETHEIGHT},
     {"get_rect", (PyCFunction)surf_get_rect, METH_VARARGS | METH_KEYWORDS,
      DOC_SURFACE_GETRECT},
+    {"get_frect", (PyCFunction)surf_get_frect, METH_VARARGS | METH_KEYWORDS,
+     DOC_SURFACE_GETFRECT},
     {"get_pitch", surf_get_pitch, METH_NOARGS, DOC_SURFACE_GETPITCH},
     {"get_bitsize", surf_get_bitsize, METH_NOARGS, DOC_SURFACE_GETBITSIZE},
     {"get_bytesize", surf_get_bytesize, METH_NOARGS, DOC_SURFACE_GETBYTESIZE},
@@ -2557,6 +2561,34 @@ surf_get_rect(PyObject *self, PyObject *args, PyObject *kwargs)
     return rect;
 }
 
+static PyObject *
+surf_get_frect(PyObject *self, PyObject *args, PyObject *kwargs)
+{
+    PyObject *rect;
+    SDL_Surface *surf = pgSurface_AsSurface(self);
+
+    if (PyTuple_GET_SIZE(args) > 0) {
+        return RAISE(PyExc_TypeError,
+                     "get_frect only accepts keyword arguments");
+    }
+
+    SURF_INIT_CHECK(surf)
+
+    rect = pgFRect_New4(0.f, 0.f, (float)surf->w, (float)surf->h);
+    if (rect && kwargs) {
+        PyObject *key, *value;
+        Py_ssize_t pos = 0;
+
+        while (PyDict_Next(kwargs, &pos, &key, &value)) {
+            if ((PyObject_SetAttr(rect, key, value) == -1)) {
+                Py_DECREF(rect);
+                return NULL;
+            }
+        }
+    }
+    return rect;
+}
+
 static PyObject *
 surf_get_bitsize(PyObject *self, PyObject *_null)
 {

test/surface_test.py

@@ -594,6 +594,18 @@ def test_get_rect(self):
 
     ########################################################################
 
+    def test_get_frect(self):
+        """Ensure a surface's frect can be retrieved."""
+        size = (16.0, 16.0)
+        surf = pygame.Surface(size)
+        frect = surf.get_frect()
+
+        self.assertEqual(frect.topleft, (0.0, 0.0))
+        self.assertEqual(frect.size, size)
+        self.assertIsInstance(frect, pygame.FRect)
+
+    ########################################################################
+
     def test_get_width__size_and_height(self):
         """Ensure a surface's size, width and height can be retrieved."""
         for w in range(0, 255, 32):