sdl3_sys/metadata/generated/
atomic.rs

1//! Metadata for items in the `crate::atomic` module
2
3use super::*;
4
5pub const METADATA_SDL_SpinLock: Group = Group {
6    module: "atomic",
7    kind: GroupKind::Lock,
8    name: "SDL_SpinLock",
9    short_name: "SpinLock",
10    doc: Some(
11        "An atomic spinlock.\n\nThe atomic locks are efficient spinlocks using CPU instructions, but are\nvulnerable to starvation and can spin forever if a thread holding a lock\nhas been terminated. For this reason you should minimize the code executed\ninside an atomic lock and never do expensive things like API or system\ncalls while holding them.\n\nThey are also vulnerable to starvation if the thread holding the lock is\nlower priority than other threads and doesn't get scheduled. In general you\nshould use mutexes instead, since they have better performance and\ncontention behavior.\n\nThe atomic locks are not safe to lock recursively.\n\nPorting Note: The spin lock functions and type are required and can not be\nemulated because they are used in the atomic emulation code.\n",
12    ),
13    available_since: None,
14    values: &[],
15};