mirrors/SDL
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source
This commit is contained in:
SDL Wiki Bot 2024-07-16 19:03:15 +00:00
parent 4aeabb3c3b
commit d65a8146b9
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/SDL3/SDL_events.h
View File

@ -1427,9 +1427,15 @@ 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 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 free any temporary memory created by that thread.
* This function frees temporary memory allocated for events and APIs that
* return temporary strings. 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
* free any temporary memory created by that thread.
*
* 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.
* 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.
*
* \threadsafety It is safe to call this function from any thread.
*

4
include/SDL3/SDL_thread.h
View File

@ -492,7 +492,9 @@ typedef void (SDLCALL *SDL_TLSDestructorCallback)(void *value);
/**
* Set the current thread's value associated with a thread local storage ID.
*
* If the thread local storage ID is not initialized (the value is 0), a new ID will be created in a thread-safe way, so all calls using a pointer to the same ID will refer to the same local storage.
* If the thread local storage ID is not initialized (the value is 0), a new
* ID will be created in a thread-safe way, so all calls using a pointer to
* the same ID will refer to the same local storage.
*
* Note that replacing a value from a previous call to this function on the
* same thread does _not_ call the previous value's destructor!