The open source OpenXR runtime

t/framemat: Update confusing comments, sorry.

+8 -4
+8 -4
src/xrt/auxiliary/tracking/t_frame_cv_mat_wrapper.hpp
··· 44 44 ~FrameMat(); 45 45 46 46 /*! 47 - * Wraps the given @ref cv::Mat assuming it's a 24bit RGB format matrix, the pointer pointed to by @ref xf_ptr 48 - * will have it's reference updated. 47 + * Wraps the given @ref cv::Mat assuming it's a 24bit RGB format matrix. 48 + * In all but the most strange cases you probably want the pointer 49 + * pointed to by @ref xf_ptr to be nullptr, if not nullptr it will have 50 + * it's reference decremented so make sure it's a valid pointer. 49 51 */ 50 52 static void 51 53 wrapR8G8B8(cv::Mat mat, xrt_frame **xf_ptr, const Params /*&&?*/ params = {}); 52 54 53 55 /*! 54 - * Wraps the given @ref cv::Mat assuming it's a 8bit format matrix, the pointer pointed to by @ref xf_ptr will 55 - * have it's reference updated. 56 + * Wraps the given @ref cv::Mat assuming it's a 8bit format matrix. 57 + * In all but the most strange cases you probably want the pointer 58 + * pointed to by @ref xf_ptr to be nullptr, if not nullptr it will have 59 + * it's reference decremented so make sure it's a valid pointer. 56 60 */ 57 61 static void 58 62 wrapL8(cv::Mat mat, xrt_frame **xf_ptr, const Params /*&&?*/ params = {});