SDL_SetJoystickLED(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

💅 SDL_SetJoystickLED(3) — the SDL3 FUNCTIONS girlies' edition ✨

okay bestie, sit down, hydrate, because we're about to make a controller glow. this is SDL_SetJoystickLED, a lil function from the SDL3 FUNCTIONS lineup, and she is iconic. no cap.

🎀 NAME 🎀

SDL_SetJoystickLED — update a joystick's LED color. that's it. that's the whole job. glow-up.exe 💖

✨ SYNOPSIS ✨

#include <SDL3/SDL_joystick.h>

bool SDL_SetJoystickLED(SDL_Joystick *joystick, Uint8 red, Uint8 green, Uint8 blue);

like look at her. clean. precise. main character energy fr fr.

🌈 DESCRIPTION 🌈

so an example of a joystick LED — literally the textbook case — is the light on the back of a PlayStation 4's DualShock 4 controller. yes THAT light. the one that stares at you while you're losing at ranked. 👑

and here's the tea for joysticks with a single color LED: the maximum of the RGB values is what gets used as the LED brightness. so whichever of your three numbers is the biggest, that's the vibe. the other two are just there for moral support. 💀

🫶 FUNCTION PARAMETERS 🫶

  • joystick — the joystick to update. your lil guy. your blorbo.
  • red — the intensity of the red LED.
  • green — the intensity of the green LED.
  • blue — the intensity of the blue LED.

three numbers, one dream. 🍓

⭐ RETURN VALUE ⭐

returns true on success or false on failure. and if it fails? call SDL_GetError() for more information, because she will tell you everything about what went wrong. not me checking that immediately, obviously I always check it, obviously. 🙈

🧵 THREAD SAFETY 🧵

it is safe to call this function from any thread. go wild. parallelize. slay across all cores. 💅

🌸 AVAILABILITY 🌸

this function is available since SDL 3.2.0. if you're on anything older, bestie, I'm so sorry, no glow for you. ✨

reminder: don't invent behaviour, don't guess defaults — everything above is exactly what the page says, just with better vibes. 🦋

that's the whole page, periodt. this has been SDL_SetJoystickLED(3) from Simple Directmedia Layer, SDL 3.4.18 — go make something light up, you've got this. 🎀💜

📦 where this page comes from