star-3d

commit 9a35b047ec21d095f54d05c744ece13105205cb5
parent 7dba474716e2377995f66f532085952246704a9b
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Wed, 16 Oct 2019 12:26:30 +0200

Update comments of the s3d_sphere_view_closest_point function

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

1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/src/s3d.h b/src/s3d.h
@@ -369,18 +369,20 @@ s3d_scene_view_trace_rays
    struct s3d_hit* hits);
 
 /* Return the point onto the scene surfaces that is the closest of the
- * submitted `pos'. The `radius' parameter defines the maximum search distance
- * around `pos'. Each candidate position are internally filtered by the
- * hit_filter_function attached to the corresponding shape; the user can thus
- * reject a candidate position according to its own criteria. This function can
- * be called only if the scnview was created with the S3D_TRACE flag which is
- * actually the flag used to tell Star-3D to internally build an acceleration
- * structure on which this function relies. */
+ * submitted `pos'. Note that even though only one point is returned, several
+ * position can have the same minimal distance to the queried position. The
+ * `radius' parameter defines the maximum search distance around `pos'. Each
+ * candidate position are internally filtered by the hit_filter_function
+ * attached to the corresponding shape; the user can thus reject a candidate
+ * position according to its own criteria.  This function can be called only if
+ * the scnview was created with the S3D_TRACE flag which is actually the flag
+ * used to tell Star-3D to internally build an acceleration structure on which
+ * this function relies. */
 S3D_API res_T
 s3d_scene_view_closest_point
   (struct s3d_scene_view* scnview,
    const float pos[3], /* Position to query */
-   const float radius, /* Search distance in [0, radius[ */
+   const float radius, /* Search distance in ]0, radius[ */
    void* query_data, /* User data sent to the hit filter func. May be NULL */
    struct s3d_hit* hit);