mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-09-21 18:58:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

audio: Minor documentation clarifications.

Browse Source
This commit is contained in:
Ryan C. Gordon
2024-05-25 23:33:02 -04:00
parent 0e1f3b681f
commit 6a40a8eb12
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
include/SDL3/SDL_audio.h
View File

@@ -420,7 +420,11 @@ extern SDL_DECLSPEC const char *SDLCALL SDL_GetCurrentAudioDriver(void);
* This only returns a list of physical devices; it will not have any device * This only returns a list of physical devices; it will not have any device
* IDs returned by SDL_OpenAudioDevice(). * IDs returned by SDL_OpenAudioDevice().
* *
* \param count a pointer filled in with the number of devices returned * If this function returns NULL, to signify an error, `*count` will be set
* to zero.
*
* \param count a pointer filled in with the number of devices returned. NULL
* is allowed.
* \returns a 0 terminated array of device instance IDs which should be freed * \returns a 0 terminated array of device instance IDs which should be freed
* with SDL_free(), or NULL on error; call SDL_GetError() for more * with SDL_free(), or NULL on error; call SDL_GetError() for more
* details. * details.
@@ -445,7 +449,11 @@ extern SDL_DECLSPEC SDL_AudioDeviceID *SDLCALL SDL_GetAudioOutputDevices(int *co
* This only returns a list of physical devices; it will not have any device * This only returns a list of physical devices; it will not have any device
* IDs returned by SDL_OpenAudioDevice(). * IDs returned by SDL_OpenAudioDevice().
* *
* \param count a pointer filled in with the number of devices returned * If this function returns NULL, to signify an error, `*count` will be set
* to zero.
*
* \param count a pointer filled in with the number of devices returned. NULL
* is allowed.
* \returns a 0 terminated array of device instance IDs which should be freed * \returns a 0 terminated array of device instance IDs which should be freed
* with SDL_free(), or NULL on error; call SDL_GetError() for more * with SDL_free(), or NULL on error; call SDL_GetError() for more
* details. * details.