(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

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.1.3.

See Also

• SDL_AddGamepadMapping
• SDL_GetGamepadMapping

---

CategoryAPI, CategoryAPIFunction, CategoryGamepad

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.