diff --git a/include/fastfields/api/distance.h b/include/fastfields/api/distance.h index a4e51cc..072d439 100644 --- a/include/fastfields/api/distance.h +++ b/include/fastfields/api/distance.h @@ -150,13 +150,18 @@ void dt_spline_gaussnewton( /** * @brief Compute the distance from a set of points to a triangular mesh. * - * @param dist Output tensor for squared distances (*B,) + * @param dist Output tensor for distances (*B,). NOT squared -- + * unlike the spline ops above, this is the plain + * Euclidean point-to-triangle distance, negative + * inside the surface when `_signed`. * @param nearest_vertex Output tensor for index of nearest vertex (*B,) * @param loc Input tensor for ND location of each point (*B, D) * @param vertices Input tensor for mesh vertices (N, D) * @param faces Input tensor for mesh faces (M, D) - * @param _signed Whether to compute signed distances (inside negative) - * @param naive Whether to use the naive algorithm (no acceleration structure) + * @param _signed Whether to compute signed distances (negative + * inside the surface) + * @param naive Whether to use the naive algorithm (no + * acceleration structure) * @param stream Cuda stream on which to operate */ void dt_mesh(