gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source
This commit is contained in:
SDL Wiki Bot
2023-04-28 19:09:14 +00:00
parent 87ad71f9b2
commit 78cfc23993
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
include/SDL3/SDL_mutex.h
View File

@@ -516,8 +516,8 @@ extern DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_Semaphore *sem);
* signal or error. If the call is successful it will atomically decrement the * signal or error. If the call is successful it will atomically decrement the
* semaphore value. * semaphore value.
* *
* This function is the equivalent of calling SDL_WaitSemaphoreTimeout() with a time * This function is the equivalent of calling SDL_WaitSemaphoreTimeout() with
* length of `SDL_MUTEX_MAXWAIT`. * a time length of `SDL_MUTEX_MAXWAIT`.
* *
* \param sem the semaphore wait on * \param sem the semaphore wait on
* \returns 0 on success or a negative error code on failure; call * \returns 0 on success or a negative error code on failure; call
@@ -695,16 +695,16 @@ extern DECLSPEC int SDLCALL SDL_BroadcastCondition(SDL_Condition *cond);
* Wait until a condition variable is signaled. * Wait until a condition variable is signaled.
* *
* This function unlocks the specified `mutex` and waits for another thread to * This function unlocks the specified `mutex` and waits for another thread to
* call SDL_SignalCondition() or SDL_BroadcastCondition() on the condition variable * call SDL_SignalCondition() or SDL_BroadcastCondition() on the condition
* `cond`. Once the condition variable is signaled, the mutex is re-locked and * variable `cond`. Once the condition variable is signaled, the mutex is
* the function returns. * re-locked and the function returns.
* *
* The mutex must be locked before calling this function. Locking the mutex * The mutex must be locked before calling this function. Locking the mutex
* recursively (more than once) is not supported and leads to undefined * recursively (more than once) is not supported and leads to undefined
* behavior. * behavior.
* *
* This function is the equivalent of calling SDL_WaitConditionTimeout() with a * This function is the equivalent of calling SDL_WaitConditionTimeout() with
* time length of `SDL_MUTEX_MAXWAIT`. * a time length of `SDL_MUTEX_MAXWAIT`.
* *
* \param cond the condition variable to wait on * \param cond the condition variable to wait on
* \param mutex the mutex used to coordinate thread access * \param mutex the mutex used to coordinate thread access
@@ -725,10 +725,10 @@ extern DECLSPEC int SDLCALL SDL_WaitCondition(SDL_Condition *cond, SDL_Mutex *mu
* Wait until a condition variable is signaled or a certain time has passed. * Wait until a condition variable is signaled or a certain time has passed.
* *
* This function unlocks the specified `mutex` and waits for another thread to * This function unlocks the specified `mutex` and waits for another thread to
* call SDL_SignalCondition() or SDL_BroadcastCondition() on the condition variable * call SDL_SignalCondition() or SDL_BroadcastCondition() on the condition
* `cond`, or for the specified time to elapse. Once the condition variable is * variable `cond`, or for the specified time to elapse. Once the condition
* signaled or the time elapsed, the mutex is re-locked and the function * variable is signaled or the time elapsed, the mutex is re-locked and the
* returns. * function returns.
* *
* The mutex must be locked before calling this function. Locking the mutex * The mutex must be locked before calling this function. Locking the mutex
* recursively (more than once) is not supported and leads to undefined * recursively (more than once) is not supported and leads to undefined