skyler
/
egui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document platform compatibility on `viewport::WindowLevel` and dependents (#7432) 

Documents platform compatibility on the WindowLevel struct and some of
the methods that are dependent on it. Provides a link to
`winit:🪟:WindowLevel` documentation section that provides a list
of which platforms are supported.

* Closes [Issue 7419](https://github.com/emilk/egui/issues/7419)
* [x] I have followed the instructions in the PR template

---------

Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>
This commit is contained in:
Luke M 2025-08-12 20:35:45 +10:00 committed by GitHub
parent 42bdf5b881
commit e794de5ffa
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
crates/egui/src/viewport.rs
View File

@ -630,6 +630,8 @@ impl ViewportBuilder {
}
/// Control if window is always-on-top, always-on-bottom, or neither.
///
/// For platform compatibility see [`crate::viewport::WindowLevel`] documentation
#[inline]
pub fn with_window_level(mut self, level: WindowLevel) -> Self {
self.window_level = Some(level);
@ -637,6 +639,8 @@ impl ViewportBuilder {
}
/// This window is always on top
///
/// For platform compatibility see [`crate::viewport::WindowLevel`] documentation
#[inline]
pub fn with_always_on_top(self) -> Self {
self.with_window_level(WindowLevel::AlwaysOnTop)
@ -898,6 +902,7 @@ impl ViewportBuilder {
}
}
/// For winit platform compatibility, see [`winit::WindowLevel` documentation](https://docs.rs/winit/latest/winit/window/enum.WindowLevel.html#platform-specific)
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub enum WindowLevel {