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

SDL_AtomicCompareAndSwapPointer

Set a pointer to a new value if it is currently an old value.

Header File

Defined in <SDL3/SDL_atomic.h>

Syntax

SDL_bool SDL_AtomicCompareAndSwapPointer(void **a, void *oldval, void *newval);

Function Parameters

a a pointer to a pointer
oldval the old pointer value
newval the new pointer value

Return Value

Returns SDL_TRUE if the pointer was set, SDL_FALSE otherwise.

Remarks

Note: If you don't know what this function is for, you shouldn't use it!

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryAtomic