SDL_AudioStreamCallback: Note that there's no _requirement_ to do anything.

This is as opposed to something like the SDL2 audio callback, where you
_must_ supply data or disaster occurs.
main
Ryan C. Gordon 2024-04-11 08:56:10 -04:00
parent 6ccdfffe26
commit 9421a01400
No known key found for this signature in database
GPG Key ID: FA148B892AB48044
1 changed files with 5 additions and 0 deletions

View File

@ -1003,6 +1003,11 @@ extern DECLSPEC int SDLCALL SDL_UnlockAudioStream(SDL_AudioStream *stream);
* Byte counts might be slightly overestimated due to buffering or
* resampling, and may change from call to call.
*
* This callback is not required to do anything. Generally this is useful
* for adding/reading data on demand, and the app will often put/get data as
* appropriate, but the system goes on with the data currently available
* to it if this callback does nothing.
*
* \param stream The SDL audio stream associated with this callback.
* \param additional_amount The amount of data, in bytes, that is needed right now.
* \param total_amount The total amount of data requested, in bytes, that is requested or available.