SDL_SetGamepadMapping

Set the current mapping of a joystick or gamepad.

Header File

Defined in <SDL3/SDL_gamepad.h>

Syntax

bool SDL_SetGamepadMapping(SDL_JoystickID instance_id, const char *mapping);

Function Parameters

SDL_JoystickID instance_id the joystick instance ID.
const char * mapping the mapping to use for this device, or NULL to clear the mapping.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

Details about mappings are discussed with SDL_AddGamepadMapping().

Version

This function is available since SDL 3.2.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryGamepad