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

SDL_TryLockSpinlock

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

Header File

Defined in <SDL3/SDL_atomic.h>

Syntax

bool SDL_TryLockSpinlock(SDL_SpinLock *lock);

Function Parameters

SDL_SpinLock *

lock

a pointer to a lock variable.

Return Value

(bool) Returns true if the lock succeeded, 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!

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_LockSpinlock
• SDL_UnlockSpinlock

---

CategoryAPI, CategoryAPIFunction, CategoryAtomic

[ 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.