aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/Animator.h
diff options
context:
space:
mode:
authorheavydemon21 <nielsstunnebrink1@gmail.com>2024-11-08 17:31:25 +0100
committerheavydemon21 <nielsstunnebrink1@gmail.com>2024-11-08 17:31:25 +0100
commit91a277c69fd5f8ba814adc1006a49c7415ff65be (patch)
tree5545e9a9374e017a45ea56a81c2b7e24091cbcc2 /src/crepe/api/Animator.h
parentcb6aae1751a95a29bc04d805d9cc9135b5c54c1e (diff)
updated to satisfy the code review
Diffstat (limited to 'src/crepe/api/Animator.h')
-rw-r--r--src/crepe/api/Animator.h14
1 files changed, 8 insertions, 6 deletions
diff --git a/src/crepe/api/Animator.h b/src/crepe/api/Animator.h
index ede1610..42ce957 100644
--- a/src/crepe/api/Animator.h
+++ b/src/crepe/api/Animator.h
@@ -28,11 +28,11 @@ public:
/**
* \brief Constructs an Animator object that will control animations for a sprite sheet.
*
- * \param[in] id The unique identifier for the component, typically assigned automatically.
- * \param[in] spritesheet A reference to the Sprite object which holds the sprite sheet for animation.
- * \param[in] row The maximum number of rows in the sprite sheet.
- * \param[in] col The maximum number of columns in the sprite sheet.
- * \param[in] col__animate The specific col index of the sprite sheet to animate. This allows selecting which col to animate from multiple col in the sheet.
+ * \param id The unique identifier for the component, typically assigned automatically.
+ * \param spritesheet A reference to the Sprite object which holds the sprite sheet for animation.
+ * \param row The maximum number of rows in the sprite sheet.
+ * \param col The maximum number of columns in the sprite sheet.
+ * \param col__animate The specific col index of the sprite sheet to animate. This allows selecting which col to animate from multiple col in the sheet.
*
* This constructor sets up the Animator with the given parameters, and initializes the animation system.
*/
@@ -80,8 +80,10 @@ private:
//int fps;
private:
- //! Friend class that can directly access the private members of the Animator.
+ //! AnimatorSystem adjust the private member parameters of Animator;
friend class AnimatorSystem;
+
+ //! SDLContext reads the Animator member var's
friend class SDLContext;
};
} // namespace crepe