Add Controller.set_led, remove print-on-failure-for-sdl3 for Joystick.set_led, and use pg_RGBAFromObjEx instead of pg_RGBAFromObj

Author: oddbookworm

docs/reST/ref/joystick.rst

@@ -361,11 +361,12 @@ variable. See :ref:`environment variables <environment-variables>` for more deta
       | :sl:`Set the LED color of the joystick`
       | :sg:`set_led(color_arg) -> bool`
 
-      Set the color of the LED on the joystick. The argument is a ``pygame.Color``
-      instance or a tuple of RGB(A) values (alpha being ignored). The color
-      will be set to the joystick's LED, if it has one. If the joystick does
-      not have an LED, then this method will do nothing and return False.
-      Returns True if the LED was set successfully.
+      Set the color of the LED on the joystick. The argument is a
+      ``pygame.Color``-compatible value (alpha being ignored). The
+      joystick's LED, if it has one, will be set to the input color.
+      If the joystick does not have an addressable LED, then this
+      method will do nothing and return False. Returns True if the
+      LED was set successfully.
 
       .. versionadded:: 2.5.6
 

docs/reST/ref/sdl2_controller.rst

@@ -288,4 +288,20 @@ events related to controllers.
 
       .. ## Controller.stop_rumble ##
 
+   .. method:: set_led
+
+      | :sl:`Set the LED color of the controller`
+      | :sg:`set_led(color_arg) -> bool`
+
+      Set the color of the LED on the controller. The argument is a
+      ``pygame.Color``-compatible value (alpha being ignored). The
+      controller's LED, if it has one, will be set to the input color.
+      If the controller does not have an addressable LED, then this
+      method will do nothing and return False. Returns True if the
+      LED was set successfully.
+
+      .. versionadded:: 2.5.6
+
+      .. ## Controller.set_led ##
+
 .. ## pygame._sdl2.controller ##

src_c/_sdl2/controller.c

@@ -388,6 +388,35 @@ controller_stop_rumble(pgControllerObject *self, PyObject *_null)
     Py_RETURN_NONE;
 }
 
+static PyObject*
+controller_set_led(pgControllerObject *self, PyObject *arg)
+{
+    CONTROLLER_INIT_CHECK();
+
+    Uint8 colors[4] = {0, 0, 0, 0};
+
+    if (!pg_RGBAFromObjEx(arg, colors, PG_COLOR_HANDLE_ALL)) {
+        return RAISE(PyExc_TypeError,
+                     "set_led must be passed in a Color-compatible argument");
+    }
+
+#if !SDL_VERSION_ATLEAST(3, 0, 0)
+    if (SDL_GameControllerSetLED(self->controller, colors[0], colors[1], colors[2]) < 0) {
+        Py_RETURN_FALSE;
+    }
+    Py_RETURN_TRUE;
+#else
+    // SDL3 renames the function and sets an error message on failure
+    bool result = SDL_SetGamepadLED(self->controller, colors[0], colors[1], colors[2]);
+    if (!result) {
+        // Clear the SDL error message that SDL set, for example if it didn't
+        // have an addressable LED
+        (void)SDL_GetError();
+    }
+    return PyBool_FromLong(result);
+#endif
+}
+
 static PyMethodDef controller_methods[] = {
     {"from_joystick", (PyCFunction)controller_from_joystick,
      METH_CLASS | METH_VARARGS | METH_KEYWORDS,
@@ -414,6 +443,7 @@ static PyMethodDef controller_methods[] = {
      DOC_SDL2_CONTROLLER_CONTROLLER_RUMBLE},
     {"stop_rumble", (PyCFunction)controller_stop_rumble, METH_NOARGS,
      DOC_SDL2_CONTROLLER_CONTROLLER_STOPRUMBLE},
+    {"set_led", (PyCFunction)controller_set_led, METH_O, DOC_SDL2_CONTROLLER_CONTROLLER_SETLED},
     {NULL, NULL, 0, NULL}};
 
 static PyMemberDef controller_members[] = {
@@ -569,6 +599,11 @@ MODINIT_DEFINE(controller)
         return NULL;
     }
 
+    import_pygame_color();
+    if (PyErr_Occurred()) {
+        return NULL;
+    }
+
     import_pygame_joystick();
     if (PyErr_Occurred()) {
         return NULL;

src_c/doc/sdl2_controller_doc.h

@@ -21,3 +21,4 @@
 #define DOC_SDL2_CONTROLLER_CONTROLLER_SETMAPPING "set_mapping(mapping) -> int\nAssign a mapping to the controller"
 #define DOC_SDL2_CONTROLLER_CONTROLLER_RUMBLE "rumble(low_frequency, high_frequency, duration) -> bool\nStart a rumbling effect"
 #define DOC_SDL2_CONTROLLER_CONTROLLER_STOPRUMBLE "stop_rumble() -> None\nStop any rumble effect playing"
+#define DOC_SDL2_CONTROLLER_CONTROLLER_SETLED "set_led(color_arg) -> bool\nSet the LED color of the controller"

src_c/joystick.c

@@ -543,7 +543,7 @@ joy_set_led(PyObject *self, PyObject *arg)
 
     Uint8 colors[4] = {0, 0, 0, 0};
 
-    if (!pg_RGBAFromObj(arg, colors)) {
+    if (!pg_RGBAFromObjEx(arg, colors, PG_COLOR_HANDLE_ALL)) {
         return RAISE(PyExc_TypeError,
                      "set_led must be passed in a Color-compatible argument");
     }
@@ -557,7 +557,9 @@ joy_set_led(PyObject *self, PyObject *arg)
     // SDL3 renames the function and sets an error message on failure
     bool result = SDL_SetJoystickLED(joy, colors[0], colors[1], colors[2]);
     if (!result) {
-        printf("%s\n", SDL_GetError());
+        // Clear the SDL error message that SDL set, for example if it didn't
+        // have an addressable LED
+        (void)SDL_GetError();
     }
     return PyBool_FromLong(result);
 #endif
@@ -698,6 +700,11 @@ MODINIT_DEFINE(joystick)
         return NULL;
     }
 
+    import_pygame_color();
+    if (PyErr_Occurred()) {
+        return NULL;
+    }
+
     /* type preparation */
     if (PyType_Ready(&pgJoystick_Type) == -1) {
         return NULL;