star-3d

commit db37af79b18a5256f0c2acfbdd7ca0b132d89e65
parent d67fb82b645e638378118796c51740ceba66a42f
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Fri, 20 Mar 2015 12:41:30 +0100

Add some comments to the s3d API header

Diffstat:
M
src/s3d.h
 | 
14
+++++++++++---

1 file changed, 11 insertions(+), 3 deletions(-)
diff --git a/src/s3d.h b/src/s3d.h
@@ -275,8 +275,10 @@ s3d_shape_sample
    unsigned* iprim, /* Sampled primitive */
    float uv[2]); /* Sampled barycentric coordinate onto `iprim' */
 
-/* Set/update the data of the triangular meshes. Can be invoked only on shape
- * created with the s3d_shape_create_mesh function */
+/*******************************************************************************
+ * Mesh API - Define a triangluar meshes
+ ******************************************************************************/
+/* Set/update the data of the indexed triangular meshes */
 S3D_API res_T
 s3d_mesh_setup_indexed_vertices
   (struct s3d_shape* shape,
@@ -290,7 +292,13 @@ s3d_mesh_setup_indexed_vertices
    struct s3d_vertex_data attribs[],
    void* data); /* Client data set as the last param of the vertex callbacks */
 
-/* Can be invoked only on a shape instantioed with s3d_scene_instantiate */
+/*******************************************************************************
+ * Instance API - An instance is a shape that encapsulates a scene. One can
+ * define a specific local to world transformation to an instance. Since the
+ * scene geometry is stored only a single time even though it is instantiated
+ * in several positions, one can use this feature to create extremerly large
+ * scene
+ * ******************************************************************************/
 S3D_API res_T
 s3d_instance_set_position
   (struct s3d_shape* shape,