sdl3_sys/metadata/generated/
process.rs

1//! Metadata for items in the `crate::process` module
2
3use super::*;
4
5pub const METADATA_SDL_PROP_PROCESS_CREATE_ARGS_POINTER: Property = Property {
6    module: "process",
7    name: "SDL_PROP_PROCESS_CREATE_ARGS_POINTER",
8    short_name: "PROCESS_CREATE_ARGS_POINTER",
9    value: crate::process::SDL_PROP_PROCESS_CREATE_ARGS_POINTER,
10    ty: PropertyType::POINTER,
11    doc: None,
12    available_since: None,
13};
14pub const METADATA_SDL_PROP_PROCESS_CREATE_ENVIRONMENT_POINTER: Property = Property {
15    module: "process",
16    name: "SDL_PROP_PROCESS_CREATE_ENVIRONMENT_POINTER",
17    short_name: "PROCESS_CREATE_ENVIRONMENT_POINTER",
18    value: crate::process::SDL_PROP_PROCESS_CREATE_ENVIRONMENT_POINTER,
19    ty: PropertyType::POINTER,
20    doc: None,
21    available_since: None,
22};
23pub const METADATA_SDL_PROP_PROCESS_CREATE_WORKING_DIRECTORY_STRING: Property = Property {
24    module: "process",
25    name: "SDL_PROP_PROCESS_CREATE_WORKING_DIRECTORY_STRING",
26    short_name: "PROCESS_CREATE_WORKING_DIRECTORY_STRING",
27    value: crate::process::SDL_PROP_PROCESS_CREATE_WORKING_DIRECTORY_STRING,
28    ty: PropertyType::STRING,
29    doc: None,
30    available_since: None,
31};
32pub const METADATA_SDL_PROP_PROCESS_CREATE_STDIN_NUMBER: Property = Property {
33    module: "process",
34    name: "SDL_PROP_PROCESS_CREATE_STDIN_NUMBER",
35    short_name: "PROCESS_CREATE_STDIN_NUMBER",
36    value: crate::process::SDL_PROP_PROCESS_CREATE_STDIN_NUMBER,
37    ty: PropertyType::NUMBER,
38    doc: None,
39    available_since: None,
40};
41pub const METADATA_SDL_PROP_PROCESS_CREATE_STDIN_POINTER: Property = Property {
42    module: "process",
43    name: "SDL_PROP_PROCESS_CREATE_STDIN_POINTER",
44    short_name: "PROCESS_CREATE_STDIN_POINTER",
45    value: crate::process::SDL_PROP_PROCESS_CREATE_STDIN_POINTER,
46    ty: PropertyType::POINTER,
47    doc: None,
48    available_since: None,
49};
50pub const METADATA_SDL_PROP_PROCESS_CREATE_STDOUT_NUMBER: Property = Property {
51    module: "process",
52    name: "SDL_PROP_PROCESS_CREATE_STDOUT_NUMBER",
53    short_name: "PROCESS_CREATE_STDOUT_NUMBER",
54    value: crate::process::SDL_PROP_PROCESS_CREATE_STDOUT_NUMBER,
55    ty: PropertyType::NUMBER,
56    doc: None,
57    available_since: None,
58};
59pub const METADATA_SDL_PROP_PROCESS_CREATE_STDOUT_POINTER: Property = Property {
60    module: "process",
61    name: "SDL_PROP_PROCESS_CREATE_STDOUT_POINTER",
62    short_name: "PROCESS_CREATE_STDOUT_POINTER",
63    value: crate::process::SDL_PROP_PROCESS_CREATE_STDOUT_POINTER,
64    ty: PropertyType::POINTER,
65    doc: None,
66    available_since: None,
67};
68pub const METADATA_SDL_PROP_PROCESS_CREATE_STDERR_NUMBER: Property = Property {
69    module: "process",
70    name: "SDL_PROP_PROCESS_CREATE_STDERR_NUMBER",
71    short_name: "PROCESS_CREATE_STDERR_NUMBER",
72    value: crate::process::SDL_PROP_PROCESS_CREATE_STDERR_NUMBER,
73    ty: PropertyType::NUMBER,
74    doc: None,
75    available_since: None,
76};
77pub const METADATA_SDL_PROP_PROCESS_CREATE_STDERR_POINTER: Property = Property {
78    module: "process",
79    name: "SDL_PROP_PROCESS_CREATE_STDERR_POINTER",
80    short_name: "PROCESS_CREATE_STDERR_POINTER",
81    value: crate::process::SDL_PROP_PROCESS_CREATE_STDERR_POINTER,
82    ty: PropertyType::POINTER,
83    doc: None,
84    available_since: None,
85};
86pub const METADATA_SDL_PROP_PROCESS_CREATE_STDERR_TO_STDOUT_BOOLEAN: Property = Property {
87    module: "process",
88    name: "SDL_PROP_PROCESS_CREATE_STDERR_TO_STDOUT_BOOLEAN",
89    short_name: "PROCESS_CREATE_STDERR_TO_STDOUT_BOOLEAN",
90    value: crate::process::SDL_PROP_PROCESS_CREATE_STDERR_TO_STDOUT_BOOLEAN,
91    ty: PropertyType::BOOLEAN,
92    doc: None,
93    available_since: None,
94};
95pub const METADATA_SDL_PROP_PROCESS_CREATE_BACKGROUND_BOOLEAN: Property = Property {
96    module: "process",
97    name: "SDL_PROP_PROCESS_CREATE_BACKGROUND_BOOLEAN",
98    short_name: "PROCESS_CREATE_BACKGROUND_BOOLEAN",
99    value: crate::process::SDL_PROP_PROCESS_CREATE_BACKGROUND_BOOLEAN,
100    ty: PropertyType::BOOLEAN,
101    doc: None,
102    available_since: None,
103};
104pub const METADATA_SDL_PROP_PROCESS_CREATE_CMDLINE_STRING: Property = Property {
105    module: "process",
106    name: "SDL_PROP_PROCESS_CREATE_CMDLINE_STRING",
107    short_name: "PROCESS_CREATE_CMDLINE_STRING",
108    value: crate::process::SDL_PROP_PROCESS_CREATE_CMDLINE_STRING,
109    ty: PropertyType::STRING,
110    doc: None,
111    available_since: None,
112};
113pub const METADATA_SDL_PROP_PROCESS_PID_NUMBER: Property = Property {
114    module: "process",
115    name: "SDL_PROP_PROCESS_PID_NUMBER",
116    short_name: "PROCESS_PID_NUMBER",
117    value: crate::process::SDL_PROP_PROCESS_PID_NUMBER,
118    ty: PropertyType::NUMBER,
119    doc: None,
120    available_since: None,
121};
122pub const METADATA_SDL_PROP_PROCESS_STDIN_POINTER: Property = Property {
123    module: "process",
124    name: "SDL_PROP_PROCESS_STDIN_POINTER",
125    short_name: "PROCESS_STDIN_POINTER",
126    value: crate::process::SDL_PROP_PROCESS_STDIN_POINTER,
127    ty: PropertyType::POINTER,
128    doc: None,
129    available_since: None,
130};
131pub const METADATA_SDL_PROP_PROCESS_STDOUT_POINTER: Property = Property {
132    module: "process",
133    name: "SDL_PROP_PROCESS_STDOUT_POINTER",
134    short_name: "PROCESS_STDOUT_POINTER",
135    value: crate::process::SDL_PROP_PROCESS_STDOUT_POINTER,
136    ty: PropertyType::POINTER,
137    doc: None,
138    available_since: None,
139};
140pub const METADATA_SDL_PROP_PROCESS_STDERR_POINTER: Property = Property {
141    module: "process",
142    name: "SDL_PROP_PROCESS_STDERR_POINTER",
143    short_name: "PROCESS_STDERR_POINTER",
144    value: crate::process::SDL_PROP_PROCESS_STDERR_POINTER,
145    ty: PropertyType::POINTER,
146    doc: None,
147    available_since: None,
148};
149pub const METADATA_SDL_PROP_PROCESS_BACKGROUND_BOOLEAN: Property = Property {
150    module: "process",
151    name: "SDL_PROP_PROCESS_BACKGROUND_BOOLEAN",
152    short_name: "PROCESS_BACKGROUND_BOOLEAN",
153    value: crate::process::SDL_PROP_PROCESS_BACKGROUND_BOOLEAN,
154    ty: PropertyType::BOOLEAN,
155    doc: None,
156    available_since: None,
157};
158pub const METADATA_SDL_ProcessIO: Group = Group {
159    module: "process",
160    kind: GroupKind::Enum,
161    name: "SDL_ProcessIO",
162    short_name: "ProcessIO",
163    doc: Some(
164        "Description of where standard I/O should be directed when creating a\nprocess.\n\nIf a standard I/O stream is set to [`SDL_PROCESS_STDIO_INHERITED`], it will go\nto the same place as the application's I/O stream. This is the default for\nstandard output and standard error.\n\nIf a standard I/O stream is set to [`SDL_PROCESS_STDIO_NULL`], it is connected\nto `NUL:` on Windows and `/dev/null` on POSIX systems. This is the default\nfor standard input.\n\nIf a standard I/O stream is set to [`SDL_PROCESS_STDIO_APP`], it is connected\nto a new [`SDL_IOStream`] that is available to the application. Standard input\nwill be available as [`SDL_PROP_PROCESS_STDIN_POINTER`] and allows\n[`SDL_GetProcessInput()`], standard output will be available as\n[`SDL_PROP_PROCESS_STDOUT_POINTER`] and allows [`SDL_ReadProcess()`] and\n[`SDL_GetProcessOutput()`], and standard error will be available as\n[`SDL_PROP_PROCESS_STDERR_POINTER`] in the properties for the created\nprocess.\n\nIf a standard I/O stream is set to [`SDL_PROCESS_STDIO_REDIRECT`], it is\nconnected to an existing [`SDL_IOStream`] provided by the application. Standard\ninput is provided using [`SDL_PROP_PROCESS_CREATE_STDIN_POINTER`], standard\noutput is provided using [`SDL_PROP_PROCESS_CREATE_STDOUT_POINTER`], and\nstandard error is provided using [`SDL_PROP_PROCESS_CREATE_STDERR_POINTER`]\nin the creation properties. These existing streams should be closed by the\napplication once the new process is created.\n\nIn order to use an [`SDL_IOStream`] with [`SDL_PROCESS_STDIO_REDIRECT`], it must\nhave [`SDL_PROP_IOSTREAM_WINDOWS_HANDLE_POINTER`] or\n[`SDL_PROP_IOSTREAM_FILE_DESCRIPTOR_NUMBER`] set. This is true for streams\nrepresenting files and process I/O.\n\n## Availability\nThis enum is available since SDL 3.2.0.\n\n## See also\n- [`SDL_CreateProcessWithProperties`]\n- [`SDL_GetProcessProperties`]\n- [`SDL_ReadProcess`]\n- [`SDL_GetProcessInput`]\n- [`SDL_GetProcessOutput`]\n",
165    ),
166    available_since: Some(SDL_VERSIONNUM(3, 2, 0)),
167    values: &[
168        GroupValue {
169            name: "SDL_PROCESS_STDIO_INHERITED",
170            short_name: "INHERITED",
171            doc: Some("The I/O stream is inherited from the application.\n"),
172            available_since: None,
173        },
174        GroupValue {
175            name: "SDL_PROCESS_STDIO_NULL",
176            short_name: "NULL",
177            doc: Some("The I/O stream is ignored.\n"),
178            available_since: None,
179        },
180        GroupValue {
181            name: "SDL_PROCESS_STDIO_APP",
182            short_name: "APP",
183            doc: Some(
184                "The I/O stream is connected to a new [`SDL_IOStream`] that the application can read or write\n",
185            ),
186            available_since: None,
187        },
188        GroupValue {
189            name: "SDL_PROCESS_STDIO_REDIRECT",
190            short_name: "REDIRECT",
191            doc: Some("The I/O stream is redirected to an existing [`SDL_IOStream`].\n"),
192            available_since: None,
193        },
194    ],
195};