From a8251815afb98b816d782681c1ad0eccff5cd34e Mon Sep 17 00:00:00 2001 From: Jakob Bornecrantz Date: Mon, 23 Aug 2021 19:34:50 +0100 Subject: [PATCH] t/framemat: Update confusing comments, sorry. --- .../auxiliary/tracking/t_frame_cv_mat_wrapper.hpp | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.hpp b/src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.hpp index bac6b1f7e..f459406b1 100644 --- a/src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.hpp +++ b/src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.hpp @@ -44,15 +44,19 @@ public: ~FrameMat(); /*! - * Wraps the given @ref cv::Mat assuming it's a 24bit RGB format matrix, the pointer pointed to by @ref xf_ptr - * will have it's reference updated. + * Wraps the given @ref cv::Mat assuming it's a 24bit RGB format matrix. + * In all but the most strange cases you probably want the pointer + * pointed to by @ref xf_ptr to be nullptr, if not nullptr it will have + * it's reference decremented so make sure it's a valid pointer. */ static void wrapR8G8B8(cv::Mat mat, xrt_frame **xf_ptr, const Params /*&&?*/ params = {}); /*! - * Wraps the given @ref cv::Mat assuming it's a 8bit format matrix, the pointer pointed to by @ref xf_ptr will - * have it's reference updated. + * Wraps the given @ref cv::Mat assuming it's a 8bit format matrix. + * In all but the most strange cases you probably want the pointer + * pointed to by @ref xf_ptr to be nullptr, if not nullptr it will have + * it's reference decremented so make sure it's a valid pointer. */ static void wrapL8(cv::Mat mat, xrt_frame **xf_ptr, const Params /*&&?*/ params = {});