summaryrefslogtreecommitdiffstats
path: root/src/input/mouse
diff options
context:
space:
mode:
Diffstat (limited to 'src/input/mouse')
-rw-r--r--src/input/mouse/button.rs5
-rw-r--r--src/input/mouse/event.rs5
2 files changed, 10 insertions, 0 deletions
diff --git a/src/input/mouse/button.rs b/src/input/mouse/button.rs
index e552af5a..6320d701 100644
--- a/src/input/mouse/button.rs
+++ b/src/input/mouse/button.rs
@@ -1,4 +1,9 @@
/// The button of a mouse.
+///
+/// If you are using [`winit`], consider enabling the `winit` feature to get
+/// conversion implementations for free!
+///
+/// [`winit`]: https://docs.rs/winit/0.20.0-alpha3/winit/
#[derive(Debug, Hash, PartialEq, Eq, Clone, Copy)]
pub enum Button {
/// The left mouse button.
diff --git a/src/input/mouse/event.rs b/src/input/mouse/event.rs
index 1f7a1547..7b68208f 100644
--- a/src/input/mouse/event.rs
+++ b/src/input/mouse/event.rs
@@ -2,6 +2,11 @@ use super::Button;
use crate::input::ButtonState;
/// A mouse event.
+///
+/// _**Note:** This type is largely incomplete! If you need to track
+/// additional events, feel free to [open an issue] and share your use case!_
+///
+/// [open an issue]: https://github.com/hecrj/iced/issues
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum Event {
/// The mouse cursor entered the window.