(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetGamepadButtonFromString

Convert a string into an SDL_GamepadButton enum.

Header File

Syntax

SDL_GamepadButton SDL_GetGamepadButtonFromString(const char *str);

Function Parameters

const char *

str

string representing a SDL_Gamepad axis.

Return Value

(SDL_GamepadButton) Returns the SDL_GamepadButton enum corresponding to the input string, or SDL_GAMEPAD_BUTTON_INVALID if no match was found.

Remarks

This function is called internally to translate SDL_Gamepad mapping strings for the underlying joystick device into the consistent SDL_Gamepad mapping. You do not normally need to call this function unless you are parsing SDL_Gamepad mappings in your own code.

Version

This function is available since SDL 3.1.3.