Skip to content

Commit

Permalink
Clarify documentation of RaycastMesh::intersections (#104)
Browse files Browse the repository at this point in the history
Co-authored-by: Aevyrie <aevyrie@gmail.com>
  • Loading branch information
stepancheg and aevyrie authored Feb 18, 2024
1 parent b0e13a9 commit 586ac48
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions src/deferred.rs
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,12 @@ pub struct RaycastMesh<T: TypePath> {
}

impl<T: TypePath> RaycastMesh<T> {
/// Get a reference to the ray cast source's intersections. Returns an empty list if there are
/// no intersections.
/// Get a reference to the ray cast source's intersections.
///
/// Here the [`Entity`] is the entity of the [`RaycastSource`] component.
/// Returns the list of intersections with all the sources with matching generic parameter
/// that intersected this mesh during the last raycast system run.
/// Returns an empty list if there are no intersections.
pub fn intersections(&self) -> &[(Entity, IntersectionData)] {
&self.intersections
}
Expand Down

0 comments on commit 586ac48

Please sign in to comment.