zdoom/fluidsynth
0
0
Fork 0
mirror of https://github.com/ZDoom/fluidsynth.git synced 2025-04-15 20:30:49 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix incorrect documentation of fluid_sample_sizeof()

Browse source
This commit is contained in:
derselbst 2018-12-29 18:26:37 +01:00
parent b7b420617b
commit 8634613509
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/sfloader/fluid_sfont.c
View file

@ -512,11 +512,13 @@ delete_fluid_sample(fluid_sample_t *sample)
/**
* Returns the size of the fluid_sample_t structure.
*
* Useful in low latency scenarios e.g. to allocate a sample on the stack.
* Useful in low latency scenarios e.g. to allocate a pool of samples.
*
* @return Size of fluid_sample_t in bytes
*
* @note It is recommend to zero initialize the memory before using the object.
*
* @warning Do NOT allocate samples on the stack and assign them to a voice!
*/
size_t fluid_sample_sizeof()
{