|
Size: 1490
Comment: update content (old wiki)
|
Size: 1459
Comment: update content - pointers, structs
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 16: | Line 16: |
| ||'''mutex'''||^a pointer to the SDL_mutex structure / mutex to be locked^|| | ||'''mutex'''||^the SDL_mutex to be locked^|| |
DRAFT |
SDL_mutexP
Use this function to lock the a mutex.
Syntax
int SDL_mutexP(SDL_mutex* mutex)
Function Parameters
mutex |
the SDL_mutex to be locked |
Return Value
Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.
Code Examples
You can add your code example here
Remarks
*
SDL_mutexP() locks the mutex, which was previously created with SDL_CreateMutex(). If the mutex is already locked by another thread then SDL_mutexP() will not return until the thread that locked it unlocks it (with SDL_mutexV()). If called repeatedly on a mutex, SDL_mutexV() must be called an equal amount number of times to return the mutex to the/an unlocked state.
SDL also defines a macro #define SDL_LockMutex(m) SDL_mutexP(m).
*
-or-
SDL_mutexP(m) and SDL_LockMutex(m) are equivalent.
-or- The macro SDL_LockMutex(m) will call SDL_mutexP(m).
green
