Function SDL_GetGamepadAxisFromString

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

Available on crate feature dep_sdl3 only.

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.

Parameters

• str: string representing a SDL_Gamepad axis.

Return value

Returns the SDL_GamepadAxis enum corresponding to the input string, or SDL_GAMEPAD_AXIS_INVALID if no match was found.

Availability

This function is available since SDL 3.2.0.

See also

• SDL_GetGamepadStringForAxis