SDL_GetJoystickButton(3)

SDL_GetJoystickButton3

Get the current state of a button on a joystick.

Usage

#include "SDL3/SDL.h"

bool SDL_GetJoystickButton(SDL_Joystick *joystick, int button);

Header file

Defined in SDL3/SDL_joystick.h

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

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.