SDL_GETGAMEPADBUTTONFROMSTRING(3)

✨ NAME ✨

SDL_GetGamepadButtonFromString — bestie, this one takes a string and turns it into an SDL_GamepadButton enum 💖

(also hi, this page lives in the SDL3 FUNCTIONS manual, section 3, mwah)

---

🎀 SYNOPSIS 🎀

#include <SDL3/SDL_gamepad.h>

SDL_GamepadButton SDL_GetGamepadButtonFromString(const char *str);

---

🦋 DESCRIPTION 🦋

okay so picture this: SDL is out here translating SDL_Gamepad mapping strings for the underlying joystick device into the consistent SDL_Gamepad mapping, and this function is the lil internal glow-up artist doing that work. it's called internally, no cap.

so like… you do not normally need to call this function. fr fr. the only time you'd even touch it is if you are out here parsing SDL_Gamepad mappings in your own code, in which case go off, main character 💅

---

🌸 FUNCTION PARAMETERS 🌸

• str — a string that's giving "SDL_Gamepad button" 🎮 (it's the string representing a SDL_Gamepad button, bestie)

---

⭐ RETURN VALUE ⭐

it hands you back the SDL_GamepadButton enum that corresponds to the input string 💖

…and if no match was found? it returns SDL_GAMEPAD_BUTTON_INVALID. not me getting ghosted by a string 😭

---

🧚 THREAD SAFETY 🧚

it is safe to call this function from any thread. any. thread. periodt 👑

---

🌈 AVAILABILITY 🌈

this function has been available since SDL 3.2.0 ✨ (so if you're on something older… yeah, no 🫶)

---

💜 SEE ALSO 💜

• SDL_GetGamepadStringForButton(3) — the reverse trip, the sequel, the remix 🔥

---

and that's the whole page, bestie!! this lil icon was brought to you by Simple Directmedia Layer, sitting pretty at SDL 3.4.18 — mwah, go slay some gamepad mappings 💅🎀