Function SDL_GetGamepadButtonFromString

pub unsafe extern "C" fn SDL_GetGamepadButtonFromString(
    str: *const i8,
) -> SDL_GamepadButton

Available on crate feature dep_sdl3 only.

Convert a string into an SDL_GamepadButton 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.

Parameters

• str: string representing a SDL_Gamepad axis.

Return value

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

Availability

This function is available since SDL 3.2.0.

See also

• SDL_GetGamepadStringForButton