More docs

SecondHalfGames · May 14, 2024 · 463c157 · 463c157
1 parent 683e127
commit 463c157
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/crates/rolt/src/math.rs b/crates/rolt/src/math.rs
@@ -9,9 +9,15 @@ pub use glam::{DVec3, Mat4, Quat, Vec3, Vec4};
 
 use crate::{FromJolt, IntoJolt};
 
+/// Represents a world-space vector, which can use either `f32` or `f64`.
+///
+/// Because the `double-precision` feature is enabled, this uses `f64`.
 #[cfg(feature = "double-precision")]
 pub type RVec3 = DVec3;
 
+/// Represents a world-space vector, which can use either `f32` or `f64`.
+///
+/// Because the `double-precision` feature is NOT enabled, this uses `f32`.
 #[cfg(not(feature = "double-precision"))]
 pub type RVec3 = Vec3;
 

diff --git a/crates/rolt/src/narrow_phase.rs b/crates/rolt/src/narrow_phase.rs
@@ -43,6 +43,7 @@ pub struct RayCastArgs {
     pub body_filter: Option<BodyFilterImpl>,
 }
 
+/// The result of calling [`NarrowPhaseQuery::cast_ray`].
 #[derive(Debug, Clone, Copy)]
 pub struct RayCastResult {
     pub body_id: BodyId,