devela::_dep::sdl3::sys::gamepad

Function SDL_AddGamepadMappingsFromIO

pub unsafe extern "C" fn SDL_AddGamepadMappingsFromIO(
    src: *mut SDL_IOStream,
    closeio: bool,
) -> i32
Available on crate feature dep_sdl3 only.
Expand description

Load a set of gamepad mappings from an SDL_IOStream.

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.

§Parameters

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

§Return value

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

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.

§See also