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

SDL_GameControllerGetButton

Get the current state of a button on a game controller.

Header File

Defined in SDL_gamecontroller.h

Syntax

Uint8 SDL_GameControllerGetButton(SDL_GameController *gamecontroller,
                                  SDL_GameControllerButton button);

Function Parameters

SDL_GameController *	gamecontroller	a game controller.
SDL_GameControllerButton	button	a button index (one of the SDL_GameControllerButton values).

Return Value

(Uint8) Returns 1 for pressed state or 0 for not pressed state or error; call SDL_GetError() for more information.

Version

This function is available since SDL 2.0.0.

See Also

• SDL_GameControllerGetAxis

---

CategoryAPI, CategoryAPIFunction, CategoryGameController

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