gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions 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
1 changed files with 7 additions and 7 deletions
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. * Get the number of sample frames currently queued.
* *
* Since audio streams can change their input format at any time, even if there * Since audio streams can change their input format at any time, even if
* is still data queued in a different format, this reports the queued _sample * there is still data queued in a different format, this reports the queued
* frames_, so if you queue two stereo samples in float32 format and then * _sample frames_, so if you queue two stereo samples in float32 format and
* queue five mono samples in Sint16 format, this will return 6. * then queue five mono samples in Sint16 format, this will return 6.
* *
* Queued data is not converted until it is consumed by SDL_GetAudioStreamData, * Queued data is not converted until it is consumed by
* so this value should be representative of the exact data that was put into * SDL_GetAudioStreamData, so this value should be representative of the exact
* the stream. * data that was put into the stream.
* *
* If the stream has so much data that it would overflow an int, the return * 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 * value is clamped to a maximum value, but no queued data is lost; if there