@@ -7,7 +7,7 @@ use bevy_reflect::{ReflectDeserialize, ReflectSerialize};
77
88/// A region of 3D space defined by the intersection of 6 [`HalfSpace`]s.
99///
10- /// Frustums are typically an apex-truncated square pyramid (a pyramid without the top) or a cuboid.
10+ /// View Frustums are typically an apex-truncated square pyramid (a pyramid without the top) or a cuboid.
1111///
1212/// Half spaces are ordered left, right, top, bottom, near, far. The normal vectors
1313/// of the half-spaces point towards the interior of the frustum.
@@ -36,17 +36,17 @@ impl ViewFrustum {
3636 /// Vec4 representing an inactive half space.
3737 /// The bisecting plane's unit normal is set to (0, 0, 0).
3838 /// The signed distance along the normal from the plane to the origin is set to `f32::INFINITY`.
39- pub const INACTIVE_HALF_SPACE : Vec4 = Vec4 :: new ( 0.0 , 0.0 , 0.0 , f32:: INFINITY ) ;
39+ const INACTIVE_HALF_SPACE : Vec4 = Vec4 :: new ( 0.0 , 0.0 , 0.0 , f32:: INFINITY ) ;
4040
41- /// Returns a frustum derived from `clip_from_world`.
41+ /// Returns a view frustum derived from `clip_from_world`.
4242 #[ inline]
4343 pub fn from_clip_from_world ( clip_from_world : & Mat4 ) -> Self {
4444 let mut frustum = ViewFrustum :: from_clip_from_world_no_far ( clip_from_world) ;
4545 frustum. half_spaces [ Self :: FAR_PLANE_IDX ] = HalfSpace :: new ( clip_from_world. row ( 2 ) ) ;
4646 frustum
4747 }
4848
49- /// Returns a frustum derived from `clip_from_world`,
49+ /// Returns a view frustum derived from `clip_from_world`,
5050 /// but with a custom far plane.
5151 #[ inline]
5252 pub fn from_clip_from_world_custom_far (
@@ -65,7 +65,7 @@ impl ViewFrustum {
6565 // NOTE: This approach of extracting the frustum half-space from the view
6666 // projection matrix is from Foundations of Game Engine Development 2
6767 // Rendering by Lengyel.
68- /// Returns a frustum derived from `view_projection`,
68+ /// Returns a view frustum derived from `view_projection`,
6969 /// without a far plane.
7070 fn from_clip_from_world_no_far ( clip_from_world : & Mat4 ) -> Self {
7171 let row0 = clip_from_world. row ( 0 ) ;
0 commit comments