aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/Camera.h
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-11-08 20:00:21 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-11-08 20:00:21 +0100
commit7817c85e84560933a33ad86ec3f9ca3d48d327d5 (patch)
treec309b9f779ca33f01d5755222a56ffca517baef4 /src/crepe/api/Camera.h
parent0feda3d123ff99a1b9e41837482268bebfd9140a (diff)
parentac8a58a2a16118ea4c40fcc533c3420edde45122 (diff)
Merge branch 'niels/cleanup' of github.com:lonkaars/crepe
Diffstat (limited to 'src/crepe/api/Camera.h')
-rw-r--r--src/crepe/api/Camera.h59
1 files changed, 59 insertions, 0 deletions
diff --git a/src/crepe/api/Camera.h b/src/crepe/api/Camera.h
new file mode 100644
index 0000000..708a523
--- /dev/null
+++ b/src/crepe/api/Camera.h
@@ -0,0 +1,59 @@
+#pragma once
+
+#include <cstdint>
+
+#include "Color.h"
+#include "Component.h"
+
+namespace crepe {
+
+/**
+ * \class Camera
+ * \brief Represents a camera component for rendering in the game.
+ *
+ * The Camera class defines the view parameters, including background color,
+ * aspect ratio, position, and zoom level. It controls what part of the game
+ * world is visible on the screen.
+ */
+class Camera : public Component {
+
+public:
+ /**
+ * \brief Constructs a Camera with the specified ID and background color.
+ * \param id Unique identifier for the camera component.
+ * \param bg_color Background color for the camera view.
+ */
+ Camera(uint32_t id, const Color & bg_color);
+
+ /**
+ * \brief Destroys the Camera instance.
+ */
+ ~Camera();
+
+public:
+ //! \brief Background color of the camera view.
+ Color bg_color;
+
+ //! \brief Aspect ratio height for the camera.
+ double aspect_height;
+
+ //! \brief Aspect ratio width for the camera.
+ double aspect_width;
+
+ //! \brief X-coordinate of the camera position.
+ double x;
+
+ //! \brief Y-coordinate of the camera position.
+ double y;
+
+ //! \brief Zoom level of the camera view.
+ double zoom;
+
+public:
+ /**
+ * \brief Gets the maximum number of camera instances allowed.
+ * \return Maximum instance count as an integer.
+ */
+ virtual int get_instances_max() const { return 10; }
+};
+} // namespace crepe