(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_JoystickSetLED

Update a joystick's LED color.

Header File

Defined in SDL_joystick.h

Syntax

int SDL_JoystickSetLED(SDL_Joystick *joystick, Uint8 red, Uint8 green, Uint8 blue);

Function Parameters

SDL_Joystick *	joystick	The joystick to update.
Uint8	red	The intensity of the red LED.
Uint8	green	The intensity of the green LED.
Uint8	blue	The intensity of the blue LED.

Return Value

(int) Returns 0 on success, -1 if this joystick does not have a modifiable LED.

Remarks

An example of a joystick LED is the light on the back of a PlayStation 4's DualShock 4 controller.

Version

This function is available since SDL 2.0.14.

---

CategoryAPI, CategoryAPIFunction, CategoryJoystick

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.