Sync SDL3 wiki -> header

main
SDL Wiki Bot 2024-04-14 05:35:26 +00:00
parent 041de0c2eb
commit 59c332e569
1 changed files with 15 additions and 14 deletions

View File

@ -146,19 +146,20 @@ extern DECLSPEC void SDLCALL SDL_UnlockSpinlock(SDL_SpinLock *lock);
#ifdef SDL_WIKI_DOCUMENTATION_SECTION #ifdef SDL_WIKI_DOCUMENTATION_SECTION
/** /**
* Mark a compiler barrier. * Mark a compiler barrier.
* *
* A compiler barrier prevents the compiler from reordering * A compiler barrier prevents the compiler from reordering reads and writes
* reads and writes to globally visible variables across the call. * to globally visible variables across the call.
* *
* This macro only prevents the compiler from reordering reads and writes, * This macro only prevents the compiler from reordering reads and writes, it
* it does not prevent the CPU from reordering reads and writes. However, * does not prevent the CPU from reordering reads and writes. However, all of
* all of the atomic operations that modify memory are full memory barriers. * the atomic operations that modify memory are full memory barriers.
* *
* \threadsafety Obviously this macro is safe to use from any thread at * \threadsafety Obviously this macro is safe to use from any thread at any
* any time, but if you find yourself needing this, you are * time, but if you find yourself needing this, you are probably
* probably dealing with some very sensitive code; be careful! * dealing with some very sensitive code; be careful!
* *
* \since This macro is available since SDL 3.0.0. * \since This macro is available since SDL 3.0.0.
*/ */
@ -199,9 +200,9 @@ extern __inline void SDL_CompilerBarrier(void);
* For more information on these semantics, take a look at the blog post: * For more information on these semantics, take a look at the blog post:
* http://preshing.com/20120913/acquire-and-release-semantics * http://preshing.com/20120913/acquire-and-release-semantics
* *
* \threadsafety Obviously this macro is safe to use from any thread at * \threadsafety Obviously this macro is safe to use from any thread at any
* any time, but if you find yourself needing this, you are * time, but if you find yourself needing this, you are probably
* probably dealing with some very sensitive code; be careful! * dealing with some very sensitive code; be careful!
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
*/ */
@ -212,9 +213,9 @@ extern DECLSPEC void SDLCALL SDL_MemoryBarrierReleaseFunction(void);
* *
* Please refer to SDL_MemoryBarrierReleaseFunction for the details! * Please refer to SDL_MemoryBarrierReleaseFunction for the details!
* *
* \threadsafety Obviously this function is safe to use from any thread at * \threadsafety Obviously this function is safe to use from any thread at any
* any time, but if you find yourself needing this, you are * time, but if you find yourself needing this, you are probably
* probably dealing with some very sensitive code; be careful! * dealing with some very sensitive code; be careful!
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
* *