sdl3_sys/metadata/generated/
thread.rs

1//! Metadata for items in the `crate::thread` module
2
3use super::*;
4
5pub const METADATA_SDL_PROP_THREAD_CREATE_ENTRY_FUNCTION_POINTER: Property = Property {
6    module: "thread",
7    name: "SDL_PROP_THREAD_CREATE_ENTRY_FUNCTION_POINTER",
8    short_name: "THREAD_CREATE_ENTRY_FUNCTION_POINTER",
9    value: crate::thread::SDL_PROP_THREAD_CREATE_ENTRY_FUNCTION_POINTER,
10    ty: PropertyType::POINTER,
11    doc: None,
12    available_since: None,
13};
14pub const METADATA_SDL_PROP_THREAD_CREATE_NAME_STRING: Property = Property {
15    module: "thread",
16    name: "SDL_PROP_THREAD_CREATE_NAME_STRING",
17    short_name: "THREAD_CREATE_NAME_STRING",
18    value: crate::thread::SDL_PROP_THREAD_CREATE_NAME_STRING,
19    ty: PropertyType::STRING,
20    doc: None,
21    available_since: None,
22};
23pub const METADATA_SDL_PROP_THREAD_CREATE_USERDATA_POINTER: Property = Property {
24    module: "thread",
25    name: "SDL_PROP_THREAD_CREATE_USERDATA_POINTER",
26    short_name: "THREAD_CREATE_USERDATA_POINTER",
27    value: crate::thread::SDL_PROP_THREAD_CREATE_USERDATA_POINTER,
28    ty: PropertyType::POINTER,
29    doc: None,
30    available_since: None,
31};
32pub const METADATA_SDL_PROP_THREAD_CREATE_STACKSIZE_NUMBER: Property = Property {
33    module: "thread",
34    name: "SDL_PROP_THREAD_CREATE_STACKSIZE_NUMBER",
35    short_name: "THREAD_CREATE_STACKSIZE_NUMBER",
36    value: crate::thread::SDL_PROP_THREAD_CREATE_STACKSIZE_NUMBER,
37    ty: PropertyType::NUMBER,
38    doc: None,
39    available_since: None,
40};
41pub const METADATA_SDL_ThreadID: Group = Group {
42    module: "thread",
43    kind: GroupKind::Id,
44    name: "SDL_ThreadID",
45    short_name: "ThreadID",
46    doc: Some(
47        "A unique numeric ID that identifies a thread.\n\nThese are different from [`SDL_Thread`] objects, which are generally what an\napplication will operate on, but having a way to uniquely identify a thread\ncan be useful at times.\n\n## Availability\nThis datatype is available since SDL 3.2.0.\n\n## See also\n- [`SDL_GetThreadID`]\n- [`SDL_GetCurrentThreadID`]\n",
48    ),
49    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
50    values: &[],
51};
52pub const METADATA_SDL_TLSID: Group = Group {
53    module: "thread",
54    kind: GroupKind::Id,
55    name: "SDL_TLSID",
56    short_name: "TLSID",
57    doc: Some(
58        "Thread local storage ID.\n\n0 is the invalid ID. An app can create these and then set data for these\nIDs that is unique to each thread.\n\n## Availability\nThis datatype is available since SDL 3.2.0.\n\n## See also\n- [`SDL_GetTLS`]\n- [`SDL_SetTLS`]\n",
59    ),
60    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
61    values: &[],
62};
63pub const METADATA_SDL_ThreadPriority: Group = Group {
64    module: "thread",
65    kind: GroupKind::Enum,
66    name: "SDL_ThreadPriority",
67    short_name: "ThreadPriority",
68    doc: Some(
69        "The SDL thread priority.\n\nSDL will make system changes as necessary in order to apply the thread\npriority. Code which attempts to control thread state related to priority\nshould be aware that calling [`SDL_SetCurrentThreadPriority`] may alter such\nstate. [`SDL_HINT_THREAD_PRIORITY_POLICY`] can be used to control aspects of\nthis behavior.\n\n## Availability\nThis enum is available since SDL 3.2.0.\n",
70    ),
71    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
72    values: &[
73        GroupValue {
74            name: "SDL_THREAD_PRIORITY_LOW",
75            short_name: "LOW",
76            doc: None,
77            available_since: None,
78        },
79        GroupValue {
80            name: "SDL_THREAD_PRIORITY_NORMAL",
81            short_name: "NORMAL",
82            doc: None,
83            available_since: None,
84        },
85        GroupValue {
86            name: "SDL_THREAD_PRIORITY_HIGH",
87            short_name: "HIGH",
88            doc: None,
89            available_since: None,
90        },
91        GroupValue {
92            name: "SDL_THREAD_PRIORITY_TIME_CRITICAL",
93            short_name: "TIME_CRITICAL",
94            doc: None,
95            available_since: None,
96        },
97    ],
98};
99pub const METADATA_SDL_ThreadState: Group = Group {
100    module: "thread",
101    kind: GroupKind::Enum,
102    name: "SDL_ThreadState",
103    short_name: "ThreadState",
104    doc: Some(
105        "The SDL thread state.\n\nThe current state of a thread can be checked by calling [`SDL_GetThreadState`].\n\n## Availability\nThis enum is available since SDL 3.2.0.\n\n## See also\n- [`SDL_GetThreadState`]\n",
106    ),
107    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
108    values: &[
109        GroupValue {
110            name: "SDL_THREAD_UNKNOWN",
111            short_name: "UNKNOWN",
112            doc: Some("The thread is not valid\n"),
113            available_since: None,
114        },
115        GroupValue {
116            name: "SDL_THREAD_ALIVE",
117            short_name: "ALIVE",
118            doc: Some("The thread is currently running\n"),
119            available_since: None,
120        },
121        GroupValue {
122            name: "SDL_THREAD_DETACHED",
123            short_name: "DETACHED",
124            doc: Some("The thread is detached and can't be waited on\n"),
125            available_since: None,
126        },
127        GroupValue {
128            name: "SDL_THREAD_COMPLETE",
129            short_name: "COMPLETE",
130            doc: Some(
131                "The thread has finished and should be cleaned up with [`SDL_WaitThread()`]\n",
132            ),
133            available_since: None,
134        },
135    ],
136};
sdl3_sys/metadata/generated/thread.rs

sdl3_sys/metadata/generated/
thread.rs
