summaryrefslogtreecommitdiff
path: root/platformer/src/render.h
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--platformer/src/render.h31
1 files changed, 31 insertions, 0 deletions
diff --git a/platformer/src/render.h b/platformer/src/render.h
new file mode 100644
index 0000000..33e518d
--- /dev/null
+++ b/platformer/src/render.h
@@ -0,0 +1,31 @@
+/*
+ * ============================================================
+ * FILE: render.h
+ *
+ * PURPOSE: Public interface for drawing a frame. Rendering only READS game
+ * state; it never changes the player, the camera or the world.
+ *
+ * FITS IN: main.c calls render_init() after window_init(), render_frame()
+ * once per display frame, and render_shutdown() before
+ * window_shutdown().
+ *
+ * INTERFACE: Use these exact signatures:
+ *
+ * bool render_init(void); compiles shaders, builds meshes. Returns
+ * false (after printing why) on failure.
+ * void render_frame(const Camera *cam, const Player *player, float aspect);
+ * void render_shutdown(void); frees GL objects
+ *
+ * Include <stdbool.h>, "camera.h", "player.h".
+ *
+ * CONVENTIONS: Include guard: RENDER_H.
+ *
+ * NOT IN SCOPE: A general renderer / scene graph, materials, textures, text.
+ *
+ * DONE WHEN: main.c can draw everything with these three calls.
+ * ============================================================
+ */
+#ifndef RENDER_H
+#define RENDER_H
+
+#endif /* RENDER_H */