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

SDL_GetGamepadButtonFromString

Convert a string into an SDL_GamepadButton enum.

Header File

Defined in <SDL3/SDL_gamepad.h>

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.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.2.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryGamepad


[ edit | delete | history | feedback | raw ]

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