SDL Wiki
(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_TryLockRWLockForReading

Try to lock a read/write lock for reading without blocking.

Header File

Defined in <SDL3/SDL_mutex.h>

Syntax

bool SDL_TryLockRWLockForReading(SDL_RWLock *rwlock);

Function Parameters

SDL_RWLock * rwlock the rwlock to try to lock.

Return Value

(bool) Returns true on success, false if the lock would block.

Remarks

This works just like SDL_LockRWLockForReading(), but if the rwlock is not available, then this function returns false immediately.

This technique is useful if you need access to a resource but don't want to wait for it, and will return to it to try again later.

Trying to lock for read-only access can succeed if other threads are holding read-only locks, as this won't prevent access.

This function returns true if passed a NULL rwlock.

Version

This function is available since SDL 3.1.3.

See Also


CategoryAPI, CategoryAPIFunction, CategoryMutex


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.