The open source OpenXR runtime
c/util: comp_scratch doc improvements
Part-of: <https://gitlab.freedesktop.org/monado/monado/-/merge_requests/2220>
authored by
Rylie Pavlik
and committed by
Simon Zeni
342fab6b
1e047b5b
+16
+16
src/xrt/compositor/util/comp_scratch.h
+16
src/xrt/compositor/util/comp_scratch.h
···
91
91
* not enough as it has a mutex in it and has native handles which on some
92
92
* platforms zero is a valid handle.
93
93
*
94
+
* @public @memberof comp_scratch_single_images
95
+
*
94
96
* @ingroup comp_util
95
97
*/
96
98
void
···
98
100
99
101
/*!
100
102
* Ensure that the scratch images are allocated and match @p extent size.
103
+
*
104
+
* @public @memberof comp_scratch_single_images
101
105
*
102
106
* @ingroup comp_util
103
107
*/
···
108
112
* Free all images allocated, @p init must be called before calling this
109
113
* function, is safe to call without any image allocated.
110
114
*
115
+
* @public @memberof comp_scratch_single_images
116
+
*
111
117
* @ingroup comp_util
112
118
*/
113
119
void
···
116
122
/*!
117
123
* Get the next free image, after this function has been called you must call
118
124
* either @p done or @p discard before calling any other function.
125
+
*
126
+
* @public @memberof comp_scratch_single_images
119
127
*
120
128
* @ingroup comp_util
121
129
*/
···
127
135
* signal that you are done with this function, the GPU work needs to be fully
128
136
* completed before calling done.
129
137
*
138
+
* @public @memberof comp_scratch_single_images
139
+
*
130
140
* @ingroup comp_util
131
141
*/
132
142
void
···
135
145
/*!
136
146
* Discard a @g get call, this clears the image debug part causing no image to
137
147
* be shown in the debug UI.
148
+
*
149
+
* @public @memberof comp_scratch_single_images
138
150
*
139
151
* @ingroup comp_util
140
152
*/
···
144
156
/*!
145
157
* Clears the debug output, this causes nothing to be shown in the debug UI.
146
158
*
159
+
* @public @memberof comp_scratch_single_images
160
+
*
147
161
* @ingroup comp_util
148
162
*/
149
163
void
···
153
167
* Destroys scratch image struct, if any images has been allocated must call
154
168
* @p free before as this function only destroys the mutex, and the @p unid must
155
169
* no longer be tracked.
170
+
*
171
+
* @public @memberof comp_scratch_single_images
156
172
*
157
173
* @ingroup comp_util
158
174
*/