mirror
/
SDL
mirror of https://github.com/libsdl-org/SDL.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Sync SDL3 wiki -> header 

[ci skip]
This commit is contained in:
SDL Wiki Bot 2025-04-23 03:31:45 +00:00
parent e3507b390e
commit e3181a0bcd
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
include/SDL3/SDL_audio.h
View File

@ -1434,11 +1434,14 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PutAudioStreamData(SDL_AudioStream *stream,
* Note that `num_samples` is the number of _samples per array_. This can also * Note that `num_samples` is the number of _samples per array_. This can also
* be thought of as the number of _sample frames_ to be queued. A value of 1 * be thought of as the number of _sample frames_ to be queued. A value of 1
* with stereo arrays will queue two samples to the stream. This is different * with stereo arrays will queue two samples to the stream. This is different
* than SDL_PutAudioStreamData, which wants the size of a single array in bytes. * than SDL_PutAudioStreamData, which wants the size of a single array in
* bytes.
* *
* \param stream the stream the audio data is being added to. * \param stream the stream the audio data is being added to.
* \param channel_buffers a pointer to an array of arrays, one array per channel. * \param channel_buffers a pointer to an array of arrays, one array per
* \param num_samples the number of _samples_ per array to write to the stream. * channel.
* \param num_samples the number of _samples_ per array to write to the
* stream.
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
* information. * information.
* *