Merge pull request #3507 from oddbookworm/SDL_JoystickSetLED

Added set_led method for Joystick and Controller objects

Author: ankith26

buildconfig/stubs/pygame/_sdl2/controller.pyi

@@ -1,6 +1,7 @@
 from typing import final
 
 from pygame.joystick import JoystickType
+from pygame.typing import ColorLike
 
 def init() -> None: ...
 def get_init() -> bool: ...
@@ -30,3 +31,4 @@ class Controller:
         self, low_frequency: float, high_frequency: float, duration: int
     ) -> bool: ...
     def stop_rumble(self) -> None: ...
+    def set_led(self, color: ColorLike) -> bool: ...

buildconfig/stubs/pygame/joystick.pyi

@@ -1,5 +1,6 @@
 from typing import final
 
+from pygame.typing import ColorLike
 from typing_extensions import deprecated  # added in 3.13
 
 def init() -> None: ...
@@ -31,6 +32,7 @@ class JoystickType:
         self, low_frequency: float, high_frequency: float, duration: int
     ) -> bool: ...
     def stop_rumble(self) -> None: ...
+    def set_led(self, color: ColorLike) -> bool: ...
 
 # according to the current implementation, Joystick is a function that returns
 # a JoystickType instance. In the future, when the C implementation is fixed to

docs/reST/ref/joystick.rst

@@ -356,6 +356,22 @@ variable. See :ref:`environment variables <environment-variables>` for more deta
 
       .. ## Joystick.stop_rumble ##
 
+   .. method:: set_led
+
+      | :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``-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
+
+      .. ## Joystick.set_led ##
+
    .. ## pygame.joystick.Joystick ##
 
 .. ## pygame.joystick ##

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)) {
+        // Exception already set
+        return NULL;
+    }
+
+#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/joystick_doc.h

@@ -23,3 +23,4 @@
 #define DOC_JOYSTICK_JOYSTICK_GETHAT "get_hat(hat_number, /) -> x, y\nget the position of a joystick hat"
 #define DOC_JOYSTICK_JOYSTICK_RUMBLE "rumble(low_frequency, high_frequency, duration) -> bool\nStart a rumbling effect"
 #define DOC_JOYSTICK_JOYSTICK_STOPRUMBLE "stop_rumble() -> None\nStop any rumble effect playing"
+#define DOC_JOYSTICK_JOYSTICK_SETLED "set_led(color_arg) -> bool\nSet the LED color of the joystick"

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

@@ -531,6 +531,40 @@ joy_get_hat(PyObject *self, PyObject *args)
     return pg_tuple_couple_from_values_int(px, py);
 }
 
+static PyObject *
+joy_set_led(PyObject *self, PyObject *arg)
+{
+    SDL_Joystick *joy = pgJoystick_AsSDL(self);
+
+    JOYSTICK_INIT_CHECK();
+    if (!joy) {
+        return RAISE(pgExc_SDLError, "Joystick not initialized");
+    }
+
+    Uint8 colors[4] = {0, 0, 0, 0};
+
+    if (!pg_RGBAFromObjEx(arg, colors, PG_COLOR_HANDLE_ALL)) {
+        // Exception already set
+        return NULL;
+    }
+
+#if !SDL_VERSION_ATLEAST(3, 0, 0)
+    if (SDL_JoystickSetLED(joy, 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_SetJoystickLED(joy, 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 joy_methods[] = {
     {"init", joy_init, METH_NOARGS, DOC_JOYSTICK_JOYSTICK_INIT},
     {"quit", joy_quit, METH_NOARGS, DOC_JOYSTICK_JOYSTICK_QUIT},
@@ -560,6 +594,7 @@ static PyMethodDef joy_methods[] = {
     {"get_numhats", joy_get_numhats, METH_NOARGS,
      DOC_JOYSTICK_JOYSTICK_GETNUMHATS},
     {"get_hat", joy_get_hat, METH_VARARGS, DOC_JOYSTICK_JOYSTICK_GETHAT},
+    {"set_led", joy_set_led, METH_O, DOC_JOYSTICK_JOYSTICK_SETLED},
 
     {NULL, NULL, 0, NULL}};
 
@@ -665,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;