matrixfurry.com
The open source OpenXR runtime
c/util: Improve docs for comp_base
+8
-1
src/xrt/compositor/util/comp_base.h
+8
-1
src/xrt/compositor/util/comp_base.h
···
88
88
* * @ref xrt_compositor::poll_events
89
89
* * @ref xrt_compositor::destroy
90
90
*
91
+
* Partially implements @ref xrt_compositor_native, meant to serve as
92
+
* the base of a main compositor implementation.
93
+
*
94
+
* @implements xrt_compositor_native
91
95
* @ingroup comp_util
92
-
* @see comp_base
93
96
*/
94
97
struct comp_base
95
98
{
···
140
143
* The bundle needs to be initialised before any of the implemented functions
141
144
* are call, but is not required to be initialised before this function is
142
145
* called.
146
+
*
147
+
* @protected @memberof comp_base
143
148
*/
144
149
void
145
150
comp_base_init(struct comp_base *cb);
···
148
153
* De-initialises all structs, except @ref vk_bundle.
149
154
*
150
155
* The bundle needs to be de-initialised by the sub-class.
156
+
*
157
+
* @private @memberof comp_base
151
158
*/
152
159
void
153
160
comp_base_fini(struct comp_base *cb);