f3f6f1008a
This commit adds an `EventLoopBuilder` struct to simplify event loop customization and providing options to it upon creation. It also deprecates the use of `EventLoop::with_user_event` in favor of the same method on new builder, and replaces old platforms specific extension traits with the new ones on the `EventLoopBuilder`.
405 lines
13 KiB
Rust
405 lines
13 KiB
Rust
#![cfg(any(
|
|
target_os = "linux",
|
|
target_os = "dragonfly",
|
|
target_os = "freebsd",
|
|
target_os = "netbsd",
|
|
target_os = "openbsd"
|
|
))]
|
|
|
|
use std::os::raw;
|
|
#[cfg(feature = "x11")]
|
|
use std::{ptr, sync::Arc};
|
|
|
|
use crate::{
|
|
event_loop::{EventLoopBuilder, EventLoopWindowTarget},
|
|
monitor::MonitorHandle,
|
|
window::{Window, WindowBuilder},
|
|
};
|
|
|
|
#[cfg(feature = "x11")]
|
|
use crate::dpi::Size;
|
|
#[cfg(feature = "x11")]
|
|
use crate::platform_impl::x11::{ffi::XVisualInfo, XConnection};
|
|
use crate::platform_impl::{
|
|
Backend, EventLoopWindowTarget as LinuxEventLoopWindowTarget, Window as LinuxWindow,
|
|
};
|
|
|
|
// TODO: stupid hack so that glutin can do its work
|
|
#[doc(hidden)]
|
|
#[cfg(feature = "x11")]
|
|
pub use crate::platform_impl::x11;
|
|
#[cfg(feature = "x11")]
|
|
pub use crate::platform_impl::{x11::util::WindowType as XWindowType, XNotSupported};
|
|
|
|
/// Additional methods on `EventLoopWindowTarget` that are specific to Unix.
|
|
pub trait EventLoopWindowTargetExtUnix {
|
|
/// True if the `EventLoopWindowTarget` uses Wayland.
|
|
#[cfg(feature = "wayland")]
|
|
fn is_wayland(&self) -> bool;
|
|
|
|
/// True if the `EventLoopWindowTarget` uses X11.
|
|
#[cfg(feature = "x11")]
|
|
fn is_x11(&self) -> bool;
|
|
|
|
#[doc(hidden)]
|
|
#[cfg(feature = "x11")]
|
|
fn xlib_xconnection(&self) -> Option<Arc<XConnection>>;
|
|
|
|
/// Returns a pointer to the `wl_display` object of wayland that is used by this
|
|
/// `EventLoopWindowTarget`.
|
|
///
|
|
/// Returns `None` if the `EventLoop` doesn't use wayland (if it uses xlib for example).
|
|
///
|
|
/// The pointer will become invalid when the winit `EventLoop` is destroyed.
|
|
#[cfg(feature = "wayland")]
|
|
fn wayland_display(&self) -> Option<*mut raw::c_void>;
|
|
}
|
|
|
|
impl<T> EventLoopWindowTargetExtUnix for EventLoopWindowTarget<T> {
|
|
#[inline]
|
|
#[cfg(feature = "wayland")]
|
|
fn is_wayland(&self) -> bool {
|
|
self.p.is_wayland()
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "x11")]
|
|
fn is_x11(&self) -> bool {
|
|
!self.p.is_wayland()
|
|
}
|
|
|
|
#[inline]
|
|
#[doc(hidden)]
|
|
#[cfg(feature = "x11")]
|
|
fn xlib_xconnection(&self) -> Option<Arc<XConnection>> {
|
|
match self.p {
|
|
LinuxEventLoopWindowTarget::X(ref e) => Some(e.x_connection().clone()),
|
|
#[cfg(feature = "wayland")]
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "wayland")]
|
|
fn wayland_display(&self) -> Option<*mut raw::c_void> {
|
|
match self.p {
|
|
LinuxEventLoopWindowTarget::Wayland(ref p) => {
|
|
Some(p.display().get_display_ptr() as *mut _)
|
|
}
|
|
#[cfg(feature = "x11")]
|
|
_ => None,
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Additional methods on [`EventLoopBuilder`] that are specific to Unix.
|
|
pub trait EventLoopBuilderExtUnix {
|
|
/// Force using X11.
|
|
#[cfg(feature = "x11")]
|
|
fn with_x11(&mut self) -> &mut Self;
|
|
|
|
/// Force using Wayland.
|
|
#[cfg(feature = "wayland")]
|
|
fn with_wayland(&mut self) -> &mut Self;
|
|
|
|
/// Whether to allow the event loop to be created off of the main thread.
|
|
///
|
|
/// By default, the window is only allowed to be created on the main
|
|
/// thread, to make platform compatibility easier.
|
|
fn with_any_thread(&mut self, any_thread: bool) -> &mut Self;
|
|
}
|
|
|
|
impl<T> EventLoopBuilderExtUnix for EventLoopBuilder<T> {
|
|
#[inline]
|
|
#[cfg(feature = "x11")]
|
|
fn with_x11(&mut self) -> &mut Self {
|
|
self.platform_specific.forced_backend = Some(Backend::X);
|
|
self
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "wayland")]
|
|
fn with_wayland(&mut self) -> &mut Self {
|
|
self.platform_specific.forced_backend = Some(Backend::Wayland);
|
|
self
|
|
}
|
|
|
|
#[inline]
|
|
fn with_any_thread(&mut self, any_thread: bool) -> &mut Self {
|
|
self.platform_specific.any_thread = any_thread;
|
|
self
|
|
}
|
|
}
|
|
|
|
/// Additional methods on `Window` that are specific to Unix.
|
|
pub trait WindowExtUnix {
|
|
/// Returns the ID of the `Window` xlib object that is used by this window.
|
|
///
|
|
/// Returns `None` if the window doesn't use xlib (if it uses wayland for example).
|
|
#[cfg(feature = "x11")]
|
|
fn xlib_window(&self) -> Option<raw::c_ulong>;
|
|
|
|
/// Returns a pointer to the `Display` object of xlib that is used by this window.
|
|
///
|
|
/// Returns `None` if the window doesn't use xlib (if it uses wayland for example).
|
|
///
|
|
/// The pointer will become invalid when the glutin `Window` is destroyed.
|
|
#[cfg(feature = "x11")]
|
|
fn xlib_display(&self) -> Option<*mut raw::c_void>;
|
|
|
|
#[cfg(feature = "x11")]
|
|
fn xlib_screen_id(&self) -> Option<raw::c_int>;
|
|
|
|
#[doc(hidden)]
|
|
#[cfg(feature = "x11")]
|
|
fn xlib_xconnection(&self) -> Option<Arc<XConnection>>;
|
|
|
|
/// This function returns the underlying `xcb_connection_t` of an xlib `Display`.
|
|
///
|
|
/// Returns `None` if the window doesn't use xlib (if it uses wayland for example).
|
|
///
|
|
/// The pointer will become invalid when the glutin `Window` is destroyed.
|
|
#[cfg(feature = "x11")]
|
|
fn xcb_connection(&self) -> Option<*mut raw::c_void>;
|
|
|
|
/// Returns a pointer to the `wl_surface` object of wayland that is used by this window.
|
|
///
|
|
/// Returns `None` if the window doesn't use wayland (if it uses xlib for example).
|
|
///
|
|
/// The pointer will become invalid when the glutin `Window` is destroyed.
|
|
#[cfg(feature = "wayland")]
|
|
fn wayland_surface(&self) -> Option<*mut raw::c_void>;
|
|
|
|
/// Returns a pointer to the `wl_display` object of wayland that is used by this window.
|
|
///
|
|
/// Returns `None` if the window doesn't use wayland (if it uses xlib for example).
|
|
///
|
|
/// The pointer will become invalid when the glutin `Window` is destroyed.
|
|
#[cfg(feature = "wayland")]
|
|
fn wayland_display(&self) -> Option<*mut raw::c_void>;
|
|
|
|
/// Check if the window is ready for drawing
|
|
///
|
|
/// It is a remnant of a previous implementation detail for the
|
|
/// wayland backend, and is no longer relevant.
|
|
///
|
|
/// Always return true.
|
|
#[deprecated]
|
|
fn is_ready(&self) -> bool;
|
|
}
|
|
|
|
impl WindowExtUnix for Window {
|
|
#[inline]
|
|
#[cfg(feature = "x11")]
|
|
fn xlib_window(&self) -> Option<raw::c_ulong> {
|
|
match self.window {
|
|
LinuxWindow::X(ref w) => Some(w.xlib_window()),
|
|
#[cfg(feature = "wayland")]
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "x11")]
|
|
fn xlib_display(&self) -> Option<*mut raw::c_void> {
|
|
match self.window {
|
|
LinuxWindow::X(ref w) => Some(w.xlib_display()),
|
|
#[cfg(feature = "wayland")]
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "x11")]
|
|
fn xlib_screen_id(&self) -> Option<raw::c_int> {
|
|
match self.window {
|
|
LinuxWindow::X(ref w) => Some(w.xlib_screen_id()),
|
|
#[cfg(feature = "wayland")]
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
#[doc(hidden)]
|
|
#[cfg(feature = "x11")]
|
|
fn xlib_xconnection(&self) -> Option<Arc<XConnection>> {
|
|
match self.window {
|
|
LinuxWindow::X(ref w) => Some(w.xlib_xconnection()),
|
|
#[cfg(feature = "wayland")]
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "x11")]
|
|
fn xcb_connection(&self) -> Option<*mut raw::c_void> {
|
|
match self.window {
|
|
LinuxWindow::X(ref w) => Some(w.xcb_connection()),
|
|
#[cfg(feature = "wayland")]
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "wayland")]
|
|
fn wayland_surface(&self) -> Option<*mut raw::c_void> {
|
|
match self.window {
|
|
LinuxWindow::Wayland(ref w) => Some(w.surface().as_ref().c_ptr() as *mut _),
|
|
#[cfg(feature = "x11")]
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "wayland")]
|
|
fn wayland_display(&self) -> Option<*mut raw::c_void> {
|
|
match self.window {
|
|
LinuxWindow::Wayland(ref w) => Some(w.display().get_display_ptr() as *mut _),
|
|
#[cfg(feature = "x11")]
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
#[inline]
|
|
fn is_ready(&self) -> bool {
|
|
true
|
|
}
|
|
}
|
|
|
|
/// Additional methods on `WindowBuilder` that are specific to Unix.
|
|
pub trait WindowBuilderExtUnix {
|
|
#[cfg(feature = "x11")]
|
|
fn with_x11_visual<T>(self, visual_infos: *const T) -> Self;
|
|
#[cfg(feature = "x11")]
|
|
fn with_x11_screen(self, screen_id: i32) -> Self;
|
|
|
|
/// Build window with `WM_CLASS` hint; defaults to the name of the binary. Only relevant on X11.
|
|
#[cfg(feature = "x11")]
|
|
fn with_class(self, class: String, instance: String) -> Self;
|
|
/// Build window with override-redirect flag; defaults to false. Only relevant on X11.
|
|
#[cfg(feature = "x11")]
|
|
fn with_override_redirect(self, override_redirect: bool) -> Self;
|
|
/// Build window with `_NET_WM_WINDOW_TYPE` hints; defaults to `Normal`. Only relevant on X11.
|
|
#[cfg(feature = "x11")]
|
|
fn with_x11_window_type(self, x11_window_type: Vec<XWindowType>) -> Self;
|
|
/// Build window with `_GTK_THEME_VARIANT` hint set to the specified value. Currently only relevant on X11.
|
|
#[cfg(feature = "x11")]
|
|
fn with_gtk_theme_variant(self, variant: String) -> Self;
|
|
/// Build window with resize increment hint. Only implemented on X11.
|
|
///
|
|
/// ```
|
|
/// # use winit::dpi::{LogicalSize, PhysicalSize};
|
|
/// # use winit::window::WindowBuilder;
|
|
/// # use winit::platform::unix::WindowBuilderExtUnix;
|
|
/// // Specify the size in logical dimensions like this:
|
|
/// WindowBuilder::new().with_resize_increments(LogicalSize::new(400.0, 200.0));
|
|
///
|
|
/// // Or specify the size in physical dimensions like this:
|
|
/// WindowBuilder::new().with_resize_increments(PhysicalSize::new(400, 200));
|
|
/// ```
|
|
#[cfg(feature = "x11")]
|
|
fn with_resize_increments<S: Into<Size>>(self, increments: S) -> Self;
|
|
/// Build window with base size hint. Only implemented on X11.
|
|
///
|
|
/// ```
|
|
/// # use winit::dpi::{LogicalSize, PhysicalSize};
|
|
/// # use winit::window::WindowBuilder;
|
|
/// # use winit::platform::unix::WindowBuilderExtUnix;
|
|
/// // Specify the size in logical dimensions like this:
|
|
/// WindowBuilder::new().with_base_size(LogicalSize::new(400.0, 200.0));
|
|
///
|
|
/// // Or specify the size in physical dimensions like this:
|
|
/// WindowBuilder::new().with_base_size(PhysicalSize::new(400, 200));
|
|
/// ```
|
|
#[cfg(feature = "x11")]
|
|
fn with_base_size<S: Into<Size>>(self, base_size: S) -> Self;
|
|
|
|
/// Build window with a given application ID. It should match the `.desktop` file distributed with
|
|
/// your program. Only relevant on Wayland.
|
|
///
|
|
/// For details about application ID conventions, see the
|
|
/// [Desktop Entry Spec](https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#desktop-file-id)
|
|
#[cfg(feature = "wayland")]
|
|
fn with_app_id<T: Into<String>>(self, app_id: T) -> Self;
|
|
}
|
|
|
|
impl WindowBuilderExtUnix for WindowBuilder {
|
|
#[inline]
|
|
#[cfg(feature = "x11")]
|
|
fn with_x11_visual<T>(mut self, visual_infos: *const T) -> Self {
|
|
{
|
|
self.platform_specific.visual_infos =
|
|
Some(unsafe { ptr::read(visual_infos as *const XVisualInfo) });
|
|
}
|
|
self
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "x11")]
|
|
fn with_x11_screen(mut self, screen_id: i32) -> Self {
|
|
self.platform_specific.screen_id = Some(screen_id);
|
|
self
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "x11")]
|
|
fn with_class(mut self, instance: String, class: String) -> Self {
|
|
self.platform_specific.class = Some((instance, class));
|
|
self
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "x11")]
|
|
fn with_override_redirect(mut self, override_redirect: bool) -> Self {
|
|
self.platform_specific.override_redirect = override_redirect;
|
|
self
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "x11")]
|
|
fn with_x11_window_type(mut self, x11_window_types: Vec<XWindowType>) -> Self {
|
|
self.platform_specific.x11_window_types = x11_window_types;
|
|
self
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "x11")]
|
|
fn with_gtk_theme_variant(mut self, variant: String) -> Self {
|
|
self.platform_specific.gtk_theme_variant = Some(variant);
|
|
self
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "x11")]
|
|
fn with_resize_increments<S: Into<Size>>(mut self, increments: S) -> Self {
|
|
self.platform_specific.resize_increments = Some(increments.into());
|
|
self
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "x11")]
|
|
fn with_base_size<S: Into<Size>>(mut self, base_size: S) -> Self {
|
|
self.platform_specific.base_size = Some(base_size.into());
|
|
self
|
|
}
|
|
|
|
#[inline]
|
|
#[cfg(feature = "wayland")]
|
|
fn with_app_id<T: Into<String>>(mut self, app_id: T) -> Self {
|
|
self.platform_specific.app_id = Some(app_id.into());
|
|
self
|
|
}
|
|
}
|
|
|
|
/// Additional methods on `MonitorHandle` that are specific to Linux.
|
|
pub trait MonitorHandleExtUnix {
|
|
/// Returns the inner identifier of the monitor.
|
|
fn native_id(&self) -> u32;
|
|
}
|
|
|
|
impl MonitorHandleExtUnix for MonitorHandle {
|
|
#[inline]
|
|
fn native_id(&self) -> u32 {
|
|
self.inner.native_identifier()
|
|
}
|
|
}
|