smithay/src/backend/winit.rs

898 lines
31 KiB
Rust
Raw Normal View History

2017-05-21 20:40:15 +00:00
//! Implementation of backend traits for types provided by `winit`
2020-04-15 11:01:01 +00:00
use crate::backend::egl::display::EGLDisplay;
use crate::backend::egl::get_proc_address;
2018-12-15 20:32:28 +00:00
use crate::backend::{
2020-04-29 22:24:35 +00:00
egl::{context::GlAttributes, native, EGLContext, EGLSurface, Error as EGLError, SurfaceCreationError},
graphics::{gl::GLGraphicsBackend, CursorBackend, PixelFormat, SwapBuffersError},
2018-10-04 22:37:43 +00:00
input::{
Axis, AxisSource, Event as BackendEvent, InputBackend, InputEvent, KeyState, KeyboardKeyEvent,
2018-10-04 22:37:43 +00:00
MouseButton, MouseButtonState, PointerAxisEvent, PointerButtonEvent, PointerMotionAbsoluteEvent,
Seat, SeatCapabilities, TouchCancelEvent, TouchDownEvent, TouchMotionEvent, TouchSlot, TouchUpEvent,
UnusedEvent,
},
2018-09-24 22:32:09 +00:00
};
use nix::libc::c_void;
use std::{
cell::{Ref, RefCell},
2020-04-29 22:24:35 +00:00
convert::TryInto,
fmt,
rc::Rc,
time::Instant,
};
use wayland_egl as wegl;
use wayland_server::Display;
2018-09-24 22:32:09 +00:00
use winit::{
dpi::{LogicalPosition, LogicalSize, PhysicalSize},
event::{
2020-04-10 15:01:49 +00:00
ElementState, Event, KeyboardInput, MouseButton as WinitMouseButton, MouseScrollDelta, Touch,
TouchPhase, WindowEvent,
},
event_loop::{ControlFlow, EventLoop},
2021-02-22 19:27:46 +00:00
platform::run_return::EventLoopExtRunReturn,
window::{CursorIcon, Window as WinitWindow, WindowBuilder},
2018-09-24 22:32:09 +00:00
};
2020-04-15 11:01:01 +00:00
#[cfg(feature = "use_system_lib")]
use crate::backend::egl::{display::EGLBufferReader, EGLGraphicsBackend};
2020-04-15 11:01:01 +00:00
/// Errors thrown by the `winit` backends
#[derive(thiserror::Error, Debug)]
pub enum Error {
/// Failed to initialize a window
#[error("Failed to initialize a window")]
InitFailed(#[from] winit::error::OsError),
/// Context creation is not supported on the current window system
#[error("Context creation is not supported on the current window system")]
NotSupported,
/// EGL error
#[error("EGL error: {0}")]
EGL(#[from] EGLError),
2020-04-29 22:24:35 +00:00
/// Surface Creation failed
#[error("Surface creation failed: {0}")]
2020-04-30 17:03:02 +00:00
SurfaceCreationError(#[from] SurfaceCreationError<EGLError>),
2017-09-18 14:58:20 +00:00
}
2017-12-21 15:01:16 +00:00
enum Window {
Wayland {
2020-04-15 11:01:01 +00:00
display: EGLDisplay<native::Wayland, WinitWindow>,
context: EGLContext,
2017-12-21 15:01:16 +00:00
surface: EGLSurface<wegl::WlEglSurface>,
},
X11 {
2020-04-15 11:01:01 +00:00
display: EGLDisplay<native::X11, WinitWindow>,
context: EGLContext,
2017-12-21 15:01:16 +00:00
surface: EGLSurface<native::XlibWindow>,
},
}
impl fmt::Debug for Window {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Window::Wayland { .. } => f.debug_tuple("Window::Wayland"),
Window::X11 { .. } => f.debug_tuple("Window::X11"),
}
.finish()
}
}
2017-12-21 15:01:16 +00:00
impl Window {
2018-12-15 20:58:43 +00:00
fn window(&self) -> Ref<'_, WinitWindow> {
2018-06-28 09:33:49 +00:00
match *self {
2020-04-15 11:01:01 +00:00
Window::Wayland { ref display, .. } => display.borrow(),
Window::X11 { ref display, .. } => display.borrow(),
2017-12-21 15:01:16 +00:00
}
2017-09-18 14:58:20 +00:00
}
}
2017-12-21 15:01:16 +00:00
#[derive(Debug)]
struct WindowSize {
physical_size: PhysicalSize<u32>,
scale_factor: f64,
}
2017-05-18 20:28:02 +00:00
/// Window with an active EGL Context created by `winit`. Implements the
/// [`EGLGraphicsBackend`] and [`GLGraphicsBackend`] graphics backend trait
#[derive(Debug)]
2017-05-18 20:28:02 +00:00
pub struct WinitGraphicsBackend {
window: Rc<Window>,
size: Rc<RefCell<WindowSize>>,
logger: ::slog::Logger,
2017-05-18 20:28:02 +00:00
}
/// Abstracted event loop of a [`WinitWindow`] implementing the [`InputBackend`] trait
2017-05-18 20:28:02 +00:00
///
/// You need to call [`dispatch_new_events`](InputBackend::dispatch_new_events)
/// periodically to receive any events.
#[derive(Debug)]
2017-05-18 20:28:02 +00:00
pub struct WinitInputBackend {
events_loop: EventLoop<()>,
2017-05-18 20:28:02 +00:00
window: Rc<Window>,
time: Instant,
2017-05-18 20:28:02 +00:00
key_counter: u32,
seat: Seat,
logger: ::slog::Logger,
size: Rc<RefCell<WindowSize>>,
2017-05-18 20:28:02 +00:00
}
/// Create a new [`WinitGraphicsBackend`], which implements the [`EGLGraphicsBackend`]
/// and [`GLGraphicsBackend`] graphics backend trait and a corresponding [`WinitInputBackend`],
/// which implements the [`InputBackend`] trait
pub fn init<L>(logger: L) -> Result<(WinitGraphicsBackend, WinitInputBackend), Error>
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_inner_size(LogicalSize::new(1280.0, 800.0))
2017-06-20 09:31:18 +00:00
.with_title("Smithay")
.with_visible(true),
2017-06-20 09:31:18 +00:00
logger,
)
2017-05-18 20:28:02 +00:00
}
/// Create a new [`WinitGraphicsBackend`], which implements the [`EGLGraphicsBackend`]
/// and [`GLGraphicsBackend`] 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), Error>
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`]
/// and [`GLGraphicsBackend`] 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), Error>
2017-06-20 09:31:18 +00:00
where
L: Into<Option<::slog::Logger>>,
{
let log = crate::slog_or_fallback(logger).new(o!("smithay_module" => "backend_winit"));
info!(log, "Initializing a winit backend");
let events_loop = EventLoop::new();
let winit_window = builder.build(&events_loop).map_err(Error::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) {
2020-04-15 11:01:01 +00:00
let display = EGLDisplay::<native::Wayland, WinitWindow>::new(winit_window, log.clone())?;
let context = display.create_context(attributes, reqs)?;
let surface = display.create_surface(
context.get_pixel_format(),
reqs.double_buffer,
context.get_config_id(),
(),
)?;
Window::Wayland {
display,
context,
surface,
}
2017-12-21 15:01:16 +00:00
} else if native::NativeDisplay::<native::X11>::is_backend(&winit_window) {
2020-04-15 11:01:01 +00:00
let display = EGLDisplay::<native::X11, WinitWindow>::new(winit_window, log.clone())?;
let context = display.create_context(attributes, reqs)?;
let surface = display.create_surface(
context.get_pixel_format(),
reqs.double_buffer,
context.get_config_id(),
(),
)?;
Window::X11 {
display,
context,
surface,
}
2017-12-21 15:01:16 +00:00
} else {
return Err(Error::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
let size = Rc::new(RefCell::new(WindowSize {
physical_size: window.window().inner_size(), // TODO: original code check if window is alive or not using inner_size().expect()
2020-03-21 12:27:54 +00:00
scale_factor: window.window().scale_factor(),
}));
2017-06-20 09:31:18 +00:00
Ok((
WinitGraphicsBackend {
2017-05-21 20:40:15 +00:00
window: window.clone(),
size: size.clone(),
logger: log.new(o!("smithay_winit_component" => "graphics")),
2017-05-21 20:40:15 +00:00
},
WinitInputBackend {
events_loop,
window,
time: Instant::now(),
2017-05-21 20:40:15 +00:00
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,
},
),
logger: log.new(o!("smithay_winit_component" => "input")),
size,
2017-06-20 09:31:18 +00:00
},
))
2017-05-18 20:28:02 +00:00
}
/// Specific events generated by Winit
#[derive(Debug)]
pub enum WinitEvent {
/// The window has been resized
Resized {
/// The new physical size (in pixels)
size: (f64, f64),
/// The new scale factor
scale_factor: f64,
},
/// The focus state of the window changed
Focus(bool),
/// A redraw was requested
Refresh,
2018-01-11 01:01:22 +00:00
}
2018-01-11 00:45:38 +00:00
impl WinitGraphicsBackend {
/// Get a reference to the internally used [`WinitWindow`]
2018-12-15 20:58:43 +00:00
pub fn winit_window(&self) -> Ref<'_, WinitWindow> {
2018-01-11 00:45:38 +00:00
self.window.window()
}
}
impl CursorBackend for WinitGraphicsBackend {
type CursorFormat = CursorIcon;
type Error = ();
2017-05-18 20:28:02 +00:00
fn set_cursor_position(&self, _x: u32, _y: u32) -> ::std::result::Result<(), ()> {
// With other backends, we read events from input devices and then have to position the
// mouse cursor on screen accordingly. Here, there is already a windowing system that deals
// with the position on screen. If we "force" out idea of the cursor position here, that
// breaks and e.g. the cursor on X11 becomes stuck and cannot move. (Us forcing a cursor
// position generates a mouse move event and thus we force the same cursor position again.)
Ok(())
2017-05-18 20:28:02 +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");
self.window.window().set_cursor_icon(*cursor);
self.window.window().set_cursor_visible(true);
Ok(())
}
fn clear_cursor_representation(&self) -> ::std::result::Result<(), ()> {
self.window.window().set_cursor_visible(false);
Ok(())
2017-05-18 20:28:02 +00:00
}
}
impl GLGraphicsBackend 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 {
2020-04-30 17:03:02 +00:00
Window::Wayland { ref surface, .. } => {
surface.swap_buffers().map_err(|err| err.try_into().unwrap())
}
2020-04-29 22:24:35 +00:00
Window::X11 { ref surface, .. } => surface.swap_buffers().map_err(|err| err.try_into().unwrap()),
}
2017-05-18 20:28:02 +00:00
}
2020-04-15 11:16:02 +00:00
fn get_proc_address(&self, symbol: &str) -> *const c_void {
trace!(self.logger, "Getting symbol for {:?}", symbol);
2020-04-15 11:01:01 +00:00
get_proc_address(symbol)
2017-05-18 20:28:02 +00:00
}
fn get_framebuffer_dimensions(&self) -> (u32, u32) {
let size = self.size.borrow();
size.physical_size.into()
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,
2020-04-15 11:01:01 +00:00
..
2018-01-07 21:30:38 +00:00
} => context.is_current() && surface.is_current(),
Window::X11 {
ref context,
ref surface,
2020-04-15 11:01:01 +00:00
..
2018-01-07 21:30:38 +00:00
} => 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 {
2020-04-15 11:01:01 +00:00
Window::Wayland {
ref surface,
ref context,
..
2020-04-29 22:24:35 +00:00
} => context.make_current_with_surface(surface).map_err(Into::into),
2020-04-15 11:01:01 +00:00
Window::X11 {
ref surface,
ref context,
..
2020-04-29 22:24:35 +00:00
} => context.make_current_with_surface(surface).map_err(Into::into),
2017-12-21 15:01:16 +00:00
}
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 {
2020-04-15 11:01:01 +00:00
Window::Wayland { ref surface, .. } => surface.get_pixel_format(),
Window::X11 { ref surface, .. } => surface.get_pixel_format(),
2017-12-21 15:01:16 +00:00
}
}
}
2017-12-21 15:01:16 +00:00
2020-04-15 11:01:01 +00:00
#[cfg(feature = "use_system_lib")]
impl EGLGraphicsBackend for WinitGraphicsBackend {
fn bind_wl_display(&self, wl_display: &Display) -> Result<EGLBufferReader, EGLError> {
2017-12-21 15:01:16 +00:00
match *self.window {
2020-04-15 11:01:01 +00:00
Window::Wayland { ref display, .. } => display.bind_wl_display(wl_display),
Window::X11 { ref display, .. } => display.bind_wl_display(wl_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, thiserror::Error)]
2017-05-18 20:28:02 +00:00
pub enum WinitInputError {
/// The underlying [`WinitWindow`] was closed. No further events can be processed.
2017-05-18 20:28:02 +00:00
///
/// See `dispatch_new_events`.
#[error("Winit window was closed")]
2017-05-18 20:28:02 +00:00
WindowClosed,
}
/// Winit-Backend internal event wrapping `winit`'s types into a [`KeyboardKeyEvent`]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2017-05-18 20:28:02 +00:00
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
}
}
/// Winit-Backend internal event wrapping `winit`'s types into a [`PointerMotionAbsoluteEvent`]
#[derive(Debug, Clone)]
2017-05-18 20:28:02 +00:00
pub struct WinitMouseMovedEvent {
size: Rc<RefCell<WindowSize>>,
2017-05-18 20:28:02 +00:00
time: u32,
2020-03-23 10:02:29 +00:00
logical_position: LogicalPosition<f64>,
2017-05-18 20:28:02 +00:00
}
impl BackendEvent for WinitMouseMovedEvent {
fn time(&self) -> u32 {
self.time
}
}
2020-04-10 15:01:49 +00:00
impl PointerMotionAbsoluteEvent for WinitMouseMovedEvent {
// TODO: maybe use {Logical, Physical}Position from winit?
2017-05-18 20:28:02 +00:00
fn x(&self) -> f64 {
let wsize = self.size.borrow();
2020-03-23 10:02:29 +00:00
self.logical_position.x * wsize.scale_factor
2017-05-18 20:28:02 +00:00
}
fn y(&self) -> f64 {
let wsize = self.size.borrow();
2020-03-23 10:02:29 +00:00
self.logical_position.y * wsize.scale_factor
2017-05-18 20:28:02 +00:00
}
fn x_transformed(&self, width: u32) -> f64 {
let wsize = self.size.borrow();
let w_width = wsize.physical_size.to_logical::<f64>(wsize.scale_factor).width;
f64::max(self.logical_position.x * width as f64 / w_width, 0.0)
2017-05-18 20:28:02 +00:00
}
fn y_transformed(&self, height: u32) -> f64 {
let wsize = self.size.borrow();
let w_height = wsize.physical_size.to_logical::<f64>(wsize.scale_factor).height;
f64::max(self.logical_position.y * height as f64 / w_height, 0.0)
2017-05-18 20:28:02 +00:00
}
}
/// Winit-Backend internal event wrapping `winit`'s types into a [`PointerAxisEvent`]
#[derive(Debug, Clone, Copy, PartialEq)]
2017-05-18 20:28:02 +00:00
pub struct WinitMouseWheelEvent {
time: u32,
delta: MouseScrollDelta,
}
impl BackendEvent for WinitMouseWheelEvent {
fn time(&self) -> u32 {
self.time
}
}
impl PointerAxisEvent for WinitMouseWheelEvent {
fn source(&self) -> AxisSource {
match self.delta {
MouseScrollDelta::LineDelta(_, _) => AxisSource::Wheel,
2018-09-26 05:36:18 +00:00
MouseScrollDelta::PixelDelta(_) => AxisSource::Continuous,
2017-05-18 20:28:02 +00:00
}
}
fn amount(&self, axis: Axis) -> Option<f64> {
match (axis, self.delta) {
(Axis::Horizontal, MouseScrollDelta::PixelDelta(delta)) => Some(delta.x),
(Axis::Vertical, MouseScrollDelta::PixelDelta(delta)) => Some(delta.y),
(_, MouseScrollDelta::LineDelta(_, _)) => None,
}
}
fn amount_discrete(&self, axis: Axis) -> Option<f64> {
match (axis, self.delta) {
(Axis::Horizontal, MouseScrollDelta::LineDelta(x, _)) => Some(x as f64),
(Axis::Vertical, MouseScrollDelta::LineDelta(_, y)) => Some(y as f64),
2018-09-26 05:36:18 +00:00
(_, MouseScrollDelta::PixelDelta(_)) => None,
2017-05-18 20:28:02 +00:00
}
}
}
/// Winit-Backend internal event wrapping `winit`'s types into a [`PointerButtonEvent`]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2017-05-18 20:28:02 +00:00
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()
}
}
/// Winit-Backend internal event wrapping `winit`'s types into a [`TouchDownEvent`]
#[derive(Debug, Clone)]
2017-05-18 20:28:02 +00:00
pub struct WinitTouchStartedEvent {
size: Rc<RefCell<WindowSize>>,
2017-05-18 20:28:02 +00:00
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 {
let wsize = self.size.borrow();
self.location.0 * wsize.scale_factor
2017-05-18 20:28:02 +00:00
}
fn y(&self) -> f64 {
let wsize = self.size.borrow();
self.location.1 * wsize.scale_factor
2017-05-18 20:28:02 +00:00
}
fn x_transformed(&self, width: u32) -> f64 {
let wsize = self.size.borrow();
let w_width = wsize.physical_size.to_logical::<f64>(wsize.scale_factor).width;
f64::max(self.location.0 * width as f64 / w_width, 0.0)
2017-05-18 20:28:02 +00:00
}
fn y_transformed(&self, height: u32) -> f64 {
let wsize = self.size.borrow();
let w_height = wsize.physical_size.to_logical::<f64>(wsize.scale_factor).height;
f64::max(self.location.1 * height as f64 / w_height, 0.0)
2017-05-18 20:28:02 +00:00
}
}
/// Winit-Backend internal event wrapping `winit`'s types into a [`TouchMotionEvent`]
#[derive(Debug, Clone)]
2017-05-18 20:28:02 +00:00
pub struct WinitTouchMovedEvent {
size: Rc<RefCell<WindowSize>>,
2017-05-18 20:28:02 +00:00
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 {
let wsize = self.size.borrow();
self.location.0 * wsize.scale_factor
2017-05-18 20:28:02 +00:00
}
fn y(&self) -> f64 {
let wsize = self.size.borrow();
self.location.1 * wsize.scale_factor
2017-05-18 20:28:02 +00:00
}
fn x_transformed(&self, width: u32) -> f64 {
let wsize = self.size.borrow();
let w_width = wsize.physical_size.to_logical::<f64>(wsize.scale_factor).width;
f64::max(self.location.0 * width as f64 / w_width, 0.0)
2017-05-18 20:28:02 +00:00
}
fn y_transformed(&self, height: u32) -> f64 {
let wsize = self.size.borrow();
let w_height = wsize.physical_size.to_logical::<f64>(wsize.scale_factor).height;
f64::max(self.location.1 * height as f64 / w_height, 0.0)
2017-05-18 20:28:02 +00:00
}
}
/// Winit-Backend internal event wrapping `winit`'s types into a `TouchUpEvent`
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2017-05-18 20:28:02 +00:00
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))
}
}
/// Winit-Backend internal event wrapping `winit`'s types into a [`TouchCancelEvent`]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2017-05-18 20:28:02 +00:00
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))
}
}
/// Input config for Winit
///
/// This backend does not allow any input configuration, so this type does nothing.
#[derive(Debug)]
pub struct WinitInputConfig;
2018-01-11 01:01:22 +00:00
2017-05-18 20:28:02 +00:00
impl InputBackend for WinitInputBackend {
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;
type SpecialEvent = WinitEvent;
type InputConfig = WinitInputConfig;
2017-05-18 20:28:02 +00:00
fn seats(&self) -> Vec<Seat> {
vec![self.seat.clone()]
2017-05-18 20:28:02 +00:00
}
fn input_config(&mut self) -> &mut Self::InputConfig {
/// So much effort to return a useless singleton!
static mut CONFIG: WinitInputConfig = WinitInputConfig;
unsafe { &mut CONFIG }
2017-05-18 20:28:02 +00:00
}
/// Processes new events of the underlying event loop to drive the set [`InputHandler`].
2017-05-18 20:28:02 +00:00
///
/// You need to periodically call this function to keep the underlying event loop and
/// [`WinitWindow`] active. Otherwise the window may no respond to user interaction and no
/// input events will be received by a set [`InputHandler`].
2017-05-18 20:28:02 +00:00
///
/// Returns an error if the [`WinitWindow`] the window has been closed. Calling
/// `dispatch_new_events` again after the [`WinitWindow`] has been closed is considered an
/// application error and unspecified behaviour may occur.
2017-05-18 20:28:02 +00:00
///
/// The linked [`WinitGraphicsBackend`] will error with a lost context and should
2017-05-18 20:28:02 +00:00
/// not be used anymore as well.
fn dispatch_new_events<F>(&mut self, mut callback: F) -> ::std::result::Result<(), WinitInputError>
where
F: FnMut(InputEvent<Self>, &mut WinitInputConfig),
{
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.
2018-12-15 20:58:43 +00:00
let closed_ptr = &mut closed;
let key_counter = &mut self.key_counter;
let time = &self.time;
2017-05-18 20:28:02 +00:00
let seat = &self.seat;
let window = &self.window;
let logger = &self.logger;
let window_size = &self.size;
let mut callback = move |event| callback(event, &mut WinitInputConfig);
2020-04-10 15:01:49 +00:00
self.events_loop
.run_return(move |event, _target, control_flow| match event {
Event::RedrawEventsCleared => {
*control_flow = ControlFlow::Exit;
2020-04-10 15:01:49 +00:00
}
Event::RedrawRequested(_id) => {
callback(InputEvent::Special(WinitEvent::Refresh));
2020-04-10 15:01:49 +00:00
}
Event::WindowEvent { event, .. } => {
let duration = Instant::now().duration_since(*time);
let nanos = duration.subsec_nanos() as u64;
let time = ((1000 * duration.as_secs()) + (nanos / 1_000_000)) as u32;
match event {
WindowEvent::Resized(psize) => {
trace!(logger, "Resizing window to {:?}", psize);
let scale_factor = window.window().scale_factor();
let mut wsize = window_size.borrow_mut();
wsize.physical_size = psize;
wsize.scale_factor = scale_factor;
if let Window::Wayland { ref surface, .. } = **window {
surface.resize(psize.width as i32, psize.height as i32, 0, 0);
}
callback(InputEvent::Special(WinitEvent::Resized {
size: psize.into(),
scale_factor,
}));
}
WindowEvent::Focused(focus) => {
callback(InputEvent::Special(WinitEvent::Focus(focus)));
}
WindowEvent::ScaleFactorChanged {
scale_factor,
new_inner_size: new_psize,
} => {
let mut wsize = window_size.borrow_mut();
wsize.scale_factor = scale_factor;
if let Window::Wayland { ref surface, .. } = **window {
surface.resize(new_psize.width as i32, new_psize.height as i32, 0, 0);
2017-06-20 09:31:18 +00:00
}
let psize_f64: (f64, f64) = (new_psize.width.into(), new_psize.height.into());
callback(InputEvent::Special(WinitEvent::Resized {
size: psize_f64,
scale_factor: wsize.scale_factor,
}));
}
WindowEvent::KeyboardInput {
input: KeyboardInput { scancode, state, .. },
..
} => {
match state {
ElementState::Pressed => *key_counter += 1,
ElementState::Released => {
*key_counter = key_counter.checked_sub(1).unwrap_or(0)
}
};
callback(InputEvent::Keyboard {
seat: seat.clone(),
event: WinitKeyboardInputEvent {
time,
key: scancode,
count: *key_counter,
state,
},
});
}
WindowEvent::CursorMoved { position, .. } => {
2020-03-23 10:02:29 +00:00
let lpos = position.to_logical(window_size.borrow().scale_factor);
callback(InputEvent::PointerMotionAbsolute {
seat: seat.clone(),
event: WinitMouseMovedEvent {
size: window_size.clone(),
time,
2020-03-23 10:02:29 +00:00
logical_position: lpos,
},
});
}
WindowEvent::MouseWheel { delta, .. } => {
let event = WinitMouseWheelEvent { time, delta };
callback(InputEvent::PointerAxis {
seat: seat.clone(),
event,
});
}
WindowEvent::MouseInput { state, button, .. } => {
callback(InputEvent::PointerButton {
seat: seat.clone(),
event: WinitMouseInputEvent { time, button, state },
});
}
WindowEvent::Touch(Touch {
phase: TouchPhase::Started,
location,
id,
..
}) => {
callback(InputEvent::TouchDown {
seat: seat.clone(),
event: WinitTouchStartedEvent {
size: window_size.clone(),
time,
location: location.into(),
id,
},
});
}
WindowEvent::Touch(Touch {
phase: TouchPhase::Moved,
location,
id,
..
}) => {
callback(InputEvent::TouchMotion {
seat: seat.clone(),
event: WinitTouchMovedEvent {
size: window_size.clone(),
time,
location: location.into(),
id,
},
});
}
WindowEvent::Touch(Touch {
phase: TouchPhase::Ended,
location,
id,
..
}) => {
callback(InputEvent::TouchMotion {
seat: seat.clone(),
event: WinitTouchMovedEvent {
size: window_size.clone(),
time,
location: location.into(),
id,
},
});
callback(InputEvent::TouchUp {
seat: seat.clone(),
event: WinitTouchEndedEvent { time, id },
})
}
WindowEvent::Touch(Touch {
phase: TouchPhase::Cancelled,
id,
..
}) => {
callback(InputEvent::TouchCancel {
seat: seat.clone(),
event: WinitTouchCancelledEvent { time, id },
});
}
WindowEvent::CloseRequested | WindowEvent::Destroyed => {
warn!(logger, "Window closed");
*closed_ptr = true;
2020-04-10 15:01:49 +00:00
}
_ => {}
2017-06-04 21:13:19 +00:00
}
2020-04-10 15:01:49 +00:00
}
_ => {}
});
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,
2021-02-22 19:27:46 +00:00
WinitMouseButton::Other(num) => MouseButton::Other(num as u8),
2017-05-18 20:28:02 +00:00
}
}
}
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,
}
}
}