NAME¶

Mix_EachSoundFont - Iterate SoundFonts paths to use by supported MIDI backends.

HEADER FILE¶

Defined in SDL3_mixer/SDL_mixer.h

SYNOPSIS¶

#include "SDL3_mixer/SDL_mixer.h"

bool Mix_EachSoundFont(Mix_EachSoundFontCallback function, void *data);

DESCRIPTION¶

This function will take the string reported by

Mix_GetSoundFonts (), split it up into separate paths, as delimited by semicolons in the string, and call a callback function for each separate path.

If there are no paths available, this returns 0 without calling the callback at all.

If the callback returns non-zero, this function stops iterating and returns non-zero. If the callback returns 0, this function will continue iterating, calling the callback again for further paths. If the callback never returns 1, this function returns 0, so this can be used to decide if an available soundfont is acceptable for use.

FUNCTION PARAMETERS¶

function

the callback function to call once per path.

data

a pointer to pass to the callback for its own personal use.

RETURN VALUE¶

Returns true if callback ever returned true, false on error or if the callback never returned true.

AVAILABILITY¶

This function is available since SDL_mixer 3.0.0.

SEE ALSO¶

•(3), Mix_GetSoundFonts(3)