matrixfurry.com
The open source OpenXR runtime
c/util: Documentation
+7
src/xrt/compositor/main/comp_documentation.h
+7
src/xrt/compositor/main/comp_documentation.h
+1
-1
src/xrt/compositor/util/comp_swapchain.c
+1
-1
src/xrt/compositor/util/comp_swapchain.c
+10
-7
src/xrt/compositor/util/comp_swapchain.h
+10
-7
src/xrt/compositor/util/comp_swapchain.h
···
5
5
* @brief Independent swapchain implementation.
6
6
* @author Jakob Bornecrantz <jakob@collabora.com>
7
7
* @author Lubosz Sarnecki <lubosz.sarnecki@collabora.com>
8
-
* @ingroup comp_main
8
+
* @ingroup comp_util
9
9
*/
10
10
11
11
#pragma once
···
23
23
24
24
/*!
25
25
* A garbage collector that collects swapchains to be safely destroyed.
26
+
*
27
+
* @ingroup comp_util
26
28
*/
27
29
struct comp_swapchain_gc
28
30
{
···
33
35
/*!
34
36
* A single swapchain image, holds the needed state for tracking image usage.
35
37
*
36
-
* @ingroup comp_main
38
+
* @ingroup comp_util
37
39
* @see comp_swapchain
38
40
*/
39
41
struct comp_swapchain_image
···
60
62
* sure that compositor lives for as long as the swapchain does and that all
61
63
* swapchains are destroyed before the compositor is destroyed.
62
64
*
63
-
* @ingroup comp_main
65
+
* @ingroup comp_util
64
66
* @implements xrt_swapchain_native
65
67
* @see comp_compositor
66
68
*/
···
91
93
/*!
92
94
* Convenience function to convert a xrt_swapchain to a comp_swapchain.
93
95
*
96
+
* @ingroup comp_util
94
97
* @private @memberof comp_swapchain
95
98
*/
96
99
static inline struct comp_swapchain *
···
110
113
* Do garbage collection, destroying any resources that has been scheduled for
111
114
* destruction from other threads.
112
115
*
113
-
* @public @memberof comp_compositor
116
+
* @ingroup comp_util
114
117
*/
115
118
void
116
119
comp_swapchain_garbage_collect(struct comp_swapchain_gc *cscgc);
···
118
121
/*!
119
122
* A compositor function that is implemented in the swapchain code.
120
123
*
121
-
* @public @memberof comp_compositor
124
+
* @ingroup comp_util
122
125
*/
123
126
xrt_result_t
124
127
comp_swapchain_create(struct vk_bundle *vk,
···
129
132
/*!
130
133
* A compositor function that is implemented in the swapchain code.
131
134
*
132
-
* @public @memberof comp_compositor
135
+
* @ingroup comp_util
133
136
*/
134
137
xrt_result_t
135
138
comp_swapchain_import(struct vk_bundle *vk,
···
144
147
* does the actual destruction and is called from @ref
145
148
* comp_swapchain_garbage_collect.
146
149
*
147
-
* @private @memberof comp_swapchain
150
+
* @ingroup comp_util
148
151
*/
149
152
void
150
153
comp_swapchain_really_destroy(struct comp_swapchain *sc);
+1
-1
src/xrt/compositor/util/comp_sync.c
+1
-1
src/xrt/compositor/util/comp_sync.c
+3
-1
src/xrt/compositor/util/comp_sync.h
+3
-1
src/xrt/compositor/util/comp_sync.h
···
4
4
* @file
5
5
* @brief Independent @ref xrt_compositor_fence implementation.
6
6
* @author Jakob Bornecrantz <jakob@collabora.com>
7
-
* @ingroup comp_main
7
+
* @ingroup comp_util
8
8
*/
9
9
10
10
#pragma once
···
25
25
* The vk_bundle is owned by the compositor, its the state trackers job to make
26
26
* sure that compositor lives for as long as the fence does and that all fences
27
27
* are destroyed before the compositor is destroyed.
28
+
*
29
+
* @ingroup comp_util
28
30
*/
29
31
xrt_result_t
30
32
comp_fence_import(struct vk_bundle *vk, xrt_graphics_sync_handle_t handle, struct xrt_compositor_fence **out_xcf);