---
name: "SDL_GetJoystickButton"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_GetJoystickButton"
---

# SDL\_GetJoystickButton(3)

Get the current state of a button on a joystick.

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

## SEE ALSO

**•**(3), [**SDL\_GetNumJoystickButtons**(3)](/SDL_GetNumJoystickButtons/3.md)