Wiki Page Content

Differences between revisions 11 and 12
Revision 11 as of 2016-04-10 22:38:02
Size: 1813
Comment: Added content from header file and moved remark into Remarks section.
Revision 12 as of 2016-04-10 22:39:25
Size: 1877
Comment: Added Version section.
Deletions are marked like this. Additions are marked like this.
Line 59: Line 59:
== Version ==
This function is available since SDL 2.0.0.



Use this function to get the current mapping of a Game Controller.


char* SDL_GameControllerMapping(SDL_GameController* gamecontroller)

Function Parameters


the game controller you want to get the current mapping for

Return Value

Returns a string that has the controller's mapping or NULL if no mapping is available; call SDL_GetError() for more information.

Code Examples

#include "SDL.h"

/* ... */

SDL_GameController *ctrl;
int i;


for (i = 0; i < SDL_NumJoysticks(); ++i) {
    if (SDL_IsGameController(i)) {
        char *mapping;
        SDL_Log("Index \'%i\' is a compatible controller, named \'%s\'", i, SDL_GameControllerNameForIndex(i));
        ctrl = SDL_GameControllerOpen(i);
        mapping = SDL_GameControllerMapping(ctrl);
        SDL_Log("Controller %i is mapped as \"%s\".", i, mapping);
    } else {
        SDL_Log("Index \'%i\' is not a compatible controller.", i);


The returned string must be freed with SDL_free().

More information about the mapping can be found on the page for SDL_GameControllerAddMapping().


This function is available since SDL 2.0.0.

CategoryAPI, CategoryGameController

None: SDL_GameControllerMapping (last edited 2016-04-10 22:39:25 by PhilippWiesemann)

Please include your contact information if you'd like to receive a reply.