mirrors/SDL
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source
This commit is contained in:
Ryan C. Gordon 2023-09-20 14:08:32 -04:00
parent 99421b64d0
commit 703aefbce0
No known key found for this signature in database
GPG Key ID: FA148B892AB48044
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/SDL3/SDL_audio.h
View File

@ -862,14 +862,14 @@ extern DECLSPEC int SDLCALL SDL_GetAudioStreamAvailable(SDL_AudioStream *stream)
/**
* Get the number of sample frames currently queued.
*
* Since audio streams can change their input format at any time, even if there
* is still data queued in a different format, this reports the queued _sample
* frames_, so if you queue two stereo samples in float32 format and then
* queue five mono samples in Sint16 format, this will return 6.
* Since audio streams can change their input format at any time, even if
* there is still data queued in a different format, this reports the queued
* _sample frames_, so if you queue two stereo samples in float32 format and
* then queue five mono samples in Sint16 format, this will return 6.
*
* Queued data is not converted until it is consumed by SDL_GetAudioStreamData,
* so this value should be representative of the exact data that was put into
* the stream.
* Queued data is not converted until it is consumed by
* SDL_GetAudioStreamData, so this value should be representative of the exact
* data that was put into the stream.
*
* If the stream has so much data that it would overflow an int, the return
* value is clamped to a maximum value, but no queued data is lost; if there