SDL_AddGamepadMappingsFromFile

Load a set of gamepad mappings from a file.

Header File

Syntax

int SDL_AddGamepadMappingsFromFile(const char *file);

Function Parameters

const char *

file

the mappings file to load.

Return Value

(int) Returns the number of mappings added or -1 on failure; call SDL_GetError() for more information.

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 gamepad GUID, the later version will overwrite the one currently loaded.

Any new mappings for already plugged in controllers will generate SDL_EVENT_GAMEPAD_ADDED events.

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

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.2.0.