The open source OpenXR runtime
st/gui: Improve doxygen
Part-of: <https://gitlab.freedesktop.org/monado/monado/-/merge_requests/2322>
+32
-19
+32
-19
src/xrt/state_trackers/gui/gui_common.h
+32
-19
src/xrt/state_trackers/gui/gui_common.h
···
1
-
// Copyright 2019-2023, Collabora, Ltd.
1
+
// Copyright 2019-2024, Collabora, Ltd.
2
2
// SPDX-License-Identifier: BSL-1.0
3
3
/*!
4
4
* @file
···
60
60
* @interface gui_scene
61
61
* A single currently running scene.
62
62
*
63
+
* @see gui_program
63
64
* @ingroup gui
64
65
*/
65
66
struct gui_scene
···
71
72
/*!
72
73
* A OpenGL texture.
73
74
*
75
+
* @see gui_program
74
76
* @ingroup gui
75
77
*/
76
78
struct gui_ogl_texture
···
84
86
};
85
87
86
88
/*!
89
+
* @addtogroup gui
90
+
* @{
91
+
*/
92
+
93
+
/*!
87
94
* Initialize the prober and open all devices found.
88
95
*
89
-
* @ingroup gui
96
+
* @public @memberof gui_program
90
97
*/
91
98
int
92
99
gui_prober_init(struct gui_program *p);
···
94
101
/*!
95
102
* Create devices.
96
103
*
97
-
* @ingroup gui
104
+
* @public @memberof gui_program
98
105
*/
99
106
int
100
107
gui_prober_select(struct gui_program *p);
···
102
109
/*!
103
110
* Update all devices.
104
111
*
105
-
* @ingroup gui
112
+
* @public @memberof gui_program
106
113
*/
107
114
void
108
115
gui_prober_update(struct gui_program *p);
···
110
117
/*!
111
118
* Destroy all opened devices and destroy the prober.
112
119
*
113
-
* @ingroup gui
120
+
* @public @memberof gui_program
114
121
*/
115
122
void
116
123
gui_prober_teardown(struct gui_program *p);
···
121
128
*
122
129
* Destruction is handled by the frame context.
123
130
*
131
+
* @public @memberof gui_ogl_texture
124
132
* @ingroup gui
125
133
*/
126
134
struct gui_ogl_texture *
···
129
137
/*!
130
138
* Update the texture to the latest received frame.
131
139
*
140
+
* @public @memberof gui_ogl_texture
132
141
* @ingroup gui
133
142
*/
134
143
void
···
137
146
/*!
138
147
* Push the scene to the top of the lists.
139
148
*
140
-
* @ingroup gui
149
+
* @public @memberof gui_program
141
150
*/
142
151
void
143
152
gui_scene_push_front(struct gui_program *p, struct gui_scene *me);
···
145
154
/*!
146
155
* Put a scene on the delete list, also removes it from any other list.
147
156
*
148
-
* @ingroup gui
157
+
* @public @memberof gui_program
149
158
*/
150
159
void
151
160
gui_scene_delete_me(struct gui_program *p, struct gui_scene *me);
···
153
162
/*!
154
163
* Render the scenes.
155
164
*
156
-
* @ingroup gui
165
+
* @public @memberof gui_program
157
166
*/
158
167
void
159
168
gui_scene_manager_render(struct gui_program *p);
···
161
170
/*!
162
171
* Initialize the scene manager.
163
172
*
164
-
* @ingroup gui
173
+
* @public @memberof gui_program
165
174
*/
166
175
void
167
176
gui_scene_manager_init(struct gui_program *p);
···
169
178
/*!
170
179
* Destroy the scene manager.
171
180
*
172
-
* @ingroup gui
181
+
* @public @memberof gui_program
173
182
*/
174
183
void
175
184
gui_scene_manager_destroy(struct gui_program *p);
···
184
193
/*!
185
194
* Shows the main menu.
186
195
*
187
-
* @ingroup gui
196
+
* @public @memberof gui_program
188
197
*/
189
198
void
190
199
gui_scene_main_menu(struct gui_program *p);
···
192
201
/*!
193
202
* Shows a UI that lets you select a video device and mode for calibration.
194
203
*
195
-
* @ingroup gui
204
+
* @public @memberof gui_program
196
205
*/
197
206
void
198
207
gui_scene_select_video_calibrate(struct gui_program *p);
···
200
209
/*!
201
210
* Shows a UI that lets you set up tracking overrides.
202
211
*
203
-
* @ingroup gui
212
+
* @public @memberof gui_program
204
213
*/
205
214
void
206
215
gui_scene_tracking_overrides(struct gui_program *p);
···
208
217
/*!
209
218
* Regular debug UI.
210
219
*
211
-
* @ingroup gui
220
+
* @public @memberof gui_program
212
221
*/
213
222
void
214
223
gui_scene_debug(struct gui_program *p);
···
216
225
/*!
217
226
* Small hand-tracking demo.
218
227
*
219
-
* @ingroup gui
228
+
* @public @memberof gui_program
220
229
*/
221
230
void
222
231
gui_scene_hand_tracking_demo(struct gui_program *p);
···
224
233
/*!
225
234
* EuRoC recorder for DepthAI cameras
226
235
*
227
-
* @ingroup gui
236
+
* @public @memberof gui_program
228
237
*/
229
238
void
230
239
gui_scene_record_euroc(struct gui_program *p);
···
232
241
/*!
233
242
* Create a recording view scene.
234
243
*
235
-
* @ingroup gui
244
+
* @public @memberof gui_program
236
245
*/
237
246
void
238
247
gui_scene_record(struct gui_program *p, const char *camera);
···
242
251
*
243
252
* @param p self
244
253
* @param address Optional address.
245
-
* @ingroup gui
254
+
*
255
+
* @public @memberof gui_program
246
256
*/
247
257
void
248
258
gui_scene_remote(struct gui_program *p, const char *address);
···
251
261
* Given the frameserver runs the calibration code on it.
252
262
* Claims ownership of @p s.
253
263
*
254
-
* @ingroup gui
264
+
* @public @memberof gui_program
255
265
*/
256
266
void
257
267
gui_scene_calibrate(struct gui_program *p,
···
259
269
struct xrt_fs *xfs,
260
270
struct xrt_settings_tracking *s);
261
271
272
+
/*!
273
+
* @}
274
+
*/
262
275
263
276
#ifdef __cplusplus
264
277
}