|
Size: 1724
Comment: Initial commit
|
Size: 1824
Comment: Changed description, see SGFunctions page.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 9: | Line 9: |
| Load a set of [[CategoryGameController|Game Controller]] mappings from a file, filtered by the current SDL_GetPlatform() A community sourced database of controllers is available [[https://raw.github.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt|here|target="_blank"]] |
Use this function to load a set of [[CategoryGameController|Game Controller]] mappings from a file, filtered by the current [[SDL_GetPlatform]](). A community sourced database of controllers is available [[https://raw.github.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt|here|target="_blank"]] (on GitHub). |
| Line 26: | Line 26: |
| Returns the number of mappings added, -1 on error; call [[SDL_GetError]]() for more information. | Returns the number of mappings added or -1 on error; call [[SDL_GetError]]() for more information. |
| Line 44: | Line 44: |
| == Version == This function is available in SDL 2.0.2. |
DRAFT |
SDL_GameControllerAddMappingsFromFile
Use this function to load a set of Game Controller mappings from a file, filtered by the current SDL_GetPlatform(). A community sourced database of controllers is available here (on GitHub).
Contents
Syntax
int SDL_GameControllerAddMappingsFromFile(const char* filename)
Function Parameters
filename |
the name of the database you want to load |
Return Value
Returns the number of mappings added or -1 on error; call SDL_GetError() for more information.
Code Examples
SDL_GameControllerAddMappingsFromFile("gamecontrollerdb.txt");
Remarks
You can call this function several times if needed to load different database files.
If a new mapping is loaded for an already known controller GUID, the later version will overwrite the one currently loaded.
Mappings not belonging to the current platform or with no platform field specified will be ignored (i.e. mappings for Linux will be ignored in Windows, etc).
This function will load the text database entirely in memory before processing it, so take this into consideration if you are in a memory constrained environment.
Version
This function is available in SDL 2.0.2.
