SDL_SetGamepadMapping - Man Page

Set the current mapping of a joystick or gamepad.

Synopsis

#include <SDL3/SDL_gamepad.h>

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

Description

Details about mappings are discussed with SDL_AddGamepadMapping().

Function Parameters

instance_id

the joystick instance ID.

mapping

the mapping to use for this device, or NULL to clear the mapping.

Return Value

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

Thread Safety

It is safe to call this function from any thread.

Availability

This function is available since SDL 3.2.0.

See Also

SDL_AddGamepadMapping(3), SDL_GetGamepadMapping(3)

Referenced By

SDL_GetGamepadMapping(3).

SDL 3.3.2 Simple Directmedia Layer SDL3 FUNCTIONS