sdl3_sys/metadata/generated/
init.rs

1//! Metadata for items in the `crate::init` module
2
3use super::*;
4
5pub const METADATA_SDL_PROP_APP_METADATA_NAME_STRING: Property = Property {
6    module: "init",
7    name: "SDL_PROP_APP_METADATA_NAME_STRING",
8    short_name: "APP_METADATA_NAME_STRING",
9    value: crate::init::SDL_PROP_APP_METADATA_NAME_STRING,
10    ty: PropertyType::STRING,
11    doc: None,
12    available_since: None,
13};
14pub const METADATA_SDL_PROP_APP_METADATA_VERSION_STRING: Property = Property {
15    module: "init",
16    name: "SDL_PROP_APP_METADATA_VERSION_STRING",
17    short_name: "APP_METADATA_VERSION_STRING",
18    value: crate::init::SDL_PROP_APP_METADATA_VERSION_STRING,
19    ty: PropertyType::STRING,
20    doc: None,
21    available_since: None,
22};
23pub const METADATA_SDL_PROP_APP_METADATA_IDENTIFIER_STRING: Property = Property {
24    module: "init",
25    name: "SDL_PROP_APP_METADATA_IDENTIFIER_STRING",
26    short_name: "APP_METADATA_IDENTIFIER_STRING",
27    value: crate::init::SDL_PROP_APP_METADATA_IDENTIFIER_STRING,
28    ty: PropertyType::STRING,
29    doc: None,
30    available_since: None,
31};
32pub const METADATA_SDL_PROP_APP_METADATA_CREATOR_STRING: Property = Property {
33    module: "init",
34    name: "SDL_PROP_APP_METADATA_CREATOR_STRING",
35    short_name: "APP_METADATA_CREATOR_STRING",
36    value: crate::init::SDL_PROP_APP_METADATA_CREATOR_STRING,
37    ty: PropertyType::STRING,
38    doc: None,
39    available_since: None,
40};
41pub const METADATA_SDL_PROP_APP_METADATA_COPYRIGHT_STRING: Property = Property {
42    module: "init",
43    name: "SDL_PROP_APP_METADATA_COPYRIGHT_STRING",
44    short_name: "APP_METADATA_COPYRIGHT_STRING",
45    value: crate::init::SDL_PROP_APP_METADATA_COPYRIGHT_STRING,
46    ty: PropertyType::STRING,
47    doc: None,
48    available_since: None,
49};
50pub const METADATA_SDL_PROP_APP_METADATA_URL_STRING: Property = Property {
51    module: "init",
52    name: "SDL_PROP_APP_METADATA_URL_STRING",
53    short_name: "APP_METADATA_URL_STRING",
54    value: crate::init::SDL_PROP_APP_METADATA_URL_STRING,
55    ty: PropertyType::STRING,
56    doc: None,
57    available_since: None,
58};
59pub const METADATA_SDL_PROP_APP_METADATA_TYPE_STRING: Property = Property {
60    module: "init",
61    name: "SDL_PROP_APP_METADATA_TYPE_STRING",
62    short_name: "APP_METADATA_TYPE_STRING",
63    value: crate::init::SDL_PROP_APP_METADATA_TYPE_STRING,
64    ty: PropertyType::STRING,
65    doc: None,
66    available_since: None,
67};
68pub const METADATA_SDL_InitFlags: Group = Group {
69    module: "init",
70    kind: GroupKind::Flags,
71    name: "SDL_InitFlags",
72    short_name: "InitFlags",
73    doc: Some(
74        "Initialization flags for [`SDL_Init`] and/or [`SDL_InitSubSystem`]\n\nThese are the flags which may be passed to [`SDL_Init()`]. You should specify\nthe subsystems which you will be using in your application.\n\n## Availability\nThis datatype is available since SDL 3.2.0.\n\n## See also\n- [`SDL_Init`]\n- [`SDL_Quit`]\n- [`SDL_InitSubSystem`]\n- [`SDL_QuitSubSystem`]\n- [`SDL_WasInit`]\n",
75    ),
76    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
77    values: &[
78        GroupValue {
79            name: "SDL_INIT_AUDIO",
80            short_name: "AUDIO",
81            doc: Some("[`SDL_INIT_AUDIO`] implies [`SDL_INIT_EVENTS`]\n"),
82            available_since: None,
83        },
84        GroupValue {
85            name: "SDL_INIT_VIDEO",
86            short_name: "VIDEO",
87            doc: Some(
88                "[`SDL_INIT_VIDEO`] implies [`SDL_INIT_EVENTS`], should be initialized on the main thread\n",
89            ),
90            available_since: None,
91        },
92        GroupValue {
93            name: "SDL_INIT_JOYSTICK",
94            short_name: "JOYSTICK",
95            doc: Some("[`SDL_INIT_JOYSTICK`] implies [`SDL_INIT_EVENTS`]\n"),
96            available_since: None,
97        },
98        GroupValue {
99            name: "SDL_INIT_HAPTIC",
100            short_name: "HAPTIC",
101            doc: None,
102            available_since: None,
103        },
104        GroupValue {
105            name: "SDL_INIT_GAMEPAD",
106            short_name: "GAMEPAD",
107            doc: Some("[`SDL_INIT_GAMEPAD`] implies [`SDL_INIT_JOYSTICK`]\n"),
108            available_since: None,
109        },
110        GroupValue {
111            name: "SDL_INIT_EVENTS",
112            short_name: "EVENTS",
113            doc: None,
114            available_since: None,
115        },
116        GroupValue {
117            name: "SDL_INIT_SENSOR",
118            short_name: "SENSOR",
119            doc: Some("[`SDL_INIT_SENSOR`] implies [`SDL_INIT_EVENTS`]\n"),
120            available_since: None,
121        },
122        GroupValue {
123            name: "SDL_INIT_CAMERA",
124            short_name: "CAMERA",
125            doc: Some("[`SDL_INIT_CAMERA`] implies [`SDL_INIT_EVENTS`]\n"),
126            available_since: None,
127        },
128    ],
129};
130pub const METADATA_SDL_AppResult: Group = Group {
131    module: "init",
132    kind: GroupKind::Enum,
133    name: "SDL_AppResult",
134    short_name: "AppResult",
135    doc: Some(
136        "Return values for optional main callbacks.\n\nReturning [`SDL_APP_SUCCESS`] or [`SDL_APP_FAILURE`] from [`SDL_AppInit`],\n[`SDL_AppEvent`], or [`SDL_AppIterate`] will terminate the program and report\nsuccess/failure to the operating system. What that means is\nplatform-dependent. On Unix, for example, on success, the process error\ncode will be zero, and on failure it will be 1. This interface doesn't\nallow you to return specific exit codes, just whether there was an error\ngenerally or not.\n\nReturning [`SDL_APP_CONTINUE`] from these functions will let the app continue\nto run.\n\nSee\n[Main callbacks in SDL3](https://wiki.libsdl.org/SDL3/README-main-functions#main-callbacks-in-sdl3)\nfor complete details.\n\n## Availability\nThis enum is available since SDL 3.2.0.\n",
137    ),
138    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
139    values: &[
140        GroupValue {
141            name: "SDL_APP_CONTINUE",
142            short_name: "CONTINUE",
143            doc: Some("Value that requests that the app continue from the main callbacks.\n"),
144            available_since: None,
145        },
146        GroupValue {
147            name: "SDL_APP_SUCCESS",
148            short_name: "SUCCESS",
149            doc: Some("Value that requests termination with success from the main callbacks.\n"),
150            available_since: None,
151        },
152        GroupValue {
153            name: "SDL_APP_FAILURE",
154            short_name: "FAILURE",
155            doc: Some("Value that requests termination with error from the main callbacks.\n"),
156            available_since: None,
157        },
158    ],
159};