sdlGetGamepadAxisFromString function

int sdlGetGamepadAxisFromString(String? str)

Convert a string into SDL_GamepadAxis enum.

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.

Note specially that "righttrigger" and "lefttrigger" map to SDL_GAMEPAD_AXIS_RIGHT_TRIGGER and SDL_GAMEPAD_AXIS_LEFT_TRIGGER, respectively.

\param str string representing a SDL_Gamepad axis. \returns the SDL_GamepadAxis enum corresponding to the input string, or SDL_GAMEPAD_AXIS_INVALID if no match was found.

\since This function is available since SDL 3.1.3.

\sa SDL_GetGamepadStringForAxis

extern SDL_DECLSPEC SDL_GamepadAxis SDLCALL SDL_GetGamepadAxisFromString(const char *str)

Implementation

int sdlGetGamepadAxisFromString(String? str) {
  final sdlGetGamepadAxisFromStringLookupFunction = libSdl3.lookupFunction<
      Int32 Function(Pointer<Utf8> str),
      int Function(Pointer<Utf8> str)>('SDL_GetGamepadAxisFromString');
  final strPointer = str != null ? str.toNativeUtf8() : nullptr;
  final result = sdlGetGamepadAxisFromStringLookupFunction(strPointer);
  calloc.free(strPointer);
  return result;
}