From b9c75f3a8e133df4a441d8ebaa3ce83ece8ead95 Mon Sep 17 00:00:00 2001 From: derselbst Date: Mon, 18 Jun 2018 16:15:24 +0200 Subject: [PATCH] docs: elaborate on sample buffer zeroing of fluid_synth_process() --- src/synth/fluid_synth.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/synth/fluid_synth.c b/src/synth/fluid_synth.c index e01539fa..6bfe13f0 100644 --- a/src/synth/fluid_synth.c +++ b/src/synth/fluid_synth.c @@ -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