SDL_GetJoystickButton

Get the current state of a button on a joystick.

Header File

Defined in <SDL3/SDL_joystick.h>

Syntax

bool SDL_GetJoystickButton(SDL_Joystick *joystick, int button);

Function Parameters

SDL_Joystick *	joystick	an SDL_Joystick structure containing joystick information.
int	button	the button index to get the state from; indices start at index 0.

Return Value

(bool) Returns true if the button is pressed, false otherwise.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.2.0.

See Also

• SDL_GetNumJoystickButtons

---

CategoryAPI, CategoryAPIFunction, CategoryJoystick

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.