The open source OpenXR runtime

a/vive: Add common header with documentation [NFC]

+62 -25
+1 -1
src/xrt/auxiliary/vive/vive_bindings.c
··· 5 5 * @brief Shared bindings structs for @ref drv_vive & @ref drv_survive. 6 6 * @author Christoph Haag <christoph.haag@collabora.com> 7 7 * @author Jakob Bornecrantz <jakob@collabora.com> 8 - * @ingroup drv_vive 8 + * @ingroup aux_vive 9 9 */ 10 10 11 11 #include "vive/vive_bindings.h"
+1 -1
src/xrt/auxiliary/vive/vive_bindings.h
··· 5 5 * @brief Shared bindings structs for @ref drv_vive & @ref drv_survive. 6 6 * @author Christoph Haag <christoph.haag@collabora.com> 7 7 * @author Jakob Bornecrantz <jakob@collabora.com> 8 - * @ingroup drv_vive 8 + * @ingroup aux_vive 9 9 */ 10 10 11 11 #pragma once
+1 -1
src/xrt/auxiliary/vive/vive_calibration.c
··· 5 5 * @brief Vive calibration getters. 6 6 * @author Mateo de Mayo <mateo.demayo@collabora.com> 7 7 * @author Moses Turner <moses@collabora.com> 8 - * @ingroup drv_vive 8 + * @ingroup aux_vive 9 9 */ 10 10 11 11 #include "math/m_api.h"
+5 -5
src/xrt/auxiliary/vive/vive_calibration.h
··· 5 5 * @brief Vive calibration getters. 6 6 * @author Mateo de Mayo <mateo.demayo@collabora.com> 7 7 * @author Moses Turner <moses@collabora.com> 8 - * @ingroup drv_vive 8 + * @ingroup aux_vive 9 9 */ 10 10 11 11 #pragma once ··· 24 24 /*! 25 25 * Get a @ref t_stereo_camera_calibration and @ref xrt_pose from left camera to head translation. 26 26 * 27 - * @ingroup drv_vive 27 + * @ingroup aux_vive 28 28 */ 29 29 bool 30 30 vive_get_stereo_camera_calibration(const struct vive_config *d, ··· 34 34 /*! 35 35 * Get a @ref t_slam_camera_calibration one for each camera. 36 36 * 37 - * @ingroup drv_vive 37 + * @ingroup aux_vive 38 38 */ 39 39 void 40 40 vive_get_slam_cams_calib(const struct vive_config *d, ··· 44 44 /*! 45 45 * Get a @ref t_imu_calibration for the IMU. 46 46 * 47 - * @ingroup drv_vive 47 + * @ingroup aux_vive 48 48 */ 49 49 void 50 50 vive_get_imu_calibration(const struct vive_config *d, struct t_imu_calibration *out_calib); ··· 52 52 /*! 53 53 * Get a @ref t_slam_imu_calibration for the IMU. 54 54 * 55 - * @ingroup drv_vive 55 + * @ingroup aux_vive 56 56 */ 57 57 void 58 58 vive_get_slam_imu_calibration(const struct vive_config *d, struct t_slam_imu_calibration *out_calib);
+37
src/xrt/auxiliary/vive/vive_common.h
··· 1 + // Copyright 2020-2023, Collabora, Ltd. 2 + // SPDX-License-Identifier: BSL-1.0 3 + /*! 4 + * @file 5 + * @brief Common things like defines for Vive and Index. 6 + * @author Jakob Bornecrantz <jakob@collabora.com> 7 + * @ingroup aux_vive 8 + */ 9 + 10 + #pragma once 11 + 12 + #include "xrt/xrt_compiler.h" 13 + 14 + 15 + #ifdef __cplusplus 16 + extern "C" { 17 + #endif 18 + 19 + 20 + /*! 21 + * @defgroup aux_vive Shared code for @ref drv_vive and @ref drv_survive. 22 + * @ingroup aux 23 + * 24 + * @brief Shared functionality for @ref drv_vive and @ref drv_survive drivers 25 + * that supports the HTC Vive and Valve Index family of HMDs. 26 + */ 27 + 28 + /*! 29 + * @dir auxiliary/vive 30 + * 31 + * @brief @ref aux_vive files. 32 + */ 33 + 34 + 35 + #ifdef __cplusplus 36 + } 37 + #endif
+1 -1
src/xrt/auxiliary/vive/vive_config.c
··· 5 5 * @brief Vive json implementation 6 6 * @author Lubosz Sarnecki <lubosz.sarnecki@collabora.com> 7 7 * @author Moses Turner <moses@collabora.com> 8 - * @ingroup drv_vive 8 + * @ingroup aux_vive 9 9 */ 10 10 11 11 #include "math/m_api.h"
+11 -11
src/xrt/auxiliary/vive/vive_config.h
··· 5 5 * @brief vive json header 6 6 * @author Lubosz Sarnecki <lubosz.sarnecki@collabora.com> 7 7 * @author Moses Turner <moses@collabora.com> 8 - * @ingroup drv_vive 8 + * @ingroup aux_vive 9 9 */ 10 10 11 11 #pragma once ··· 41 41 /*! 42 42 * Headset variant. 43 43 * 44 - * @ingroup drv_vive 44 + * @ingroup aux_vive 45 45 */ 46 46 enum VIVE_VARIANT 47 47 { ··· 54 54 /*! 55 55 * Controller variant. 56 56 * 57 - * @ingroup drv_vive 57 + * @ingroup aux_vive 58 58 */ 59 59 enum VIVE_CONTROLLER_VARIANT 60 60 { ··· 69 69 /*! 70 70 * A calibrated camera on an Index. 71 71 * 72 - * @ingroup drv_vive 72 + * @ingroup aux_vive 73 73 */ 74 74 struct index_camera 75 75 { ··· 108 108 /*! 109 109 * A single lighthouse senosor point and normal, in IMU space. 110 110 * 111 - * @ingroup drv_vive 111 + * @ingroup aux_vive 112 112 */ 113 113 struct lh_sensor 114 114 { ··· 123 123 * 124 124 * All sensors are placed in IMU space. 125 125 * 126 - * @ingroup drv_vive 126 + * @ingroup aux_vive 127 127 */ 128 128 struct lh_model 129 129 { ··· 134 134 /*! 135 135 * headset config. 136 136 * 137 - * @ingroup drv_vive 137 + * @ingroup aux_vive 138 138 */ 139 139 struct vive_config 140 140 { ··· 211 211 /*! 212 212 * Controller config. 213 213 * 214 - * @ingroup drv_vive 214 + * @ingroup aux_vive 215 215 */ 216 216 struct vive_controller_config 217 217 { ··· 255 255 /*! 256 256 * Parse a headset config. 257 257 * 258 - * @ingroup drv_vive 258 + * @ingroup aux_vive 259 259 */ 260 260 bool 261 261 vive_config_parse(struct vive_config *d, char *json_string, enum u_logging_level log_level); ··· 263 263 /*! 264 264 * Free any allocated resources on this config. 265 265 * 266 - * @ingroup drv_vive 266 + * @ingroup aux_vive 267 267 */ 268 268 void 269 269 vive_config_teardown(struct vive_config *config); ··· 271 271 /*! 272 272 * Parse a controller config. 273 273 * 274 - * @ingroup drv_vive 274 + * @ingroup aux_vive 275 275 */ 276 276 bool 277 277 vive_config_parse_controller(struct vive_controller_config *d, char *json_string, enum u_logging_level log_level);
+1 -1
src/xrt/auxiliary/vive/vive_poses.c
··· 4 4 * @file 5 5 * @brief Vive poses implementation 6 6 * @author Daniel Willmott <web@dan-w.com> 7 - * @ingroup drv_vive 7 + * @ingroup aux_vive 8 8 */ 9 9 10 10 #include "vive_poses.h"
+1 -1
src/xrt/auxiliary/vive/vive_poses.h
··· 4 4 * @file 5 5 * @brief vive poses header 6 6 * @author Daniel Willmott <web@dan-w.com> 7 - * @ingroup drv_vive 7 + * @ingroup aux_vive 8 8 */ 9 9 10 10 #pragma once
+1 -1
src/xrt/auxiliary/vive/vive_tweaks.c
··· 4 4 * @file 5 5 * @brief Tweaks for various bits on Vive and Index headsets. 6 6 * @author Jakob Bornecrantz <jakob@collabora.com> 7 - * @ingroup drv_vive 7 + * @ingroup aux_vive 8 8 */ 9 9 10 10 #include "xrt/xrt_defines.h"
+2 -2
src/xrt/auxiliary/vive/vive_tweaks.h
··· 4 4 * @file 5 5 * @brief Tweaks for various bits on Vive and Index headsets. 6 6 * @author Jakob Bornecrantz <jakob@collabora.com> 7 - * @ingroup drv_vive 7 + * @ingroup aux_vive 8 8 */ 9 9 10 10 #pragma once ··· 22 22 /*! 23 23 * Tweak the fov for the views on the given config, to make it better. 24 24 * 25 - * @ingroup drv_vive 25 + * @ingroup aux_vive 26 26 */ 27 27 void 28 28 vive_tweak_fov(struct vive_config *config);