mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2026-02-15 00:03:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Allow passing a pointer to SDL_FreeEventMemory()

Browse Source 
Also clarify in the documentation that you should not call SDL_FreeEventMemory(NULL) from your main thread.
This commit is contained in:
Sam Lantinga
2024-07-18 10:32:13 -07:00
parent 217330a7b3
commit 2816745f48
4 changed files with 54 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
include/SDL3/SDL_events.h
View File

@@ -1428,14 +1428,20 @@ extern SDL_DECLSPEC void * SDLCALL SDL_AllocateEventMemory(size_t size);
* Free temporary event memory allocated by SDL.
*
* This function frees temporary memory allocated for events and APIs that
* return temporary strings. This memory is local to the thread that creates
* follow the SDL_GetStringRule. This memory is local to the thread that creates
* it and is automatically freed for the main thread when pumping the event
* loop. For other threads you may want to call this function periodically to
* loop. For other threads you may call this function periodically to
* free any temporary memory created by that thread.
*
* You can free a specific pointer, to provide more fine grained control over memory management, or you can pass NULL to free all pending temporary allocations. You should *NOT* pass NULL on your main event handling thread, as there may be temporary memory being used by events in-flight. For that thread SDL will call this internally when it's safe to do so.
*
* Note that if you call SDL_AllocateEventMemory() on one thread and pass it
* to another thread, e.g. via a user event, then you should be sure the other
* thread has finished processing it before calling this function.
* thread has finished processing it before calling this function with NULL.
*
* All temporary memory is freed on the main thread in SDL_Quit() and for other threads when they call SDL_CleanupTLS(), which is automatically called at cleanup time for threads created using SDL_CreateThread().
*
* \param mem a pointer allocated with SDL_AllocateEventMemory(), or NULL to free all pending temporary allocations.
*
* \threadsafety It is safe to call this function from any thread.
*
@@ -1443,7 +1449,7 @@ extern SDL_DECLSPEC void * SDLCALL SDL_AllocateEventMemory(size_t size);
*
* \sa SDL_AllocateEventMemory
*/
extern SDL_DECLSPEC void SDLCALL SDL_FreeEventMemory(void);
extern SDL_DECLSPEC void SDLCALL SDL_FreeEventMemory(const void *mem);
/* Ends C function definitions when using C++ */
#ifdef __cplusplus

2
include/SDL3/SDL_thread.h
View File

@@ -520,6 +520,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_SetTLS(SDL_TLSID *id, const void *value, SDL
/**
* Cleanup all TLS data for this thread.
*
* If you are creating your threads outside of SDL and then calling SDL functions, you should call this function before your thread exits, to properly clean up SDL memory.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.