zdoom
/
fluidsynth
mirror of https://github.com/ZDoom/fluidsynth.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: elaborate on sample buffer zeroing 

of fluid_synth_process()
This commit is contained in:
derselbst 2018-06-18 16:15:24 +02:00
parent c309e417c5
commit b9c75f3a8e
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/synth/fluid_synth.c
View File

@ -3104,8 +3104,10 @@ alias with buffers of \c fx.
* @return #FLUID_OK on success, #FLUID_FAILED otherwise.
*
* @parblock
* @note Make sure to zero out the sample buffers before calling this
* function as any synthesized audio is mixed (i.e. added) to the buffers.
* @note The owner of the sample buffers must zero them out before calling this
* function, because any synthesized audio is mixed (i.e. added) to the buffers.
* E.g. if fluid_synth_process() is called from a custom audio driver process function
* (see new_fluid_audio_driver2()), the audio driver takes care of zeroing the buffers.
* @endparblock
*
* @parblock