eden-emu/SDL
20
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

include: SDL_ConvertAudioSamples docs now warn about converting in chunks.

Browse source 
Fixes #7154.
This commit is contained in:
Ryan C. Gordon 2023-05-09 14:24:22 -04:00
parent 7b6dabd81f
commit 2b6cb7bfb2
No known key found for this signature in database
GPG key ID: FA148B892AB48044
1 changed files with 11 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

13
include/SDL3/SDL_audio.h
View file

@ -1221,11 +1221,20 @@ extern DECLSPEC void SDLCALL SDL_UnlockAudioDevice(SDL_AudioDeviceID dev);
*/
extern DECLSPEC void SDLCALL SDL_CloseAudioDevice(SDL_AudioDeviceID dev);
/* !!! FIXME: maybe remove this before SDL3's API is locked down. */
/**
* Convert some audio data of one format to another format.
*
* Please note that this function is for convenience, but should not
* be used to resample audio in blocks, as it will introduce audio
* artifacts on the boundaries. You should only use this function if
* you are converting audio data in its entirety in one call. If you
* want to convert audio in smaller chunks, use an SDL_AudioStream,
* which is designed for this situation.
*
* Internally, this function creates and destroys an SDL_AudioStream
* on each use, so it's also less efficient than using one directly,
* if you need to convert multiple times.
*
* \param src_format The format of the source audio
* \param src_channels The number of channels of the source audio
* \param src_rate The sampling rate of the source audio