From ffa857d72236ad5c39eb7a0c4a07511b440c1202 Mon Sep 17 00:00:00 2001 From: Josh Morgenstern <josh@morgenstern.dev> Date: Mon, 28 Jun 2021 18:10:37 +0200 Subject: [PATCH] [#54] add documentation --- .../vkcv/camera/InterpolationLinear.hpp | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/modules/camera/include/vkcv/camera/InterpolationLinear.hpp b/modules/camera/include/vkcv/camera/InterpolationLinear.hpp index 578ca75d..cdcf0af6 100644 --- a/modules/camera/include/vkcv/camera/InterpolationLinear.hpp +++ b/modules/camera/include/vkcv/camera/InterpolationLinear.hpp @@ -18,12 +18,30 @@ namespace vkcv::camera { InterpolationLinear(Camera &camera); + /** + * @brief Add position vector to be approached. The positions are approached in the order in which they where added. + * + * @param pos + */ void addPosition(const glm::vec3& pos); + /** + * @brief Set the Camera object + * + * @param camera + */ void setCamera(Camera camera); + /** + * @brief Resets timer + * + */ void resetTimer(); + /** + * @brief Updates the camera with the interpolated position values + * + */ void updateCamera(); }; -- GitLab