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

SDL_GetGamepadButton

Get the current state of a button on a gamepad.

Header File

Defined in <SDL3/SDL_gamepad.h>

Syntax

Uint8 SDL_GetGamepadButton(SDL_Gamepad *gamepad, SDL_GamepadButton button);

Function Parameters

gamepad a gamepad
button a button index (one of the SDL_GamepadButton values)

Return Value

Returns 1 for pressed state or 0 for not pressed state or error; call SDL_GetError() for more information.

Version

This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryGamepad