Scroll to navigation

SDL_SetGamepadLED(3) SDL3 FUNCTIONS SDL_SetGamepadLED(3)

NAME

SDL_SetGamepadLED - Update a gamepad's LED color.

HEADER FILE

Defined in SDL3/SDL_gamepad.h

SYNOPSIS

#include "SDL3/SDL.h"
bool SDL_SetGamepadLED(SDL_Gamepad *gamepad, Uint8 red, Uint8 green, Uint8 blue);

DESCRIPTION

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

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

FUNCTION PARAMETERS

the gamepad to update.
the intensity of the red LED.
the intensity of the green LED.
the intensity of the blue LED.

RETURN VALUE

Returns true on success or false on failure; call

SDL_GetError () for more information.

AVAILABILITY

This function is available since SDL 3.1.3.

SDL 3.1.6 Simple Directmedia Layer