diff --git a/src/xrt/auxiliary/vive/vive_bindings.c b/src/xrt/auxiliary/vive/vive_bindings.c index 19481df4c..33f16b352 100644 --- a/src/xrt/auxiliary/vive/vive_bindings.c +++ b/src/xrt/auxiliary/vive/vive_bindings.c @@ -5,7 +5,7 @@ * @brief Shared bindings structs for @ref drv_vive & @ref drv_survive. * @author Christoph Haag * @author Jakob Bornecrantz - * @ingroup drv_vive + * @ingroup aux_vive */ #include "vive/vive_bindings.h" diff --git a/src/xrt/auxiliary/vive/vive_bindings.h b/src/xrt/auxiliary/vive/vive_bindings.h index 2cb8dc8b2..0dffa2286 100644 --- a/src/xrt/auxiliary/vive/vive_bindings.h +++ b/src/xrt/auxiliary/vive/vive_bindings.h @@ -5,7 +5,7 @@ * @brief Shared bindings structs for @ref drv_vive & @ref drv_survive. * @author Christoph Haag * @author Jakob Bornecrantz - * @ingroup drv_vive + * @ingroup aux_vive */ #pragma once diff --git a/src/xrt/auxiliary/vive/vive_calibration.c b/src/xrt/auxiliary/vive/vive_calibration.c index 04a22b2b6..d04332140 100644 --- a/src/xrt/auxiliary/vive/vive_calibration.c +++ b/src/xrt/auxiliary/vive/vive_calibration.c @@ -5,7 +5,7 @@ * @brief Vive calibration getters. * @author Mateo de Mayo * @author Moses Turner - * @ingroup drv_vive + * @ingroup aux_vive */ #include "math/m_api.h" diff --git a/src/xrt/auxiliary/vive/vive_calibration.h b/src/xrt/auxiliary/vive/vive_calibration.h index dfe81ab45..262fef9b9 100644 --- a/src/xrt/auxiliary/vive/vive_calibration.h +++ b/src/xrt/auxiliary/vive/vive_calibration.h @@ -5,7 +5,7 @@ * @brief Vive calibration getters. * @author Mateo de Mayo * @author Moses Turner - * @ingroup drv_vive + * @ingroup aux_vive */ #pragma once @@ -24,7 +24,7 @@ struct vive_config; /*! * Get a @ref t_stereo_camera_calibration and @ref xrt_pose from left camera to head translation. * - * @ingroup drv_vive + * @ingroup aux_vive */ bool vive_get_stereo_camera_calibration(const struct vive_config *d, @@ -34,7 +34,7 @@ vive_get_stereo_camera_calibration(const struct vive_config *d, /*! * Get a @ref t_slam_camera_calibration one for each camera. * - * @ingroup drv_vive + * @ingroup aux_vive */ void vive_get_slam_cams_calib(const struct vive_config *d, @@ -44,7 +44,7 @@ vive_get_slam_cams_calib(const struct vive_config *d, /*! * Get a @ref t_imu_calibration for the IMU. * - * @ingroup drv_vive + * @ingroup aux_vive */ void vive_get_imu_calibration(const struct vive_config *d, struct t_imu_calibration *out_calib); @@ -52,7 +52,7 @@ vive_get_imu_calibration(const struct vive_config *d, struct t_imu_calibration * /*! * Get a @ref t_slam_imu_calibration for the IMU. * - * @ingroup drv_vive + * @ingroup aux_vive */ void vive_get_slam_imu_calibration(const struct vive_config *d, struct t_slam_imu_calibration *out_calib); diff --git a/src/xrt/auxiliary/vive/vive_common.h b/src/xrt/auxiliary/vive/vive_common.h new file mode 100644 index 000000000..489dee8c9 --- /dev/null +++ b/src/xrt/auxiliary/vive/vive_common.h @@ -0,0 +1,37 @@ +// Copyright 2020-2023, Collabora, Ltd. +// SPDX-License-Identifier: BSL-1.0 +/*! + * @file + * @brief Common things like defines for Vive and Index. + * @author Jakob Bornecrantz + * @ingroup aux_vive + */ + +#pragma once + +#include "xrt/xrt_compiler.h" + + +#ifdef __cplusplus +extern "C" { +#endif + + +/*! + * @defgroup aux_vive Shared code for @ref drv_vive and @ref drv_survive. + * @ingroup aux + * + * @brief Shared functionality for @ref drv_vive and @ref drv_survive drivers + * that supports the HTC Vive and Valve Index family of HMDs. + */ + +/*! + * @dir auxiliary/vive + * + * @brief @ref aux_vive files. + */ + + +#ifdef __cplusplus +} +#endif diff --git a/src/xrt/auxiliary/vive/vive_config.c b/src/xrt/auxiliary/vive/vive_config.c index 7ce614107..dbddee11c 100644 --- a/src/xrt/auxiliary/vive/vive_config.c +++ b/src/xrt/auxiliary/vive/vive_config.c @@ -5,7 +5,7 @@ * @brief Vive json implementation * @author Lubosz Sarnecki * @author Moses Turner - * @ingroup drv_vive + * @ingroup aux_vive */ #include "math/m_api.h" diff --git a/src/xrt/auxiliary/vive/vive_config.h b/src/xrt/auxiliary/vive/vive_config.h index a98c8598b..8cd4c9ea8 100644 --- a/src/xrt/auxiliary/vive/vive_config.h +++ b/src/xrt/auxiliary/vive/vive_config.h @@ -5,7 +5,7 @@ * @brief vive json header * @author Lubosz Sarnecki * @author Moses Turner - * @ingroup drv_vive + * @ingroup aux_vive */ #pragma once @@ -41,7 +41,7 @@ extern "C" { /*! * Headset variant. * - * @ingroup drv_vive + * @ingroup aux_vive */ enum VIVE_VARIANT { @@ -54,7 +54,7 @@ enum VIVE_VARIANT /*! * Controller variant. * - * @ingroup drv_vive + * @ingroup aux_vive */ enum VIVE_CONTROLLER_VARIANT { @@ -69,7 +69,7 @@ enum VIVE_CONTROLLER_VARIANT /*! * A calibrated camera on an Index. * - * @ingroup drv_vive + * @ingroup aux_vive */ struct index_camera { @@ -108,7 +108,7 @@ struct index_camera /*! * A single lighthouse senosor point and normal, in IMU space. * - * @ingroup drv_vive + * @ingroup aux_vive */ struct lh_sensor { @@ -123,7 +123,7 @@ struct lh_sensor * * All sensors are placed in IMU space. * - * @ingroup drv_vive + * @ingroup aux_vive */ struct lh_model { @@ -134,7 +134,7 @@ struct lh_model /*! * headset config. * - * @ingroup drv_vive + * @ingroup aux_vive */ struct vive_config { @@ -211,7 +211,7 @@ struct vive_config /*! * Controller config. * - * @ingroup drv_vive + * @ingroup aux_vive */ struct vive_controller_config { @@ -255,7 +255,7 @@ struct vive_controller_config /*! * Parse a headset config. * - * @ingroup drv_vive + * @ingroup aux_vive */ bool vive_config_parse(struct vive_config *d, char *json_string, enum u_logging_level log_level); @@ -263,7 +263,7 @@ vive_config_parse(struct vive_config *d, char *json_string, enum u_logging_level /*! * Free any allocated resources on this config. * - * @ingroup drv_vive + * @ingroup aux_vive */ void vive_config_teardown(struct vive_config *config); @@ -271,7 +271,7 @@ vive_config_teardown(struct vive_config *config); /*! * Parse a controller config. * - * @ingroup drv_vive + * @ingroup aux_vive */ bool vive_config_parse_controller(struct vive_controller_config *d, char *json_string, enum u_logging_level log_level); diff --git a/src/xrt/auxiliary/vive/vive_poses.c b/src/xrt/auxiliary/vive/vive_poses.c index e87e7cf51..f387a721f 100644 --- a/src/xrt/auxiliary/vive/vive_poses.c +++ b/src/xrt/auxiliary/vive/vive_poses.c @@ -4,7 +4,7 @@ * @file * @brief Vive poses implementation * @author Daniel Willmott - * @ingroup drv_vive + * @ingroup aux_vive */ #include "vive_poses.h" diff --git a/src/xrt/auxiliary/vive/vive_poses.h b/src/xrt/auxiliary/vive/vive_poses.h index 44078d487..73be1daa2 100644 --- a/src/xrt/auxiliary/vive/vive_poses.h +++ b/src/xrt/auxiliary/vive/vive_poses.h @@ -4,7 +4,7 @@ * @file * @brief vive poses header * @author Daniel Willmott - * @ingroup drv_vive + * @ingroup aux_vive */ #pragma once diff --git a/src/xrt/auxiliary/vive/vive_tweaks.c b/src/xrt/auxiliary/vive/vive_tweaks.c index a8f89234d..d3f3be410 100644 --- a/src/xrt/auxiliary/vive/vive_tweaks.c +++ b/src/xrt/auxiliary/vive/vive_tweaks.c @@ -4,7 +4,7 @@ * @file * @brief Tweaks for various bits on Vive and Index headsets. * @author Jakob Bornecrantz - * @ingroup drv_vive + * @ingroup aux_vive */ #include "xrt/xrt_defines.h" diff --git a/src/xrt/auxiliary/vive/vive_tweaks.h b/src/xrt/auxiliary/vive/vive_tweaks.h index d91524c23..90fd56f30 100644 --- a/src/xrt/auxiliary/vive/vive_tweaks.h +++ b/src/xrt/auxiliary/vive/vive_tweaks.h @@ -4,7 +4,7 @@ * @file * @brief Tweaks for various bits on Vive and Index headsets. * @author Jakob Bornecrantz - * @ingroup drv_vive + * @ingroup aux_vive */ #pragma once @@ -22,7 +22,7 @@ struct vive_config; /*! * Tweak the fov for the views on the given config, to make it better. * - * @ingroup drv_vive + * @ingroup aux_vive */ void vive_tweak_fov(struct vive_config *config);