(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_AtomicTryLock

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

Header File

Defined in SDL_atomic.h

Syntax

SDL_bool SDL_AtomicTryLock(SDL_SpinLock *lock);

Function Parameters

Return Value

Returns SDL_TRUE if the lock succeeded, SDL_FALSE if the lock is already held.

Remarks

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

Version

This function is available since SDL 2.0.0.

See Also

• SDL_AtomicLock
• SDL_AtomicUnlock

CategoryAPI, CategoryAPIFunction, CategoryAtomic