SDL_TryLockSpinlock(3)

SDL_TryLockSpinlock3

Try to lock a spin lock by setting it to a non-zero value.

Usage

#include "SDL3/SDL.h"

bool SDL_TryLockSpinlock(SDL_SpinLock *lock);

Header file

Defined in SDL3/SDL_atomic.h

Overview

Please note that spinlocks are dangerous if you don't know what you're doing. Please be careful using any sort of spinlock!

Function parameters

lock

a pointer to a lock variable.

Return value

Returns true if the lock succeeded, false if the lock is already held.

Thread safety

It is safe to call this function from any thread.

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.