mirrors
/
SDL
mirror of https://github.com/libsdl-org/SDL
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

This commit is contained in:
SDL Wiki Bot 2024-07-22 22:19:38 +00:00
parent a36be94ad1
commit 2aea74aa84
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/SDL3/SDL_events.h
View File

@ -1432,13 +1432,18 @@ extern SDL_DECLSPEC void * SDLCALL SDL_AllocateTemporaryMemory(size_t size);
/**
* Claim ownership of temporary memory.
*
* Some functions return temporary memory which SDL will automatically clean up. If you want to hold onto it for a long time or beyond the current function scope, you can call this function to get a pointer that you own, and can free using SDL_free() when you're done.
* Some functions return temporary memory which SDL will automatically clean
* up. If you want to hold onto it for a long time or beyond the current
* function scope, you can call this function to get a pointer that you own,
* and can free using SDL_free() when you're done.
*
* If the memory isn't temporary, this will return NULL, and you don't have ownership of the memory.
* If the memory isn't temporary, this will return NULL, and you don't have
* ownership of the memory.
*
* \param mem a pointer allocated with SDL_AllocateTemporaryMemory().
* \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 is not owned by this thread.
* be freed using SDL_free(), or NULL if the memory is not temporary
* or is not owned by this thread.
*
* \threadsafety It is safe to call this function from any thread.
*