SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_SetJoystickLED

Update a joystick's LED color.

Header File

Defined in <SDL3/SDL_joystick.h>

Syntax

int SDL_SetJoystickLED(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 or a negative error code on failure; call SDL_GetError() for more information.

Remarks

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

For joysticks with a single color LED, the maximum of the RGB values will be used as the LED brightness.

Version

This function is available since SDL 3.0.0.


CategoryAPI, CategoryAPIFunction, CategoryJoystick


[ edit | delete | history | feedback | raw ]

[ 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.