From 3d91dfdff393ecc5282575f38cfab21a89a60e8c Mon Sep 17 00:00:00 2001 From: Stephen Seo Date: Wed, 1 May 2024 13:38:45 +0900 Subject: [PATCH] Add some doc comments to header --- src/sc_sacd.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/sc_sacd.h b/src/sc_sacd.h index 3f9ed07..9cb0e21 100644 --- a/src/sc_sacd.h +++ b/src/sc_sacd.h @@ -119,10 +119,12 @@ SC_SACD_EXPORT SC_SACD_Mat4 SC_SACD_Rotation_Mat4_ZAxis(float z_radians); SC_SACD_EXPORT SC_SACD_Mat4 SC_SACD_Translate_Mat4(float x, float y, float z); +/// This variant of Closest_Point expects "dir" to be a unit vector. SC_SACD_EXPORT SC_SACD_Vec3 SC_SACD_Closest_Point_Dir_Normalized( const SC_SACD_Vec3 *pos, const SC_SACD_Vec3 *dir, const SC_SACD_Vec3 *point); +/// This variant of Closest_Point expects "dir" to NOT be a unit vector. SC_SACD_EXPORT SC_SACD_Vec3 SC_SACD_Closest_Point(const SC_SACD_Vec3 *pos, const SC_SACD_Vec3 *dir, const SC_SACD_Vec3 *point);