Documentation cleanup

main
Sam Lantinga 2022-12-27 05:28:18 -08:00
parent 47170d288e
commit 9625fb2832
3 changed files with 6 additions and 10 deletions

View File

@ -15,11 +15,11 @@ General:
* RW_SEEK_CUR -> SDL_RW_SEEK_CUR * RW_SEEK_CUR -> SDL_RW_SEEK_CUR
* RW_SEEK_END -> SDL_RW_SEEK_END * RW_SEEK_END -> SDL_RW_SEEK_END
* RW_SEEK_SET -> SDL_RW_SEEK_SET * RW_SEEK_SET -> SDL_RW_SEEK_SET
* SDL_FreeWAV has been removed and calls can be replaced with SDL_free
* The following functions have been renamed: * The following functions have been renamed:
* SDL_FreeWAV => SDL_free
* Removed the following functions from the API, see docs/README-migration.md for details: * Removed the following functions from the API, see docs/README-migration.md for details:
* SDL_AudioInit * SDL_AudioInit()
* SDL_AudioQuit * SDL_AudioQuit()
* SDL_CalculateGammaRamp() * SDL_CalculateGammaRamp()
* SDL_CreateRGBSurface() * SDL_CreateRGBSurface()
* SDL_CreateRGBSurfaceFrom() * SDL_CreateRGBSurfaceFrom()

View File

@ -42,15 +42,13 @@ The vi format comments have been removed from source code. Vim users can use the
## SDL_audio.h ## SDL_audio.h
- SDL_AudioInit() and SDL_AudioQuit() have been removed. Instead you can call SDL_InitSubSytem() and SDL_QuitSubSytem() with SDL_INIT_AUDIO, which will properly refcount the subsystems. SDL_AudioInit() and SDL_AudioQuit() have been removed. Instead you can call SDL_InitSubSytem() and SDL_QuitSubSytem() with SDL_INIT_AUDIO, which will properly refcount the subsystems. You can choose a specific audio driver using SDL_AUDIO_DRIVER hint.
Also the hint SDL_AUDIO_DRIVER can help to choose a specific driver.
The following functions have been renamed: SDL_FreeWAV has been removed and calls can be replaced with SDL_free.
* SDL_FreeWAV => SDL_free
## SDL_cpuinfo.h ## SDL_cpuinfo.h
- SDL_Has3DNow() has been removed; there is no replacement. SDL_Has3DNow() has been removed; there is no replacement.
The following headers are no longer automatically included, and will need to be included manually: The following headers are no longer automatically included, and will need to be included manually:
- immintrin.h - immintrin.h

View File

@ -311,8 +311,6 @@ extern DECLSPEC const char *SDLCALL SDL_GetAudioDriver(int index);
* initialized. * initialized.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
*
* \sa SDL_INIT_AUDIO
*/ */
extern DECLSPEC const char *SDLCALL SDL_GetCurrentAudioDriver(void); extern DECLSPEC const char *SDLCALL SDL_GetCurrentAudioDriver(void);