wikiheaders: Add a \threadsafety tag to document threading details.

Reference Issue #7140.

(cherry picked from commit 01cba48d18)
This commit is contained in:
Ryan C. Gordon 2023-01-24 22:13:25 -05:00
parent 507fc462db
commit 1069c8931d
No known key found for this signature in database
GPG key ID: FA148B892AB48044
2 changed files with 43 additions and 0 deletions

View file

@ -1733,6 +1733,11 @@ extern DECLSPEC int SDLCALL SDL_RenderReadPixels(SDL_Renderer * renderer,
*
* \since This function is available since SDL 2.0.0.
*
* \threadsafety You may only call this function on the main thread. If
* this happens to work on a background thread on any given
* platform or backend, it's purely by luck and you should
* not rely on it to work next time.
*
* \sa SDL_RenderClear
* \sa SDL_RenderDrawLine
* \sa SDL_RenderDrawLines