Skip to content

Commit 6cc651e

Browse files
committed
docs: update documentation
1 parent b0ce954 commit 6cc651e

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

crates/bevy_math/src/ray.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ impl Ray2d {
5555
}
5656
}
5757

58-
/// Defines if the Ray3d should intersect the plane only on the front face, back face, or both.
58+
/// Controls which faces of the plane a ray can intersect.
5959
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
6060
#[cfg_attr(feature = "serialize", derive(serde::Serialize, serde::Deserialize))]
6161
#[cfg_attr(
@@ -68,9 +68,11 @@ impl Ray2d {
6868
reflect(Deserialize, Serialize)
6969
)]
7070
pub enum PlaneIntersectionMode {
71-
/// Intersects only the front face of the plane.
71+
/// Intersects only the front face of the plane
72+
/// (the side from which the plane normal points towards the ray).
7273
FrontFaceOnly,
73-
/// Intersects only the back face of the plane.
74+
/// Intersects only the back face of the plane
75+
/// (the side opposite to the normal).
7476
BackFaceOnly,
7577
/// Intersects both faces of the plane.
7678
Both,

0 commit comments

Comments
 (0)