updated renderer .h and .c comments

glisy · Feb 8, 2016 · 58796e0 · 58796e0
1 parent 73d8389
commit 58796e0
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 9 deletions.
diff --git a/include/glisy/renderer.h b/include/glisy/renderer.h
@@ -1,30 +1,39 @@
 #ifndef GLISY_RENDERER_H
 #define GLISY_RENDERER_H
 
-#include <glisy/renderer.h>
+#include <glisy/gl.h>
 
 /**
- * glisy renderer structure.
+ * Glisy Renderer structure type.
  */
 
 typedef struct glisy_renderer glisy_renderer;
 struct glisy_renderer {
 
+  // renderer width
+  GLint width;
+
+  // renderer width
+  GLint height;
+
 };
 
 /**
- * Set renderer viewport size with
- * width and height.
+ * Set Glisy Renderer viewport width and height.
+ * @param renderer - Glisy Renderer struct
+ * @param width    - Glisy Renderer viewport width
+ * @param height   - Glisy Renderer viewport height
  */
 
 void
-glisy_renderer_size (const glisy_renderer, int, int);
+glisy_renderer_size(const glisy_renderer renderer, GLint width, GLint height);
 
 /**
- * Updates render state.
+ * Update Glisy Renderer state.
+ * @param renderer - Glisy Renderer struct
  */
 
 void
-glisy_renderer_update (const glisy_renderer);
+glisy_renderer_update(const glisy_renderer renderer);
 
 #endif
diff --git a/src/renderer.c b/src/renderer.c
@@ -1,9 +1,19 @@
 #include <glisy/renderer.h>
 
+/**
+ * Set Glisy Renderer viewport width and height.
+ */
+
 void
-glisy_renderer_size (glisy_renderer this, int width, int height) {
+glisy_renderer_size(glisy_renderer renderer, GLint width, GLint height) {
+  //@TODO(jwerle): implement glisy_renderer_size()
 }
 
+/**
+ * Update Glisy Renderer state.
+ */
+
 void
-glisy_renderer_update (glisy_renderer this) {
+glisy_renderer_update(glisy_renderer renderer) {
+  //@TODO(jwerle): implement glisy_renderer_update()
 }