eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-06-02 01:47:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

fnsince: update \since policy for documentation.

Browse source 
Everything in SDL3 up to the ABI lock is reported as available since 3.1.3.
Everything else will be reported as since 3.2.0 (what will be the first
official release).

Also ran a Perl script over the headers to change everything to 3.1.3 that
wasn't an API function, since fnsince.pl can't manage those. If there's a
macro or datatype that has snuck in that needs to be 3.2.0 instead, we'll
have to manually fix it up, but it shouldn't be a big deal in any case.

Reference PR #11304.
This commit is contained in:
Ryan C. Gordon 2024-10-23 12:19:38 -04:00
parent 21c91d5535
commit 1c1706a00b
No known key found for this signature in database
GPG key ID: FA148B892AB48044
59 changed files with 1828 additions and 1825 deletions
Download patch file Download diff file Expand all files Collapse all files

14
include/SDL3/SDL_vulkan.h
View file

@ -112,7 +112,7 @@ struct VkAllocationCallbacks;
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_Vulkan_GetVkGetInstanceProcAddr
* \sa SDL_Vulkan_UnloadLibrary
@ -136,14 +136,14 @@ extern SDL_DECLSPEC bool SDLCALL SDL_Vulkan_LoadLibrary(const char *path);
* \returns the function pointer for `vkGetInstanceProcAddr` or NULL on
* failure; call SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*/
extern SDL_DECLSPEC SDL_FunctionPointer SDLCALL SDL_Vulkan_GetVkGetInstanceProcAddr(void);
/**
* Unload the Vulkan library previously loaded by SDL_Vulkan_LoadLibrary().
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_Vulkan_LoadLibrary
*/
@ -167,7 +167,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_Vulkan_UnloadLibrary(void);
* \returns an array of extension name strings on success, NULL on failure;
* call SDL_GetError() for more information.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_Vulkan_CreateSurface
*/
@ -192,7 +192,7 @@ extern SDL_DECLSPEC char const * const * SDLCALL SDL_Vulkan_GetInstanceExtension
* \returns true on success or false on failure; call SDL_GetError() for more
* information.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_Vulkan_GetInstanceExtensions
* \sa SDL_Vulkan_DestroySurface
@ -220,7 +220,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_Vulkan_CreateSurface(SDL_Window *window,
* \param allocator a VkAllocationCallbacks struct, which lets the app set the
* allocator that destroys the surface. Can be NULL.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_Vulkan_GetInstanceExtensions
* \sa SDL_Vulkan_CreateSurface
@ -242,7 +242,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_Vulkan_DestroySurface(VkInstance instance,
* device.
* \returns true if supported, false if unsupported or an error occurred.
*
* \since This function is available since SDL 3.0.0.
* \since This function is available since SDL 3.1.3.
*
* \sa SDL_Vulkan_GetInstanceExtensions
*/