mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2026-02-16 08:34:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

audio: Clarified SDL_GetAudioStreamQueued docs.

Browse Source
This commit is contained in:
Ryan C. Gordon
2024-10-02 15:25:31 -04:00
parent 47450425fd
commit 35b002be82
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
include/SDL3/SDL_audio.h
View File

@@ -1322,6 +1322,12 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamAvailable(SDL_AudioStream *str
/**
* Get the number of bytes currently queued.
*
* This is the number of bytes put into a stream as input, not the number
* that can be retrieved as output. Because of several details, it's not
* possible to calculate one number directly from the other. If you need to
* know how much usable data can be retrieved right now, you should use
* SDL_GetAudioStreamAvailable() and not this function.
*
* Note that audio streams can change their input format at any time, even if
* there is still data queued in a different format, so the returned byte
* count will not necessarily match the number of _sample frames_ available.