zdoom/fluidsynth
0
0
Fork 0
mirror of https://github.com/ZDoom/fluidsynth.git synced 2025-04-16 04:31:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update API docs on settings recycling

Browse source
This commit is contained in:
Tom M 2021-01-03 00:05:12 +01:00
parent 57f40ea91c
commit 6339feb106
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/synth/fluid_synth.c
View file

@ -597,10 +597,15 @@ static FLUID_INLINE unsigned int fluid_synth_get_min_note_length_LOCAL(fluid_syn
* @param settings Configuration parameters to use (used directly).
* @return New FluidSynth instance or NULL on error
*
* @note The @p settings parameter is used directly and should freed after
* the synth has been deleted. Further note that you may modify FluidSettings of the
* @note The @p settings parameter is used directly, but the synth does not take ownership of it.
* Hence, the caller is responsible for freeing it, when no longer needed.
* Further note that you may modify FluidSettings of the
* @p settings instance. However, only those FluidSettings marked as 'realtime' will
* affect the synth immediately.
*
* @warning The @p settings object should only be used by a single synth at a time. I.e. creating
* multiple synth instances with a single @p settings object causes undefined behavior. Once the
* "single synth" has been deleted, you may use the @p settings object again for another synth.
*/
fluid_synth_t *
new_fluid_synth(fluid_settings_t *settings)