SDL_TryLockRWLockForReading(3)

SDL_TryLockRWLockForReading3

Try to lock a read/write lock _for reading_ without blocking.

Usage

#include "SDL3/SDL.h"

bool SDL_TryLockRWLockForReading(SDL_RWLock *rwlock);

Header file

Defined in SDL3/SDL_mutex.h

Overview

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.

Function parameters

rwlock

the rwlock to try to lock.

Return value

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

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.