(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_JoystickGetButton

Get the current state of a button on a joystick.

Header File

Defined in SDL_joystick.h

Syntax

Uint8 SDL_JoystickGetButton(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

(Uint8) Returns 1 if the specified button is pressed, 0 otherwise.

Version

This function is available since SDL 2.0.0.

See Also

• SDL_JoystickNumButtons

---

CategoryAPI, CategoryAPIFunction, CategoryJoystick

[ front page | index | search | recent changes | git repo | offline html ]

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