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

Sync SDL3 wiki -> header

Browse source
This commit is contained in:
SDL Wiki Bot 2023-05-09 18:27:15 +00:00
parent 2b6cb7bfb2
commit 9786d8ac40
1 changed files with 8 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

17
include/SDL3/SDL_audio.h
View file

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