Struct SDL_AtomicU32

#[repr(C)]
pub struct SDL_AtomicU32 {
    pub value: u32,
}

Available on crate feature dep_sdl3 only.

A type representing an atomic unsigned 32-bit value.

This can be used to manage a value that is synchronized across multiple CPUs without a race condition; when an app sets a value with SDL_SetAtomicU32 all other threads, regardless of the CPU it is running on, will see that value when retrieved with SDL_GetAtomicU32, regardless of CPU caches, etc.

This is also useful for atomic compare-and-swap operations: a thread can change the value as long as its current value matches expectations. When done in a loop, one can guarantee data consistency across threads without a lock (but the usual warnings apply: if you don’t know what you’re doing, or you don’t do it carefully, you can confidently cause any number of disasters with this, so in most cases, you should use a mutex instead of this!).

This is a struct so people don’t accidentally use numeric operations on it directly. You have to use SDL atomic functions.

Availability

This struct is available since SDL 3.2.0.

See also

• SDL_CompareAndSwapAtomicU32
• SDL_GetAtomicU32
• SDL_SetAtomicU32

Fields

value: u32

Trait Implementations

impl Default for SDL_AtomicU32

fn default() -> SDL_AtomicU32

Returns the “default value” for a type.