(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_TryLockRWLockForReading

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

Header File

Syntax

int SDL_TryLockRWLockForReading(SDL_RWLock *rwlock) SDL_TRY_ACQUIRE_SHARED(0, rwlock);

Function Parameters

rwlock

the rwlock to try to lock

Return Value

Returns 0 or SDL_RWLOCK_TIMEDOUT

Remarks

This works just like SDL_LockRWLockForReading(), but if the rwlock is not available, then this function returns SDL_RWLOCK_TIMEDOUT 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 does not fail; if rwlock is NULL, it will return 0 immediately having locked nothing. If rwlock is valid, this function will always either lock the rwlock and return 0, or return SDL_RWLOCK_TIMEOUT and lock nothing.

Version

This function is available since SDL 3.0.0.