star-gf

commit b61839e419d9bdc180c82d31b058a9d6f6c839b7
parent 7a9bf54c0abba559de8864d3900411146e766cf0
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Wed, 19 Oct 2016 17:49:55 +0200

Add comments

Diffstat:
M
src/sgf.h
 | 
10
+++++++---

1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/src/sgf.h b/src/sgf.h
@@ -112,11 +112,15 @@ SGF_API res_T
 sgf_scene_ref_put
   (struct sgf_scene* scn);
 
+/* Return RES_BAD_OP if an integration process is currently active onto the
+ * provided scene */
 SGF_API res_T
 sgf_scene_setup_3d
   (struct sgf_scene* scn,
    const struct sgf_scene_desc* desc);
 
+/* Return RES_BAD_OP if an integration process is currently active onto the
+ * provided scene */
 SGF_API res_T
 sgf_scene_setup_2d
   (struct sgf_scene* scn,
@@ -139,9 +143,9 @@ sgf_scene_end_integration
  * Integration API
  ******************************************************************************/
 /* Numerical estimation of the Gebhart Factor between `primitive_id' and the
- * other scene primitives. An active S3D_TRACE/S3D_GET_PRIMITIVE session must
- * be active on `desc->scene'. This function is thread safe and can be invoked
- * by several threads. */
+ * other scene primitives. The `sgf_scene_begin_integration' function hat to be
+ * invoked onto the provided scene. RES_BAD_OP is returned if not. This
+ * function is thread safe and can be invoked by several threads. */
 SGF_API res_T
 sgf_integrate
   (struct sgf_scene* scn,