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

SDL_AddGamepadMappingsFromIO

Load a set of gamepad mappings from an SDL_IOStream.

Header File

Syntax

int SDL_AddGamepadMappingsFromIO(SDL_IOStream *src, bool closeio);

Function Parameters

SDL_IOStream *	src	the data stream for the mappings to be added.
bool	closeio	if true, calls SDL_CloseIO() on `src` before returning, even in the case of an error.

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

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.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.1.3.