Express scroll deltas as either line or pixel deltas

Depending on the platform and device, scroll deltas may either
be represented as pixel deltas specifying the amount
in pixels to scroll or they may be expressed in 'lines' or 'chunks'
for low resolution devices (eg. a traditional mouse wheel).

Pixel deltas are currently available on OS X. X11 currently
supports only integer line deltas, though pixel deltas
are available via XInput2. Windows supports fractional
line deltas.

4 files changed, 32 insertions, 7 deletions

diff --git a/src/api/cocoa/mod.rs b/src/api/cocoa/mod.rs
index 511148b..43628ea 100644
--- a/src/api/cocoa/mod.rs
+++ b/src/api/cocoa/mod.rs
@@ -275,7 +275,11 @@ impl<'a> Iterator for PollEventsIterator<'a> {
                     self.window.delegate.state.pending_events.lock().unwrap().extend(events.into_iter());
                     event
                 },
-                NSScrollWheel           => { Some(MouseWheel(event.scrollingDeltaX() as f64, event.scrollingDeltaY() as f64)) },
+                NSScrollWheel => {
+                    use events::MouseScrollDelta::PixelDelta;
+                    let delta = PixelDelta(event.scrollingDeltaX() as f32, event.scrollingDeltaY() as f32);
+                    Some(MouseWheel(delta))
+                },
                 _                       => { None },
             };
 
diff --git a/src/api/win32/callback.rs b/src/api/win32/callback.rs
index 86d5f1c..6ac56f3 100644
--- a/src/api/win32/callback.rs
+++ b/src/api/win32/callback.rs
@@ -112,12 +112,13 @@ pub unsafe extern "system" fn callback(window: winapi::HWND, msg: winapi::UINT,
 
         winapi::WM_MOUSEWHEEL => {
             use events::Event::MouseWheel;
+            use events::MouseScrollDelta::LineDelta;
 
             let value = (wparam >> 16) as i16;
             let value = value as i32;
-            let value = value as f64 / winapi::WHEEL_DELTA as f64;
+            let value = value as f32 / winapi::WHEEL_DELTA as f32;
 
-            send_event(window, MouseWheel(0.0, value));
+            send_event(window, MouseWheel(LineDelta(0.0, value)));
 
             0
         },
diff --git a/src/api/x11/window.rs b/src/api/x11/window.rs
index 8b74e77..55ee007 100644
--- a/src/api/x11/window.rs
+++ b/src/api/x11/window.rs
@@ -219,6 +219,7 @@ impl<'a> Iterator for PollEventsIterator<'a> {
                     use events::Event::{MouseInput, MouseWheel};
                     use events::ElementState::{Pressed, Released};
                     use events::MouseButton::{Left, Right, Middle};
+                    use events::MouseScrollDelta::{LineDelta};
 
                     let event: &ffi::XButtonEvent = unsafe { mem::transmute(&xev) };
 
@@ -229,11 +230,13 @@ impl<'a> Iterator for PollEventsIterator<'a> {
                         ffi::Button2 => Some(Middle),
                         ffi::Button3 => Some(Right),
                         ffi::Button4 => {
-                            self.window.pending_events.lock().unwrap().push_back(MouseWheel(0.0, 1.0));
+                            let delta = LineDelta(0.0, 1.0);
+                            self.window.pending_events.lock().unwrap().push_back(MouseWheel(delta));
                             None
                         }
                         ffi::Button5 => {
-                            self.window.pending_events.lock().unwrap().push_back(MouseWheel(0.0, -1.0));
+                            let delta = LineDelta(0.0, -1.0);
+                            self.window.pending_events.lock().unwrap().push_back(MouseWheel(delta));
                             None
                         }
                         _ => None
diff --git a/src/events.rs b/src/events.rs
index 7962706..1103452 100644
--- a/src/events.rs
+++ b/src/events.rs
@@ -25,11 +25,11 @@ pub enum Event {
     /// The parameter are the (x,y) coords in pixels relative to the top-left corner of the window.
     MouseMoved((i32, i32)),
 
-    /// Returns the horizontal and vertical mouse scrolling.
+    /// A mouse wheel or touchpad scroll occurred. Depending on whether the 
     ///
     /// A positive value indicates that the wheel was rotated forward, away from the user;
     /// a negative value indicates that the wheel was rotated backward, toward the user.
-    MouseWheel(f64, f64),
+    MouseWheel(MouseScrollDelta),
 
     /// An event from the mouse has been received.
     MouseInput(ElementState, MouseButton),
@@ -57,6 +57,23 @@ pub enum MouseButton {
     Other(u8),
 }
 
+#[derive(Debug, Clone, Copy)]
+pub enum MouseScrollDelta {
+	/// Amount in lines or rows to scroll in the horizontal
+	/// and vertical directions.
+	///
+	/// Positive values indicate movement forward
+	/// (away from the user) or righwards.
+	LineDelta(f32, f32),
+	/// Amount in pixels to scroll in the horizontal and
+	/// vertical direction.
+	///
+	/// Scroll events are expressed as a PixelDelta if
+	/// supported by the device (eg. a touchpad) and
+	/// platform.
+	PixelDelta(f32, f32)
+}
+
 #[derive(Debug, Hash, PartialEq, Eq, Clone, Copy)]
 pub enum VirtualKeyCode {
     /// The '1' key over the letters.