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

Added SDL_ClaimEventMemory()

Browse Source
This commit is contained in:
Sam Lantinga
2024-07-18 18:04:49 -07:00
parent 2816745f48
commit f95ecac300
5 changed files with 52 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
include/SDL3/SDL_events.h
View File

@@ -1420,10 +1420,32 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_RegisterEvents(int numevents);
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_ClaimEventMemory
* \sa SDL_FreeEventMemory
*/
extern SDL_DECLSPEC void * SDLCALL SDL_AllocateEventMemory(size_t size);
/**
* Claim ownership of temporary event memory allocated by SDL.
*
* This function changes ownership of temporary event memory allocated for events and APIs that
* follow the SDL_GetStringRule. If this function succeeds, the memory will no longer be automatically freed by SDL, it must be freed using SDL_free() by the application.
*
* If the memory isn't temporary, or it was allocated on a different thread, this will return NULL, and the application does not have ownership of the memory.
*
* Note that even if a function follows the SDL_GetStringRule it may not be using temporary event memory, and this function will return NULL in that case.
*
* \param mem a pointer allocated with SDL_AllocateEventMemory().
* \returns a pointer to the memory now owned by the application, which must be freed using SDL_free(), or NULL if the memory is not temporary or was allocated on a different thread.
*
* \threadsafety It is safe to call this function from any thread.
*
* \since This function is available since SDL 3.0.0.
*
* \sa SDL_AllocateEventMemory
*/
extern SDL_DECLSPEC void * SDLCALL SDL_ClaimEventMemory(const void *mem);
/**
* Free temporary event memory allocated by SDL.
*