chore(math): document how to create a cubic curve

bevyengine · Jan 13, 2024 · 5efb886 · 5efb886
1 parent 5deac2f
commit 5efb886
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/crates/bevy_math/src/cubic_splines.rs b/crates/bevy_math/src/cubic_splines.rs
@@ -431,6 +431,9 @@ impl CubicSegment<Vec2> {
 }
 
 /// A collection of [`CubicSegment`]s chained into a curve.
+///
+/// Use any struct that implements the [`CubicGenerator`] trait to create a new curve, such as
+/// [`CubicBezier`].
 #[derive(Clone, Debug, PartialEq)]
 pub struct CubicCurve<P: Point> {
     segments: Vec<CubicSegment<P>>,