1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
/*
`async-winit` is free software: you can redistribute it and/or modify it under the terms of one of
the following licenses:
- The GNU Affero General Public License as published by the Free Software Foundation, either version
3 of the License, or (at your option) any later version.
- The Patron License at https://github.com/notgull/async-winit/blob/main/LICENSE-PATRON.md, for
sponsors and contributors, who can ignore the copyleft provisions of the GNU AGPL for this project.
`async-winit` is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General
Public License and the Patron License for more details.
You should have received a copy of the GNU Affero General Public License and the corresponding Patron
License along with `async-winit`. If not, see <https://www.gnu.org/licenses/>.
*/
// This file is partially derived from `winit`, which was originally created by Pierre Krieger and
// contributers. It was originally released under the MIT license.
//! Platform-specific features for Wayland.
use super::__private as sealed;
use crate::event_loop::{EventLoopBuilder, EventLoopWindowTarget};
use crate::window::{Window, WindowBuilder};
use std::os::raw;
use winit::platform::wayland::{
EventLoopBuilderExtWayland as _, WindowBuilderExtWayland as _, WindowExtWayland as _,
};
#[doc(inline)]
pub use winit::platform::wayland::MonitorHandleExtWayland;
/// Additional methods on [`EventLoopWindowTarget`] that are specific to Wayland.
///
/// [`EventLoopWindowTarget`]: crate::event_loop::EventLoopWindowTarget
pub trait EventLoopWindowTargetExtWayland: sealed::EventLoopWindowTargetPrivate {
/// True if the [`EventLoopWindowTarget`] uses Wayland.
fn is_wayland(&self) -> bool;
/// 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.
///
/// [`EventLoop`]: crate::event_loop::EventLoop
fn wayland_display(&self) -> Option<*mut raw::c_void>;
}
impl EventLoopWindowTargetExtWayland for EventLoopWindowTarget {
#[inline]
fn is_wayland(&self) -> bool {
self.is_wayland
}
#[inline]
fn wayland_display(&self) -> Option<*mut raw::c_void> {
todo!()
}
}
/// Additional methods on [`EventLoopBuilder`] that are specific to Wayland.
///
/// [`EventLoopBuilder`]: crate::event_loop::EventLoopBuilder
pub trait EventLoopBuilderExtWayland: sealed::EventLoopBuilderPrivate {
/// Force using 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 EventLoopBuilderExtWayland for EventLoopBuilder {
fn with_wayland(&mut self) -> &mut Self {
self.inner.with_wayland();
self
}
fn with_any_thread(&mut self, any_thread: bool) -> &mut Self {
self.inner.with_any_thread(any_thread);
self
}
}
/// Additional methods on [`Window`] that are specific to Wayland.
///
/// [`Window`]: crate::window::Window
pub trait WindowExtWayland: sealed::WindowPrivate {
/// 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 [`Window`] is destroyed.
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 [`Window`] is destroyed.
fn wayland_display(&self) -> Option<*mut raw::c_void>;
}
impl WindowExtWayland for Window {
#[inline]
fn wayland_surface(&self) -> Option<*mut raw::c_void> {
self.window().wayland_surface()
}
#[inline]
fn wayland_display(&self) -> Option<*mut raw::c_void> {
self.window().wayland_display()
}
}
/// Additional methods on [`WindowBuilder`] that are specific to Wayland.
///
/// [`WindowBuilder`]: crate::window::WindowBuilder
pub trait WindowBuilderExtWayland: sealed::WindowBuilderPrivate {
/// Build window with the given name.
///
/// The `general` name sets an application ID, which should match the `.desktop`
/// file destributed with your program. The `instance` is a `no-op`.
///
/// 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)
fn with_name(self, general: impl Into<String>, instance: impl Into<String>) -> Self;
}
impl WindowBuilderExtWayland for WindowBuilder {
#[inline]
fn with_name(mut self, general: impl Into<String>, instance: impl Into<String>) -> Self {
self.platform
.set_x11_name((general.into(), instance.into()));
self
}
}
#[derive(Default)]
pub(crate) struct PlatformSpecific {
pub name: Option<(String, String)>,
}
impl PlatformSpecific {
pub fn set_x11_name(&mut self, x11_name: (String, String)) {
self.name = Some(x11_name);
}
pub fn apply_to(
self,
window_builder: winit::window::WindowBuilder,
) -> winit::window::WindowBuilder {
let mut window_builder = window_builder;
if let Some((general, instance)) = self.name {
window_builder = window_builder.with_name(general, instance);
}
window_builder
}
}