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

SDL_GameControllerGetButtonFromString

Convert a string into an SDL_GameControllerButton enum.

Header File

Defined in SDL_gamecontroller.h

Syntax

SDL_GameControllerButton SDL_GameControllerGetButtonFromString(const char *str);

Function Parameters

const char *

str

string representing a SDL_GameController axis.

Return Value

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

Remarks

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

Version

This function is available since SDL 2.0.0.

---

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.