smithay/src/backend/winit.rs

950 lines
32 KiB
Rust
Raw Normal View History

2017-05-21 20:40:15 +00:00
//! Implementation of backend traits for types provided by `winit`
2017-05-18 20:28:02 +00:00
use backend::graphics::GraphicsBackend;
2018-01-07 21:30:38 +00:00
use backend::graphics::egl::{EGLContext, EGLGraphicsBackend, EGLSurface, PixelFormat, SwapBuffersError};
use backend::graphics::egl::context::GlAttributes;
2017-12-21 15:01:16 +00:00
use backend::graphics::egl::error as egl_error;
use backend::graphics::egl::error::Result as EGLResult;
2017-12-21 15:01:16 +00:00
use backend::graphics::egl::native;
2018-01-07 21:30:38 +00:00
use backend::graphics::egl::wayland::{EGLDisplay, EGLWaylandExtensions};
2017-05-18 20:28:02 +00:00
use backend::input::{Axis, AxisSource, Event as BackendEvent, InputBackend, InputHandler, KeyState,
KeyboardKeyEvent, MouseButton, MouseButtonState, PointerAxisEvent, PointerButtonEvent,
PointerMotionAbsoluteEvent, Seat, SeatCapabilities, TouchCancelEvent, TouchDownEvent,
TouchMotionEvent, TouchSlot, TouchUpEvent, UnusedEvent};
use nix::libc::c_void;
2017-05-18 20:28:02 +00:00
use std::cmp;
2017-09-18 14:58:20 +00:00
use std::error;
2017-05-18 20:28:02 +00:00
use std::fmt;
use std::rc::Rc;
2017-12-21 15:01:16 +00:00
use wayland_client::egl as wegl;
use wayland_server::{Display, EventLoopHandle};
2018-01-07 21:30:38 +00:00
use winit::{ElementState, Event, EventsLoop, KeyboardInput, MouseButton as WinitMouseButton, MouseCursor,
MouseScrollDelta, Touch, TouchPhase, Window as WinitWindow, WindowBuilder, WindowEvent};
2017-09-18 14:58:20 +00:00
error_chain! {
errors {
#[doc = "Failed to initialize a window"]
InitFailed {
description("Failed to initialize a window")
}
2017-12-21 15:01:16 +00:00
#[doc = "Context creation is not supported on the current window system"]
NotSupported {
description("Context creation is not supported on the current window system.")
}
2017-09-18 14:58:20 +00:00
}
links {
2017-12-21 15:01:16 +00:00
EGL(egl_error::Error, egl_error::ErrorKind) #[doc = "EGL error"];
2017-09-18 14:58:20 +00:00
}
}
2017-12-21 15:01:16 +00:00
enum Window {
Wayland {
context: EGLContext<native::Wayland, WinitWindow>,
surface: EGLSurface<wegl::WlEglSurface>,
},
X11 {
context: EGLContext<native::X11, WinitWindow>,
surface: EGLSurface<native::XlibWindow>,
},
}
impl Window {
fn window(&self) -> &WinitWindow {
match self {
&Window::Wayland { ref context, .. } => &**context,
&Window::X11 { ref context, .. } => &**context,
}
2017-09-18 14:58:20 +00:00
}
}
2017-12-21 15:01:16 +00:00
2017-05-18 20:28:02 +00:00
/// Window with an active EGL Context created by `winit`. Implements the
/// `EGLGraphicsBackend` graphics backend trait
pub struct WinitGraphicsBackend {
window: Rc<Window>,
logger: ::slog::Logger,
2017-05-18 20:28:02 +00:00
}
/// Abstracted event loop of a `winit` `Window` implementing the `InputBackend` trait
///
2017-05-21 20:40:15 +00:00
/// You need to call `dispatch_new_events` periodically to receive any events.
2017-05-18 20:28:02 +00:00
pub struct WinitInputBackend {
events_loop: EventsLoop,
2018-01-11 01:01:22 +00:00
events_handler: Option<Box<WinitEventsHandler>>,
2017-05-18 20:28:02 +00:00
window: Rc<Window>,
time_counter: u32,
key_counter: u32,
seat: Seat,
input_config: (),
handler: Option<Box<InputHandler<WinitInputBackend> + 'static>>,
logger: ::slog::Logger,
2017-05-18 20:28:02 +00:00
}
/// Create a new `WinitGraphicsBackend`, which implements the `EGLGraphicsBackend`
2017-05-21 20:40:15 +00:00
/// graphics backend trait and a corresponding `WinitInputBackend`, which implements
/// the `InputBackend` trait
2017-09-18 14:58:20 +00:00
pub fn init<L>(logger: L) -> Result<(WinitGraphicsBackend, WinitInputBackend)>
2017-06-20 09:31:18 +00:00
where
L: Into<Option<::slog::Logger>>,
{
2017-06-20 09:31:18 +00:00
init_from_builder(
WindowBuilder::new()
.with_dimensions(1280, 800)
.with_title("Smithay")
.with_visibility(true),
logger,
)
2017-05-18 20:28:02 +00:00
}
2017-05-21 20:40:15 +00:00
/// Create a new `WinitGraphicsBackend`, which implements the `EGLGraphicsBackend`
/// graphics backend trait, from a given `WindowBuilder` struct and a corresponding
/// `WinitInputBackend`, which implements the `InputBackend` trait
2017-12-15 17:38:10 +00:00
pub fn init_from_builder<L>(
builder: WindowBuilder, logger: L
) -> Result<(WinitGraphicsBackend, WinitInputBackend)>
2017-06-20 09:31:18 +00:00
where
L: Into<Option<::slog::Logger>>,
{
2017-06-20 09:31:18 +00:00
init_from_builder_with_gl_attr(
builder,
GlAttributes {
version: None,
profile: None,
debug: cfg!(debug_assertions),
vsync: true,
},
logger,
)
2017-05-18 20:28:02 +00:00
}
/// Create a new `WinitGraphicsBackend`, which implements the `EGLGraphicsBackend`
2017-05-21 20:40:15 +00:00
/// graphics backend trait, from a given `WindowBuilder` struct, as well as given
/// `GlAttributes` for further customization of the rendering pipeline and a
/// corresponding `WinitInputBackend`, which implements the `InputBackend` trait.
2017-12-15 17:38:10 +00:00
pub fn init_from_builder_with_gl_attr<L>(
builder: WindowBuilder, attributes: GlAttributes, logger: L
) -> Result<(WinitGraphicsBackend, WinitInputBackend)>
2017-06-20 09:31:18 +00:00
where
L: Into<Option<::slog::Logger>>,
{
let log = ::slog_or_stdlog(logger).new(o!("smithay_module" => "backend_winit"));
info!(log, "Initializing a winit backend");
2017-05-18 20:28:02 +00:00
let events_loop = EventsLoop::new();
2017-09-18 14:58:20 +00:00
let winit_window = builder
.build(&events_loop)
.chain_err(|| ErrorKind::InitFailed)?;
debug!(log, "Window created");
2017-05-18 20:28:02 +00:00
2017-12-28 14:28:15 +00:00
let reqs = Default::default();
2017-12-21 15:01:16 +00:00
let window = Rc::new(
if native::NativeDisplay::<native::Wayland>::is_backend(&winit_window) {
2018-01-07 21:30:38 +00:00
let context =
EGLContext::<native::Wayland, WinitWindow>::new(winit_window, attributes, reqs, log.clone())?;
2017-12-21 15:01:16 +00:00
let surface = context.create_surface(())?;
2018-01-07 21:30:38 +00:00
Window::Wayland { context, surface }
2017-12-21 15:01:16 +00:00
} else if native::NativeDisplay::<native::X11>::is_backend(&winit_window) {
2018-01-07 21:30:38 +00:00
let context =
EGLContext::<native::X11, WinitWindow>::new(winit_window, attributes, reqs, log.clone())?;
2017-12-21 15:01:16 +00:00
let surface = context.create_surface(())?;
2018-01-07 21:30:38 +00:00
Window::X11 { context, surface }
2017-12-21 15:01:16 +00:00
} else {
bail!(ErrorKind::NotSupported);
2018-01-07 21:30:38 +00:00
},
2017-12-21 15:01:16 +00:00
);
2017-05-18 20:28:02 +00:00
2017-06-20 09:31:18 +00:00
Ok((
WinitGraphicsBackend {
2017-05-21 20:40:15 +00:00
window: window.clone(),
logger: log.new(o!("smithay_winit_component" => "graphics")),
2017-05-21 20:40:15 +00:00
},
WinitInputBackend {
events_loop,
2018-01-11 01:01:22 +00:00
events_handler: None,
window,
2017-05-21 20:40:15 +00:00
time_counter: 0,
key_counter: 0,
2017-06-20 09:31:18 +00:00
seat: Seat::new(
0,
2018-01-16 15:27:56 +00:00
"winit",
2017-06-20 09:31:18 +00:00
SeatCapabilities {
pointer: true,
keyboard: true,
touch: true,
},
),
2017-05-21 20:40:15 +00:00
input_config: (),
handler: None,
logger: log.new(o!("smithay_winit_component" => "input")),
2017-06-20 09:31:18 +00:00
},
))
2017-05-18 20:28:02 +00:00
}
2018-01-11 01:01:22 +00:00
/// Handler trait to recieve window-related events to provide a better *nested* experience.
pub trait WinitEventsHandler {
/// The window was resized, can be used to adjust the associated `wayland::output::Output`s mode.
fn resized(&mut self, evlh: &mut EventLoopHandle, width: u32, height: u32);
/// The window was moved
fn moved(&mut self, evlh: &mut EventLoopHandle, x: i32, h: i32);
/// The window gained or lost focus
fn focus_changed(&mut self, evlh: &mut EventLoopHandle, focused: bool);
/// The window needs to be redrawn
fn refresh(&mut self, evlh: &mut EventLoopHandle);
/// The window's hidpi factor changed
fn hidpi_changed(&mut self, evlh: &mut EventLoopHandle, scale: f32);
}
2018-01-11 00:45:38 +00:00
impl WinitGraphicsBackend {
/// Get a reference to the internally used `winit::Window`
pub fn winit_window(&self) -> &WinitWindow {
self.window.window()
}
}
2017-05-18 20:28:02 +00:00
impl GraphicsBackend for WinitGraphicsBackend {
type CursorFormat = MouseCursor;
type Error = ();
2017-05-18 20:28:02 +00:00
2017-09-18 14:58:20 +00:00
fn set_cursor_position(&self, x: u32, y: u32) -> ::std::result::Result<(), ()> {
debug!(self.logger, "Setting cursor position to {:?}", (x, y));
2017-12-21 15:01:16 +00:00
self.window.window().set_cursor_position(x as i32, y as i32)
2017-05-18 20:28:02 +00:00
}
2017-12-15 17:38:10 +00:00
fn set_cursor_representation(
&self, cursor: &Self::CursorFormat, _hotspot: (u32, u32)
) -> ::std::result::Result<(), ()> {
2017-06-04 21:13:19 +00:00
// Cannot log this one, as `CursorFormat` is not `Debug` and should not be
debug!(self.logger, "Changing cursor representation");
2017-12-21 15:01:16 +00:00
self.window.window().set_cursor(*cursor);
Ok(())
2017-05-18 20:28:02 +00:00
}
}
impl EGLGraphicsBackend for WinitGraphicsBackend {
2017-09-18 14:58:20 +00:00
fn swap_buffers(&self) -> ::std::result::Result<(), SwapBuffersError> {
trace!(self.logger, "Swapping buffers");
2017-12-21 15:01:16 +00:00
match *self.window {
Window::Wayland { ref surface, .. } => surface.swap_buffers(),
Window::X11 { ref surface, .. } => surface.swap_buffers(),
}
2017-05-18 20:28:02 +00:00
}
unsafe fn get_proc_address(&self, symbol: &str) -> *const c_void {
trace!(self.logger, "Getting symbol for {:?}", symbol);
2017-12-21 15:01:16 +00:00
match *self.window {
Window::Wayland { ref context, .. } => context.get_proc_address(symbol),
Window::X11 { ref context, .. } => context.get_proc_address(symbol),
}
2017-05-18 20:28:02 +00:00
}
fn get_framebuffer_dimensions(&self) -> (u32, u32) {
2017-09-05 17:51:05 +00:00
self.window
2017-12-21 15:01:16 +00:00
.window()
.get_inner_size()
2017-09-05 17:51:05 +00:00
.expect("Window does not exist anymore")
2017-05-18 20:28:02 +00:00
}
fn is_current(&self) -> bool {
2017-12-21 15:01:16 +00:00
match *self.window {
2018-01-07 21:30:38 +00:00
Window::Wayland {
ref context,
ref surface,
} => context.is_current() && surface.is_current(),
Window::X11 {
ref context,
ref surface,
} => context.is_current() && surface.is_current(),
2017-12-21 15:01:16 +00:00
}
2017-05-18 20:28:02 +00:00
}
2017-09-18 14:58:20 +00:00
unsafe fn make_current(&self) -> ::std::result::Result<(), SwapBuffersError> {
2017-12-21 15:01:16 +00:00
trace!(self.logger, "Setting EGL context to be the current context");
match *self.window {
Window::Wayland { ref surface, .. } => surface.make_current(),
Window::X11 { ref surface, .. } => surface.make_current(),
}
2017-05-18 20:28:02 +00:00
}
fn get_pixel_format(&self) -> PixelFormat {
2017-12-21 15:01:16 +00:00
match *self.window {
Window::Wayland { ref context, .. } => context.get_pixel_format(),
Window::X11 { ref context, .. } => context.get_pixel_format(),
}
}
}
2017-12-21 15:01:16 +00:00
impl EGLWaylandExtensions for WinitGraphicsBackend {
fn bind_wl_display(&self, display: &Display) -> EGLResult<EGLDisplay> {
2017-12-21 15:01:16 +00:00
match *self.window {
Window::Wayland { ref context, .. } => context.bind_wl_display(display),
Window::X11 { ref context, .. } => context.bind_wl_display(display),
}
2017-12-21 15:01:16 +00:00
}
2017-05-18 20:28:02 +00:00
}
/// Errors that may happen when driving the event loop of `WinitInputBackend`
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum WinitInputError {
/// The underlying `winit` `Window` was closed. No further events can be processed.
///
2017-05-21 20:40:15 +00:00
/// See `WinitInputBackend::dispatch_new_events`.
2017-05-18 20:28:02 +00:00
WindowClosed,
}
2017-09-18 14:58:20 +00:00
impl error::Error for WinitInputError {
2017-05-18 20:28:02 +00:00
fn description(&self) -> &str {
match *self {
WinitInputError::WindowClosed => "Glutin Window was closed",
}
}
}
impl fmt::Display for WinitInputError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2017-09-18 14:58:20 +00:00
use std::error::Error;
2017-05-18 20:28:02 +00:00
write!(f, "{}", self.description())
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
/// Winit-Backend internal event wrapping winit's types into a `KeyboardKeyEvent`
pub struct WinitKeyboardInputEvent {
time: u32,
2017-06-02 11:15:31 +00:00
key: u32,
2017-05-18 20:28:02 +00:00
count: u32,
state: ElementState,
}
impl BackendEvent for WinitKeyboardInputEvent {
fn time(&self) -> u32 {
self.time
}
}
impl KeyboardKeyEvent for WinitKeyboardInputEvent {
fn key_code(&self) -> u32 {
2017-06-02 11:15:31 +00:00
self.key
2017-05-18 20:28:02 +00:00
}
fn state(&self) -> KeyState {
self.state.into()
}
fn count(&self) -> u32 {
self.count
}
}
#[derive(Clone)]
/// Winit-Backend internal event wrapping winit's types into a `PointerMotionAbsoluteEvent`
pub struct WinitMouseMovedEvent {
window: Rc<Window>,
time: u32,
2017-06-02 11:15:31 +00:00
x: f64,
y: f64,
2017-05-18 20:28:02 +00:00
}
impl BackendEvent for WinitMouseMovedEvent {
fn time(&self) -> u32 {
self.time
}
}
impl PointerMotionAbsoluteEvent for WinitMouseMovedEvent {
fn x(&self) -> f64 {
2017-06-02 11:15:31 +00:00
self.x
2017-05-18 20:28:02 +00:00
}
fn y(&self) -> f64 {
2017-06-02 11:15:31 +00:00
self.y
2017-05-18 20:28:02 +00:00
}
fn x_transformed(&self, width: u32) -> u32 {
2017-06-20 09:31:18 +00:00
cmp::min(
2017-09-21 18:50:10 +00:00
(self.x * width as f64
/ self.window
2017-12-21 15:01:16 +00:00
.window()
.get_inner_size()
.unwrap_or((width, 0))
.0 as f64) as u32,
2017-06-20 09:31:18 +00:00
0,
)
2017-05-18 20:28:02 +00:00
}
fn y_transformed(&self, height: u32) -> u32 {
2017-06-20 09:31:18 +00:00
cmp::min(
2017-09-21 18:50:10 +00:00
(self.y * height as f64
/ self.window
2017-12-21 15:01:16 +00:00
.window()
.get_inner_size()
.unwrap_or((0, height))
.1 as f64) as u32,
2017-06-20 09:31:18 +00:00
0,
)
2017-05-18 20:28:02 +00:00
}
}
#[derive(Debug, Clone, Copy, PartialEq)]
/// Winit-Backend internal event wrapping winit's types into a `PointerAxisEvent`
pub struct WinitMouseWheelEvent {
axis: Axis,
time: u32,
delta: MouseScrollDelta,
}
impl BackendEvent for WinitMouseWheelEvent {
fn time(&self) -> u32 {
self.time
}
}
impl PointerAxisEvent for WinitMouseWheelEvent {
fn axis(&self) -> Axis {
self.axis
}
fn source(&self) -> AxisSource {
match self.delta {
MouseScrollDelta::LineDelta(_, _) => AxisSource::Wheel,
MouseScrollDelta::PixelDelta(_, _) => AxisSource::Continuous,
}
}
fn amount(&self) -> f64 {
match (self.axis, self.delta) {
2017-12-15 17:38:10 +00:00
(Axis::Horizontal, MouseScrollDelta::LineDelta(x, _))
| (Axis::Horizontal, MouseScrollDelta::PixelDelta(x, _)) => x as f64,
(Axis::Vertical, MouseScrollDelta::LineDelta(_, y))
| (Axis::Vertical, MouseScrollDelta::PixelDelta(_, y)) => y as f64,
2017-05-18 20:28:02 +00:00
}
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
/// Winit-Backend internal event wrapping winit's types into a `PointerButtonEvent`
pub struct WinitMouseInputEvent {
time: u32,
button: WinitMouseButton,
state: ElementState,
}
impl BackendEvent for WinitMouseInputEvent {
fn time(&self) -> u32 {
self.time
}
}
impl PointerButtonEvent for WinitMouseInputEvent {
fn button(&self) -> MouseButton {
self.button.into()
}
fn state(&self) -> MouseButtonState {
self.state.into()
}
}
#[derive(Clone)]
/// Winit-Backend internal event wrapping winit's types into a `TouchDownEvent`
pub struct WinitTouchStartedEvent {
window: Rc<Window>,
time: u32,
location: (f64, f64),
id: u64,
}
impl BackendEvent for WinitTouchStartedEvent {
fn time(&self) -> u32 {
self.time
}
}
impl TouchDownEvent for WinitTouchStartedEvent {
fn slot(&self) -> Option<TouchSlot> {
Some(TouchSlot::new(self.id))
}
fn x(&self) -> f64 {
self.location.0
}
fn y(&self) -> f64 {
self.location.1
}
fn x_transformed(&self, width: u32) -> u32 {
2017-06-20 09:31:18 +00:00
cmp::min(
2017-09-21 18:50:10 +00:00
self.location.0 as i32 * width as i32
/ self.window
2017-12-21 15:01:16 +00:00
.window()
.get_inner_size()
.unwrap_or((width, 0))
.0 as i32,
2017-06-20 09:31:18 +00:00
0,
) as u32
2017-05-18 20:28:02 +00:00
}
fn y_transformed(&self, height: u32) -> u32 {
2017-06-20 09:31:18 +00:00
cmp::min(
2017-09-21 18:50:10 +00:00
self.location.1 as i32 * height as i32
/ self.window
2017-12-21 15:01:16 +00:00
.window()
.get_inner_size()
.unwrap_or((0, height))
.1 as i32,
2017-06-20 09:31:18 +00:00
0,
) as u32
2017-05-18 20:28:02 +00:00
}
}
#[derive(Clone)]
/// Winit-Backend internal event wrapping winit's types into a `TouchMotionEvent`
pub struct WinitTouchMovedEvent {
window: Rc<Window>,
time: u32,
location: (f64, f64),
id: u64,
}
impl BackendEvent for WinitTouchMovedEvent {
fn time(&self) -> u32 {
self.time
}
}
impl TouchMotionEvent for WinitTouchMovedEvent {
fn slot(&self) -> Option<TouchSlot> {
Some(TouchSlot::new(self.id))
}
fn x(&self) -> f64 {
self.location.0
}
fn y(&self) -> f64 {
self.location.1
}
fn x_transformed(&self, width: u32) -> u32 {
2017-09-21 18:50:10 +00:00
self.location.0 as u32 * width
/ self.window
2017-12-21 15:01:16 +00:00
.window()
.get_inner_size()
.unwrap_or((width, 0))
.0
2017-05-18 20:28:02 +00:00
}
fn y_transformed(&self, height: u32) -> u32 {
2017-09-21 18:50:10 +00:00
self.location.1 as u32 * height
/ self.window
2017-12-21 15:01:16 +00:00
.window()
.get_inner_size()
.unwrap_or((0, height))
.1
2017-05-18 20:28:02 +00:00
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
/// Winit-Backend internal event wrapping winit's types into a `TouchUpEvent`
pub struct WinitTouchEndedEvent {
time: u32,
id: u64,
}
impl BackendEvent for WinitTouchEndedEvent {
fn time(&self) -> u32 {
self.time
}
}
impl TouchUpEvent for WinitTouchEndedEvent {
fn slot(&self) -> Option<TouchSlot> {
Some(TouchSlot::new(self.id))
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
/// Winit-Backend internal event wrapping winit's types into a `TouchCancelEvent`
pub struct WinitTouchCancelledEvent {
time: u32,
id: u64,
}
impl BackendEvent for WinitTouchCancelledEvent {
fn time(&self) -> u32 {
self.time
}
}
impl TouchCancelEvent for WinitTouchCancelledEvent {
fn slot(&self) -> Option<TouchSlot> {
Some(TouchSlot::new(self.id))
}
}
2018-01-11 01:01:22 +00:00
impl WinitInputBackend {
/// Set the events handler
pub fn set_events_handler<H: WinitEventsHandler + 'static>(&mut self, handler: H) {
self.events_handler = Some(Box::new(handler));
info!(self.logger, "New events handler set.");
}
/// Get a reference to the set events handler, if any
pub fn get_events_handler(&mut self) -> Option<&mut WinitEventsHandler> {
self.events_handler
.as_mut()
.map(|handler| &mut **handler as &mut WinitEventsHandler)
}
/// Clear out the currently set events handler
pub fn clear_events_handler(&mut self) {
self.events_handler = None;
info!(self.logger, "Events handler unset.");
}
}
2017-05-18 20:28:02 +00:00
impl InputBackend for WinitInputBackend {
type InputConfig = ();
type EventError = WinitInputError;
type KeyboardKeyEvent = WinitKeyboardInputEvent;
type PointerAxisEvent = WinitMouseWheelEvent;
type PointerButtonEvent = WinitMouseInputEvent;
type PointerMotionEvent = UnusedEvent;
type PointerMotionAbsoluteEvent = WinitMouseMovedEvent;
type TouchDownEvent = WinitTouchStartedEvent;
type TouchUpEvent = WinitTouchEndedEvent;
type TouchMotionEvent = WinitTouchMovedEvent;
type TouchCancelEvent = WinitTouchCancelledEvent;
type TouchFrameEvent = UnusedEvent;
fn set_handler<H: InputHandler<Self> + 'static>(&mut self, evlh: &mut EventLoopHandle, mut handler: H) {
2017-05-18 20:28:02 +00:00
if self.handler.is_some() {
self.clear_handler(evlh);
2017-05-18 20:28:02 +00:00
}
info!(self.logger, "New input handler set.");
trace!(self.logger, "Calling on_seat_created with {:?}", self.seat);
handler.on_seat_created(evlh, &self.seat);
2017-05-18 20:28:02 +00:00
self.handler = Some(Box::new(handler));
}
fn get_handler(&mut self) -> Option<&mut InputHandler<Self>> {
2017-09-05 17:51:05 +00:00
self.handler
.as_mut()
.map(|handler| handler as &mut InputHandler<Self>)
2017-05-18 20:28:02 +00:00
}
fn clear_handler(&mut self, evlh: &mut EventLoopHandle) {
2017-05-18 20:28:02 +00:00
if let Some(mut handler) = self.handler.take() {
2017-06-20 09:31:18 +00:00
trace!(
self.logger,
"Calling on_seat_destroyed with {:?}",
self.seat
);
handler.on_seat_destroyed(evlh, &self.seat);
2017-05-18 20:28:02 +00:00
}
info!(self.logger, "Removing input handler");
2017-05-18 20:28:02 +00:00
}
fn input_config(&mut self) -> &mut Self::InputConfig {
&mut self.input_config
}
/// Processes new events of the underlying event loop to drive the set `InputHandler`.
///
/// You need to periodically call this function to keep the underlying event loop and
/// `Window` active. Otherwise the window may no respond to user interaction and no
/// input events will be received by a set `InputHandler`.
///
/// Returns an error if the `Window` the window has been closed. Calling
2017-05-21 20:40:15 +00:00
/// `dispatch_new_events` again after the `Window` has been closed is considered an
2017-05-18 20:28:02 +00:00
/// application error and unspecified baviour may occur.
///
/// The linked `WinitGraphicsBackend` will error with a lost Context and should
/// not be used anymore as well.
fn dispatch_new_events(
&mut self, evlh: &mut EventLoopHandle
) -> ::std::result::Result<(), WinitInputError> {
2017-05-18 20:28:02 +00:00
let mut closed = false;
{
// NOTE: This ugly pile of references is here, because rustc could not
// figure out how to reference all these objects correctly into the
// upcoming closure, which is why all are borrowed manually and the
// assignments are then moved into the closure to avoid rustc's
// wrong interference.
2017-05-18 20:28:02 +00:00
let mut closed_ptr = &mut closed;
let mut key_counter = &mut self.key_counter;
let mut time_counter = &mut self.time_counter;
let seat = &self.seat;
let window = &self.window;
let mut handler = self.handler.as_mut();
2018-01-11 01:01:22 +00:00
let mut events_handler = self.events_handler.as_mut();
let logger = &self.logger;
2017-05-18 20:28:02 +00:00
2017-10-05 20:13:14 +00:00
self.events_loop.poll_events(move |event| {
if let Event::WindowEvent { event, .. } = event {
2018-01-11 01:01:22 +00:00
match (event, handler.as_mut(), events_handler.as_mut()) {
(WindowEvent::Resized(w, h), _, events_handler) => {
trace!(logger, "Resizing window to {:?}", (w, h));
window.window().set_inner_size(w, h);
2017-12-21 15:01:16 +00:00
match **window {
2018-01-07 21:30:38 +00:00
Window::Wayland { ref surface, .. } => {
2018-01-11 01:01:22 +00:00
surface.resize(w as i32, h as i32, 0, 0)
2018-01-07 21:30:38 +00:00
}
_ => {}
2017-12-21 15:01:16 +00:00
};
2018-01-11 01:01:22 +00:00
if let Some(events_handler) = events_handler {
events_handler.resized(evlh, w, h);
}
}
(WindowEvent::Moved(x, y), _, Some(events_handler)) => {
events_handler.moved(evlh, x, y)
}
(WindowEvent::Focused(focus), _, Some(events_handler)) => {
events_handler.focus_changed(evlh, focus)
}
(WindowEvent::Refresh, _, Some(events_handler)) => events_handler.refresh(evlh),
(WindowEvent::HiDPIFactorChanged(factor), _, Some(events_handler)) => {
events_handler.hidpi_changed(evlh, factor)
2017-06-04 21:13:19 +00:00
}
2017-09-05 17:51:05 +00:00
(
WindowEvent::KeyboardInput {
2017-09-21 18:50:10 +00:00
input:
KeyboardInput {
scancode, state, ..
},
2017-09-05 17:51:05 +00:00
..
},
Some(handler),
2018-01-11 01:01:22 +00:00
_,
2017-09-05 17:51:05 +00:00
) => {
2017-06-20 09:31:18 +00:00
match state {
ElementState::Pressed => *key_counter += 1,
ElementState::Released => {
*key_counter = key_counter.checked_sub(1).unwrap_or(0)
}
2017-06-04 21:13:19 +00:00
};
2017-06-20 09:31:18 +00:00
trace!(
logger,
"Calling on_keyboard_key with {:?}",
(scancode, state)
);
handler.on_keyboard_key(
evlh,
2017-06-20 09:31:18 +00:00
seat,
WinitKeyboardInputEvent {
time: *time_counter,
key: scancode,
count: *key_counter,
state: state,
},
)
}
2017-09-05 17:51:05 +00:00
(
2017-12-21 15:01:16 +00:00
WindowEvent::CursorMoved {
2017-09-05 17:51:05 +00:00
position: (x, y), ..
},
Some(handler),
2018-01-11 01:01:22 +00:00
_,
2017-09-05 17:51:05 +00:00
) => {
2017-06-20 09:31:18 +00:00
trace!(logger, "Calling on_pointer_move_absolute with {:?}", (x, y));
handler.on_pointer_move_absolute(
evlh,
2017-06-20 09:31:18 +00:00
seat,
WinitMouseMovedEvent {
window: window.clone(),
time: *time_counter,
x: x,
y: y,
},
)
}
2018-01-11 01:01:22 +00:00
(WindowEvent::MouseWheel { delta, .. }, Some(handler), _) => match delta {
2017-09-05 17:51:05 +00:00
MouseScrollDelta::LineDelta(x, y) | MouseScrollDelta::PixelDelta(x, y) => {
if x != 0.0 {
let event = WinitMouseWheelEvent {
axis: Axis::Horizontal,
time: *time_counter,
delta: delta,
};
trace!(
logger,
"Calling on_pointer_axis for Axis::Horizontal with {:?}",
x
);
handler.on_pointer_axis(evlh, seat, event);
2017-09-05 17:51:05 +00:00
}
if y != 0.0 {
let event = WinitMouseWheelEvent {
axis: Axis::Vertical,
time: *time_counter,
delta: delta,
};
trace!(
logger,
"Calling on_pointer_axis for Axis::Vertical with {:?}",
y
);
handler.on_pointer_axis(evlh, seat, event);
2017-06-20 09:31:18 +00:00
}
}
2017-09-05 17:51:05 +00:00
},
2018-01-11 01:01:22 +00:00
(WindowEvent::MouseInput { state, button, .. }, Some(handler), _) => {
2017-06-20 09:31:18 +00:00
trace!(
logger,
"Calling on_pointer_button with {:?}",
(button, state)
);
handler.on_pointer_button(
evlh,
2017-06-20 09:31:18 +00:00
seat,
WinitMouseInputEvent {
time: *time_counter,
button: button,
state: state,
},
)
}
2017-09-05 17:51:05 +00:00
(
WindowEvent::Touch(Touch {
phase: TouchPhase::Started,
location: (x, y),
id,
..
}),
Some(handler),
2018-01-11 01:01:22 +00:00
_,
2017-09-05 17:51:05 +00:00
) => {
2017-06-20 09:31:18 +00:00
trace!(logger, "Calling on_touch_down at {:?}", (x, y));
handler.on_touch_down(
evlh,
2017-06-20 09:31:18 +00:00
seat,
WinitTouchStartedEvent {
window: window.clone(),
time: *time_counter,
location: (x, y),
id: id,
},
)
}
2017-09-05 17:51:05 +00:00
(
WindowEvent::Touch(Touch {
phase: TouchPhase::Moved,
location: (x, y),
id,
..
}),
Some(handler),
2018-01-11 01:01:22 +00:00
_,
2017-09-05 17:51:05 +00:00
) => {
2017-06-20 09:31:18 +00:00
trace!(logger, "Calling on_touch_motion at {:?}", (x, y));
handler.on_touch_motion(
evlh,
2017-06-20 09:31:18 +00:00
seat,
WinitTouchMovedEvent {
window: window.clone(),
time: *time_counter,
location: (x, y),
id: id,
},
)
}
2017-09-05 17:51:05 +00:00
(
WindowEvent::Touch(Touch {
phase: TouchPhase::Ended,
location: (x, y),
id,
..
}),
Some(handler),
2018-01-11 01:01:22 +00:00
_,
2017-09-05 17:51:05 +00:00
) => {
2017-06-20 09:31:18 +00:00
trace!(logger, "Calling on_touch_motion at {:?}", (x, y));
handler.on_touch_motion(
evlh,
2017-06-20 09:31:18 +00:00
seat,
WinitTouchMovedEvent {
window: window.clone(),
time: *time_counter,
location: (x, y),
id: id,
},
);
trace!(logger, "Calling on_touch_up");
handler.on_touch_up(
evlh,
2017-06-20 09:31:18 +00:00
seat,
WinitTouchEndedEvent {
time: *time_counter,
id: id,
},
);
}
2017-09-05 17:51:05 +00:00
(
WindowEvent::Touch(Touch {
phase: TouchPhase::Cancelled,
id,
..
}),
Some(handler),
2018-01-11 01:01:22 +00:00
_,
2017-09-05 17:51:05 +00:00
) => {
2017-06-20 09:31:18 +00:00
trace!(logger, "Calling on_touch_cancel");
handler.on_touch_cancel(
evlh,
2017-06-20 09:31:18 +00:00
seat,
WinitTouchCancelledEvent {
time: *time_counter,
id: id,
},
)
}
2018-01-11 01:01:22 +00:00
(WindowEvent::Closed, _, _) => {
2017-06-20 09:31:18 +00:00
warn!(logger, "Window closed");
*closed_ptr = true;
2017-06-04 21:13:19 +00:00
}
2017-06-20 09:31:18 +00:00
_ => {}
}
*time_counter += 1;
}
});
2017-05-18 20:28:02 +00:00
}
if closed {
Err(WinitInputError::WindowClosed)
} else {
Ok(())
}
}
}
impl From<WinitMouseButton> for MouseButton {
fn from(button: WinitMouseButton) -> MouseButton {
match button {
WinitMouseButton::Left => MouseButton::Left,
WinitMouseButton::Right => MouseButton::Right,
WinitMouseButton::Middle => MouseButton::Middle,
WinitMouseButton::Other(num) => MouseButton::Other(num),
}
}
}
impl From<ElementState> for KeyState {
fn from(state: ElementState) -> Self {
match state {
ElementState::Pressed => KeyState::Pressed,
ElementState::Released => KeyState::Released,
}
}
}
impl From<ElementState> for MouseButtonState {
fn from(state: ElementState) -> Self {
match state {
ElementState::Pressed => MouseButtonState::Pressed,
ElementState::Released => MouseButtonState::Released,
}
}
}