NAME¶

SDL_GetJoystickButton - Get the current state of a button on a joystick.

HEADER FILE¶

Defined in SDL3/SDL_joystick.h

SYNOPSIS¶

#include "SDL3/SDL.h"

bool SDL_GetJoystickButton(SDL_Joystick *joystick, int button);

FUNCTION PARAMETERS¶

joystick

an SDL_Joystick
structure containing joystick information.

button

the button index to get the state from; indices start at index 0.

RETURN VALUE¶

Returns true if the button is pressed, false otherwise.

AVAILABILITY¶

This function is available since SDL 3.1.3.

SEE ALSO¶

•(3), SDL_GetNumJoystickButtons(3)