Skip to content

Commit

Permalink
Adds an alias mouse position -> cursor position (bevyengine#2038)
Browse files Browse the repository at this point in the history
This alias is to aid people finding the cursor_position function, as the mouse
pressed / moved functionality and naming likely primes people for thinking
of "mouse" before "cursor" when searching the api documentation.
  • Loading branch information
jesseviikari authored and ostwilkens committed Jul 27, 2021
1 parent 0c2f17f commit 3b45cb8
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions crates/bevy_window/src/window.rs
Original file line number Diff line number Diff line change
Expand Up @@ -467,6 +467,7 @@ impl Window {
}

#[inline]
#[doc(alias = "mouse position")]
pub fn cursor_position(&self) -> Option<Vec2> {
self.cursor_position
}
Expand Down

0 comments on commit 3b45cb8

Please sign in to comment.