The open source OpenXR runtime
m/ff: Add comments to C++ wrapper
+16
-1
+16
-1
src/xrt/auxiliary/math/m_filter_fifo.h
+16
-1
src/xrt/auxiliary/math/m_filter_fifo.h
···
119
119
}
120
120
121
121
/*!
122
-
* Helper class to wrap a C filter fifo.
122
+
* Helper class to wrap a C filter fifo (@ref m_ff_vec3_f32).
123
123
*/
124
124
class FilterFifo3F
125
125
{
···
149
149
return mFifoPtr;
150
150
}
151
151
152
+
/*!
153
+
* @copydoc m_ff_vec3_f32_push
154
+
*
155
+
* Wrapper for @ref m_ff_vec3_f32_push.
156
+
*/
152
157
inline void
153
158
push(const xrt_vec3 &sample, uint64_t timestamp_ns)
154
159
{
155
160
m_ff_vec3_f32_push(mFifoPtr, &sample, timestamp_ns);
156
161
}
157
162
163
+
/*!
164
+
* @copydoc m_ff_vec3_f32_get
165
+
*
166
+
* Wrapper for @ref m_ff_vec3_f32_get.
167
+
*/
158
168
inline bool
159
169
get(size_t num, xrt_vec3 *out_sample, uint64_t *out_timestamp_ns)
160
170
{
161
171
return m_ff_vec3_f32_get(mFifoPtr, num, out_sample, out_timestamp_ns);
162
172
}
163
173
174
+
/*!
175
+
* @copydoc m_ff_vec3_f32_filter
176
+
*
177
+
* Wrapper for @ref m_ff_vec3_f32_filter.
178
+
*/
164
179
inline size_t
165
180
filter(uint64_t start_ns, uint64_t stop_ns, struct xrt_vec3 *out_average)
166
181
{