|
Size: 775
Comment:
|
Size: 924
Comment: Per quick feedback form, clarifying that this call is blocking
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 24: | Line 24: |
| ''You can add useful comments here'' | Calls to this function will not return while the mutex is locked by another thread. See [[SDL_TryLockMutex]] to attempt to lock the mutex without blocking. SDL mutexes are recursive. |
SDL_LockMutex
Use this function to lock a mutex created with SDL_CreateMutex().
Contents
Syntax
int SDL_LockMutex(SDL_mutex* mutex)
Function Parameters
mutex |
the mutex to lock |
Return Value
Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.
Code Examples
SDL_mutex *mutex;
mutex = SDL_CreateMutex();
if (!mutex) {
fprintf(stderr, "Couldn't create mutex\n");
return;
}
if (SDL_LockMutex(mutex) == 0) {
/* Do stuff while mutex is locked */
SDL_UnlockMutex(mutex);
} else {
fprintf(stderr, "Couldn't lock mutex\n");
}
SDL_DestroyMutex(mutex);
Remarks
Calls to this function will not return while the mutex is locked by another thread. See SDL_TryLockMutex to attempt to lock the mutex without blocking.
SDL mutexes are recursive.
