Added Joystick.set_led

Author: oddbookworm

docs/reST/ref/joystick.rst

@@ -356,6 +356,21 @@ 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``
+      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.
+
+      .. versionadded:: 2.5.6
+
+      .. ## Joystick.set_led ##
+
    .. ## pygame.joystick.Joystick ##
 
 .. ## pygame.joystick ##

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/joystick.c

@@ -531,6 +531,29 @@ 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_RGBAFromObj(arg, colors)) {
+        return RAISE(PyExc_TypeError,
+                     "set_led must be passed in a Color-compatible argument");
+    }
+
+    if (SDL_JoystickSetLED(joy, colors[0], colors[1], colors[2]) < 0) {
+        Py_RETURN_FALSE;
+    }
+    Py_RETURN_TRUE;
+}
+
 static PyMethodDef joy_methods[] = {
     {"init", joy_init, METH_NOARGS, DOC_JOYSTICK_JOYSTICK_INIT},
     {"quit", joy_quit, METH_NOARGS, DOC_JOYSTICK_JOYSTICK_QUIT},
@@ -560,6 +583,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}};