From 6b34c9fe7f55c3627b183b4e4dbc12a58e9e6346 Mon Sep 17 00:00:00 2001 From: SDL Wiki Bot Date: Wed, 8 Jan 2025 01:50:36 +0000 Subject: [PATCH] Sync SDL3 wiki -> header [ci skip] --- include/SDL3/SDL_asyncio.h | 22 +++++++++--------- include/SDL3/SDL_audio.h | 4 ++-- include/SDL3/SDL_dialog.h | 2 +- include/SDL3/SDL_filesystem.h | 2 +- include/SDL3/SDL_gpu.h | 6 ++--- include/SDL3/SDL_init.h | 4 ++-- include/SDL3/SDL_iostream.h | 4 ++-- include/SDL3/SDL_render.h | 4 ++-- include/SDL3/SDL_thread.h | 2 +- include/SDL3/SDL_tray.h | 42 +++++++++++++++++------------------ 10 files changed, 46 insertions(+), 46 deletions(-) diff --git a/include/SDL3/SDL_asyncio.h b/include/SDL3/SDL_asyncio.h index d8af8b6c9d..ee13bf3ae6 100644 --- a/include/SDL3/SDL_asyncio.h +++ b/include/SDL3/SDL_asyncio.h @@ -213,7 +213,7 @@ typedef struct SDL_AsyncIOQueue SDL_AsyncIOQueue; * \returns a pointer to the SDL_AsyncIO structure that is created or NULL on * failure; call SDL_GetError() for more information. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_CloseAsyncIO * \sa SDL_ReadAsyncIO @@ -234,7 +234,7 @@ extern SDL_DECLSPEC SDL_AsyncIO * SDLCALL SDL_AsyncIOFromFile(const char *file, * * \threadsafety It is safe to call this function from any thread. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. */ extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetAsyncIOSize(SDL_AsyncIO *asyncio); @@ -269,7 +269,7 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetAsyncIOSize(SDL_AsyncIO *asyncio); * * \threadsafety It is safe to call this function from any thread. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_WriteAsyncIO * \sa SDL_CreateAsyncIOQueue @@ -306,7 +306,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_ReadAsyncIO(SDL_AsyncIO *asyncio, void *ptr * * \threadsafety It is safe to call this function from any thread. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_ReadAsyncIO * \sa SDL_CreateAsyncIOQueue @@ -358,7 +358,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WriteAsyncIO(SDL_AsyncIO *asyncio, void *pt * \threadsafety It is safe to call this function from any thread, but two * threads should not attempt to close the same object. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. */ extern SDL_DECLSPEC bool SDLCALL SDL_CloseAsyncIO(SDL_AsyncIO *asyncio, bool flush, SDL_AsyncIOQueue *queue, void *userdata); @@ -373,7 +373,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CloseAsyncIO(SDL_AsyncIO *asyncio, bool flu * * \threadsafety It is safe to call this function from any thread. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_DestroyAsyncIOQueue * \sa SDL_GetAsyncIOResult @@ -407,7 +407,7 @@ extern SDL_DECLSPEC SDL_AsyncIOQueue * SDLCALL SDL_CreateAsyncIOQueue(void); * no other thread is waiting on the queue with * SDL_WaitAsyncIOResult. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. */ extern SDL_DECLSPEC void SDLCALL SDL_DestroyAsyncIOQueue(SDL_AsyncIOQueue *queue); @@ -431,7 +431,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyAsyncIOQueue(SDL_AsyncIOQueue *queue * * \threadsafety It is safe to call this function from any thread. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_WaitAsyncIOResult */ @@ -475,7 +475,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetAsyncIOResult(SDL_AsyncIOQueue *queue, S * * \threadsafety It is safe to call this function from any thread. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_SignalAsyncIOQueue */ @@ -499,7 +499,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitAsyncIOResult(SDL_AsyncIOQueue *queue, * * \threadsafety It is safe to call this function from any thread. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_WaitAsyncIOResult */ @@ -531,7 +531,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SignalAsyncIOQueue(SDL_AsyncIOQueue *queue) * \returns true on success or false on failure; call SDL_GetError() for more * information. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_LoadFile_IO */ diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h index 8cbaa98f10..7eefaf2943 100644 --- a/include/SDL3/SDL_audio.h +++ b/include/SDL3/SDL_audio.h @@ -745,7 +745,7 @@ extern SDL_DECLSPEC SDL_AudioDeviceID SDLCALL SDL_OpenAudioDevice(SDL_AudioDevic * * \threadsafety It is safe to call this function from any thread. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. */ extern SDL_DECLSPEC bool SDLCALL SDL_IsAudioDevicePhysical(SDL_AudioDeviceID devid); @@ -759,7 +759,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_IsAudioDevicePhysical(SDL_AudioDeviceID dev * * \threadsafety It is safe to call this function from any thread. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. */ extern SDL_DECLSPEC bool SDLCALL SDL_IsAudioDevicePlayback(SDL_AudioDeviceID devid); diff --git a/include/SDL3/SDL_dialog.h b/include/SDL3/SDL_dialog.h index ca31629594..22cd8e376f 100644 --- a/include/SDL3/SDL_dialog.h +++ b/include/SDL3/SDL_dialog.h @@ -312,7 +312,7 @@ typedef enum SDL_FileDialogType * callback may be invoked from the same thread or from a * different one, depending on the OS's constraints. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_FileDialogType * \sa SDL_DialogFileCallback diff --git a/include/SDL3/SDL_filesystem.h b/include/SDL3/SDL_filesystem.h index 1624113a91..c228a0382f 100644 --- a/include/SDL3/SDL_filesystem.h +++ b/include/SDL3/SDL_filesystem.h @@ -484,7 +484,7 @@ extern SDL_DECLSPEC char ** SDLCALL SDL_GlobDirectory(const char *path, const ch * platform-dependent notation. NULL if there's a problem. This * should be freed with SDL_free() when it is no longer needed. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. */ extern SDL_DECLSPEC char * SDLCALL SDL_GetCurrentDirectory(void); diff --git a/include/SDL3/SDL_gpu.h b/include/SDL3/SDL_gpu.h index b93f5761dd..123c71b9db 100644 --- a/include/SDL3/SDL_gpu.h +++ b/include/SDL3/SDL_gpu.h @@ -3664,7 +3664,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetGPUSwapchainParameters( * \returns true if successful, false on error; call SDL_GetError() for more * information. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. */ extern SDL_DECLSPEC bool SDLCALL SDL_SetGPUAllowedFramesInFlight( SDL_GPUDevice *device, @@ -3749,7 +3749,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_AcquireGPUSwapchainTexture( * \threadsafety This function should only be called from the thread that * created the window. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_AcquireGPUSwapchainTexture * \sa SDL_WaitAndAcquireGPUSwapchainTexture @@ -3792,7 +3792,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_WaitForGPUSwapchain( * \threadsafety This function should only be called from the thread that * created the window. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_SubmitGPUCommandBuffer * \sa SDL_SubmitGPUCommandBufferAndAcquireFence diff --git a/include/SDL3/SDL_init.h b/include/SDL3/SDL_init.h index 776c52b33e..6eb21f841c 100644 --- a/include/SDL3/SDL_init.h +++ b/include/SDL3/SDL_init.h @@ -313,7 +313,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_Quit(void); * * \threadsafety It is safe to call this function from any thread. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_RunOnMainThread */ @@ -350,7 +350,7 @@ typedef void (SDLCALL *SDL_MainThreadCallback)(void *userdata); * * \threadsafety It is safe to call this function from any thread. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_IsMainThread */ diff --git a/include/SDL3/SDL_iostream.h b/include/SDL3/SDL_iostream.h index e0456c7c29..9bc5bc7a9d 100644 --- a/include/SDL3/SDL_iostream.h +++ b/include/SDL3/SDL_iostream.h @@ -703,7 +703,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_LoadFile(const char *file, size_t *datasi * \returns true on success or false on failure; call SDL_GetError() for more * information. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_SaveFile * \sa SDL_LoadFile_IO @@ -720,7 +720,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SaveFile_IO(SDL_IOStream *src, const void * * \returns true on success or false on failure; call SDL_GetError() for more * information. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_SaveFile_IO * \sa SDL_LoadFile diff --git a/include/SDL3/SDL_render.h b/include/SDL3/SDL_render.h index c691536345..d7428b075c 100644 --- a/include/SDL3/SDL_render.h +++ b/include/SDL3/SDL_render.h @@ -2110,7 +2110,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderTextureRotated(SDL_Renderer *renderer * * \threadsafety You may only call this function from the main thread. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_RenderTexture */ @@ -2568,7 +2568,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_RenderDebugText(SDL_Renderer *renderer, flo * * \threadsafety This function should only be called on the main thread. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_RenderDebugText * \sa SDL_DEBUG_TEXT_FONT_CHARACTER_SIZE diff --git a/include/SDL3/SDL_thread.h b/include/SDL3/SDL_thread.h index c729c52822..d7d83edb51 100644 --- a/include/SDL3/SDL_thread.h +++ b/include/SDL3/SDL_thread.h @@ -446,7 +446,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread *thread, int *status) * \returns the current state of a thread, or SDL_THREAD_UNKNOWN if the thread * isn't valid. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_ThreadState */ diff --git a/include/SDL3/SDL_tray.h b/include/SDL3/SDL_tray.h index 77f3d0836d..d6d6042658 100644 --- a/include/SDL3/SDL_tray.h +++ b/include/SDL3/SDL_tray.h @@ -106,7 +106,7 @@ typedef void (SDLCALL *SDL_TrayCallback)(void *userdata, SDL_TrayEntry *entry); * UTF-8 encoding. Not supported on all platforms. May be NULL. * \returns The newly created system tray icon. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_CreateTrayMenu * \sa SDL_GetTrayMenu @@ -120,7 +120,7 @@ extern SDL_DECLSPEC SDL_Tray *SDLCALL SDL_CreateTray(SDL_Surface *icon, const ch * \param tray the tray icon to be updated. * \param icon the new icon. May be NULL. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_CreateTray */ @@ -132,7 +132,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetTrayIcon(SDL_Tray *tray, SDL_Surface *ic * \param tray the tray icon to be updated. * \param tooltip the new tooltip in UTF-8 encoding. May be NULL. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_CreateTray */ @@ -151,7 +151,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetTrayTooltip(SDL_Tray *tray, const char * * \param tray the tray to bind the menu to. * \returns the newly created menu. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_CreateTray * \sa SDL_GetTrayMenu @@ -172,7 +172,7 @@ extern SDL_DECLSPEC SDL_TrayMenu *SDLCALL SDL_CreateTrayMenu(SDL_Tray *tray); * \param entry the tray entry to bind the menu to. * \returns the newly created menu. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_InsertTrayEntryAt * \sa SDL_GetTraySubmenu @@ -194,7 +194,7 @@ extern SDL_DECLSPEC SDL_TrayMenu *SDLCALL SDL_CreateTraySubmenu(SDL_TrayEntry *e * \param tray the tray entry to bind the menu to. * \returns the newly created menu. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_CreateTray * \sa SDL_CreateTrayMenu @@ -215,7 +215,7 @@ extern SDL_DECLSPEC SDL_TrayMenu *SDLCALL SDL_GetTrayMenu(SDL_Tray *tray); * \param entry the tray entry to bind the menu to. * \returns the newly created menu. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_InsertTrayEntryAt * \sa SDL_CreateTraySubmenu @@ -232,7 +232,7 @@ extern SDL_DECLSPEC SDL_TrayMenu *SDLCALL SDL_GetTraySubmenu(SDL_TrayEntry *entr * pointer becomes invalid when any function that inserts or deletes * entries in the menu is called. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_RemoveTrayEntry * \sa SDL_InsertTrayEntryAt @@ -244,7 +244,7 @@ extern SDL_DECLSPEC const SDL_TrayEntry **SDLCALL SDL_GetTrayEntries(SDL_TrayMen * * \param entry The entry to be deleted. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_GetTrayEntries * \sa SDL_InsertTrayEntryAt @@ -267,7 +267,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_RemoveTrayEntry(SDL_TrayEntry *entry); * \param flags a combination of flags, some of which are mandatory. * \returns the newly created entry, or NULL if pos is out of bounds. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_TrayEntryFlags * \sa SDL_GetTrayEntries @@ -287,7 +287,7 @@ extern SDL_DECLSPEC SDL_TrayEntry *SDLCALL SDL_InsertTrayEntryAt(SDL_TrayMenu *m * \param entry the entry to be updated. * \param label the new label for the entry in UTF-8 encoding. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_GetTrayEntries * \sa SDL_InsertTrayEntryAt @@ -303,7 +303,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetTrayEntryLabel(SDL_TrayEntry *entry, con * \param entry the entry to be read. * \returns the label of the entry in UTF-8 encoding. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_GetTrayEntries * \sa SDL_InsertTrayEntryAt @@ -320,7 +320,7 @@ extern SDL_DECLSPEC const char *SDLCALL SDL_GetTrayEntryLabel(SDL_TrayEntry *ent * \param checked SDL_TRUE if the entry should be checked; SDL_FALSE * otherwise. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_GetTrayEntries * \sa SDL_InsertTrayEntryAt @@ -336,7 +336,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetTrayEntryChecked(SDL_TrayEntry *entry, b * \param entry the entry to be read. * \returns SDL_TRUE if the entry is checked; SDL_FALSE otherwise. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_GetTrayEntries * \sa SDL_InsertTrayEntryAt @@ -351,7 +351,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTrayEntryChecked(SDL_TrayEntry *entry); * \param enabled SDL_TRUE if the entry should be enabled; SDL_FALSE * otherwise. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_GetTrayEntries * \sa SDL_InsertTrayEntryAt @@ -365,7 +365,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetTrayEntryEnabled(SDL_TrayEntry *entry, b * \param entry the entry to be read. * \returns SDL_TRUE if the entry is enabled; SDL_FALSE otherwise. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_GetTrayEntries * \sa SDL_InsertTrayEntryAt @@ -381,7 +381,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetTrayEntryEnabled(SDL_TrayEntry *entry); * \param userdata an optional pointer to pass extra data to the callback when * it will be invoked. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_GetTrayEntries * \sa SDL_InsertTrayEntryAt @@ -395,7 +395,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetTrayEntryCallback(SDL_TrayEntry *entry, * * \param tray the tray icon to be destroyed. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_CreateTray */ @@ -407,7 +407,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyTray(SDL_Tray *tray); * \param entry the entry for which to get the parent menu. * \returns the parent menu. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_InsertTrayEntryAt */ @@ -423,7 +423,7 @@ extern SDL_DECLSPEC SDL_TrayMenu *SDLCALL SDL_GetTrayEntryParent(SDL_TrayEntry * * \param menu the menu for which to get the parent entry. * \returns the parent entry, or NULL if this menu is not a submenu. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_CreateTraySubmenu * \sa SDL_GetTrayMenuParentTray @@ -440,7 +440,7 @@ extern SDL_DECLSPEC SDL_TrayEntry *SDLCALL SDL_GetTrayMenuParentEntry(SDL_TrayMe * \param menu the menu for which to get the parent enttrayry. * \returns the parent tray, or NULL if this menu is a submenu. * - * \since This function is available since SDL 3.2.0. + * \since This function is available since SDL 3.1.8. * * \sa SDL_CreateTrayMenu * \sa SDL_GetTrayMenuParentEntry