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

SDL_GameControllerGetStringForButton

Convert from an SDL_GameControllerButton enum to a string.

Header File

Syntax

const char* SDL_GameControllerGetStringForButton(SDL_GameControllerButton button);

Function Parameters

SDL_GameControllerButton

button

an enum value for a given SDL_GameControllerButton.

Return Value

(const char *) Returns a string for the given button, or NULL if an invalid button is specified. The string returned is of the format used by SDL_GameController mapping strings.

Remarks

The caller should not SDL_free() the returned string.

Version

This function is available since SDL 2.0.0.