Primitive done.

src/engine/display/primitive.h

@@ -1,33 +1,69 @@
 #pragma once
 #include <stdint.h>
 #include <glad/glad.h>
+#include <malloc.h>
 
 #define PRIMITIVE_POSITIONS_PER_VERTICE 3
 #define PRIMITIVE_COORDINATES_PER_VERTICE 2
 
+/** Structure containing information about a primitive */
 typedef struct {
   int32_t verticeCount;
+  int32_t indiceCount;
 
-  GLuint vertexArray;
   GLuint vertexBuffer;
   GLuint indexBuffer;
 } primitive_t;
 
+/** Structure containing vertice position information */
 typedef struct {
   float x, y, z;
   float u, v;
 } vertice_t;
 
-primitive_t * primitiveCreate(int32_t verticeCount);
+/** Indice that references a specific vertice */
+typedef unsigned int indice_t;
 
+/**
+ * Creates a new primitive.
+ * @param verticeCount How many vertices can the primitive hold.
+ * @param indiceCount How many indices can the primitive hold.
+ * @return The newly created primitive ready to be buffered to.
+ */
+primitive_t * primitiveCreate(int32_t verticeCount, int32_t indiceCount);
+
+/**
+ * Buffer Vertices to a primitive for use in rendering.
+ * @param primitive The primitive to buffer vertices into.
+ * @param position The position (index) to overwrite the vertices of.
+ * @param count The count of vertices to buffer.
+ * @param vertices Array of vertices to buffer into the primitive.
+ */
 void primitiveBufferVertices(primitive_t *primitive,
   int32_t position, int32_t count, vertice_t *vertices
 );
 
+/**
+ * Buffer Indices to a primitive for use in rendering.
+ * @param primitive The primitive to buffer indices into.
+ * @param position The position (index) to overwrite the indices of.
+ * @param count The count of indices to buffer.
+ * @param indices Array of indices to buffer into the primitive.
+ */
 void primitiveBufferIndices(primitive_t *primitive, 
-  int32_t position, int32_t count, int32_t *indices
+  int32_t position, int32_t count, indice_t *indices
 );
 
+/**
+ * Draw a primitive. Primitives are drawn by their indices.
+ * @param primitive Primitive to draw.
+ * @param start Start indice (index) to draw.
+ * @param count Count of indices to draw.
+ */
 void primitiveDraw(primitive_t *primitive, int32_t start, int32_t count);
 
+/**
+ * Cleanup a previously created primitive.
+ * @param primitive Primitive to cleanup.
+ */
 void primitiveDispose(primitive_t *primitive);