Size: 1702
Comment: Added SDL_Init() in example.
|
← 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 26: | Line 26: |
Returns a string that has the controller's mapping. More information about the mapping can be found on [[SDL_GameControllerAddMapping]]; call [[SDL_GetError]]() for more information. | Returns a string that has the controller's mapping or NULL if no mapping is available; call [[SDL_GetError]]() for more information. |
Line 30: | Line 30: |
#include <stdio.h> /* for printf() */ | #include "SDL.h" |
Line 41: | Line 41: |
printf("Index \'%i\' is a compatible controller, named \'%s\'\n", i, SDL_GameControllerNameForIndex(i)); | char *mapping; SDL_Log("Index \'%i\' is a compatible controller, named \'%s\'", i, SDL_GameControllerNameForIndex(i)); |
Line 43: | Line 44: |
printf("Controller %i is mapped as \"%s\".\n", i, SDL_GameControllerMapping(ctrl)); | mapping = SDL_GameControllerMapping(ctrl); SDL_Log("Controller %i is mapped as \"%s\".", i, mapping); SDL_free(mapping); |
Line 45: | Line 48: |
printf("Index \'%i\' is not a compatible controller.", i); | SDL_Log("Index \'%i\' is not a compatible controller.", i); |
Line 52: | Line 55: |
More information about the mapping can be found on the page for [[SDL_GameControllerAddMapping]](). == Version == This function is available since SDL 2.0.0. |
DRAFT |
SDL_GameControllerMapping
Use this function to get the current mapping of a Game Controller.
Contents
Syntax
char* SDL_GameControllerMapping(SDL_GameController* gamecontroller)
Function Parameters
gamecontroller |
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;
SDL_Init(SDL_INIT_GAMECONTROLLER);
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);
SDL_free(mapping);
} else {
SDL_Log("Index \'%i\' is not a compatible controller.", i);
}
}
Remarks
The returned string must be freed with SDL_free().
More information about the mapping can be found on the page for SDL_GameControllerAddMapping().
Version
This function is available since SDL 2.0.0.