Skip to content

Commit ff8cfc2

Browse files
lopo12123emilk
andauthored
Allow users to create viewports larger than monitor on Windows & macOS (#4337)
Added clamp_size_to_monitor_size field on ViewportBuilder, which means whether clamp the window's size to monitor's size. (default to `true`) * Closes #3389 ### simple example ```rust pub struct MyApp {} impl MyApp { pub fn new() -> MyApp { MyApp {} } } impl eframe::App for MyApp { fn update(&mut self, ctx: &Context, frame: &mut eframe::Frame) { egui::CentralPanel::default() .frame(Frame::none().fill(Color32::DARK_GRAY)) .show(ctx, |ui| { if ctx.input(|i| i.key_pressed(Key::Escape)) { ctx.send_viewport_cmd(ViewportCommand::Close); } }); } } pub fn main() { let option = eframe::NativeOptions { viewport: ViewportBuilder::default() .with_position([10.0, 10.0]) .with_inner_size([3000.0, 2000.0]) .with_clamp_size_to_monitor_size(false), ..Default::default() }; eframe::run_native( "a large window app", option, Box::new(|ctx| Box::new(MyApp::new())), ).unwrap(); } ``` It works on my windows (with 3 monitors), but I don't have a test environment for macos --------- Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>
1 parent 436c671 commit ff8cfc2

File tree

3 files changed

+40
-6
lines changed

3 files changed

+40
-6
lines changed

crates/eframe/src/native/epi_integration.rs

+17-6
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,23 @@ pub fn viewport_builder<E>(
2020

2121
let mut viewport_builder = native_options.viewport.clone();
2222

23+
let clamp_size_to_monitor_size = viewport_builder.clamp_size_to_monitor_size.unwrap_or(
24+
// On some Linux systems, a window size larger than the monitor causes crashes
25+
cfg!(target_os = "linux"),
26+
);
27+
2328
// Always use the default window size / position on iOS. Trying to restore the previous position
2429
// causes the window to be shown too small.
2530
#[cfg(not(target_os = "ios"))]
2631
let inner_size_points = if let Some(mut window_settings) = window_settings {
2732
// Restore pos/size from previous session
2833

29-
window_settings
30-
.clamp_size_to_sane_values(largest_monitor_point_size(egui_zoom_factor, event_loop));
34+
if clamp_size_to_monitor_size {
35+
window_settings.clamp_size_to_sane_values(largest_monitor_point_size(
36+
egui_zoom_factor,
37+
event_loop,
38+
));
39+
}
3140
window_settings.clamp_position_to_monitors(egui_zoom_factor, event_loop);
3241

3342
viewport_builder = window_settings.initialize_viewport_builder(viewport_builder);
@@ -37,10 +46,12 @@ pub fn viewport_builder<E>(
3746
viewport_builder = viewport_builder.with_position(pos);
3847
}
3948

40-
if let Some(initial_window_size) = viewport_builder.inner_size {
41-
let initial_window_size = initial_window_size
42-
.at_most(largest_monitor_point_size(egui_zoom_factor, event_loop));
43-
viewport_builder = viewport_builder.with_inner_size(initial_window_size);
49+
if clamp_size_to_monitor_size {
50+
if let Some(initial_window_size) = viewport_builder.inner_size {
51+
let initial_window_size = initial_window_size
52+
.at_most(largest_monitor_point_size(egui_zoom_factor, event_loop));
53+
viewport_builder = viewport_builder.with_inner_size(initial_window_size);
54+
}
4455
}
4556

4657
viewport_builder.inner_size

crates/egui-winit/src/lib.rs

+1
Original file line numberDiff line numberDiff line change
@@ -1598,6 +1598,7 @@ pub fn create_winit_window_builder<T>(
15981598
window_type: _window_type,
15991599

16001600
mouse_passthrough: _, // handled in `apply_viewport_builder_to_window`
1601+
clamp_size_to_monitor_size: _, // Handled in `viewport_builder` in `epi_integration.rs`
16011602
} = viewport_builder;
16021603

16031604
let mut window_builder = winit::window::WindowBuilder::new()

crates/egui/src/viewport.rs

+22
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,11 @@ pub struct ViewportBuilder {
275275
pub min_inner_size: Option<Vec2>,
276276
pub max_inner_size: Option<Vec2>,
277277

278+
/// Whether clamp the window's size to monitor's size. The default is `true` on linux, otherwise it is `false`.
279+
///
280+
/// Note: On some Linux systems, a window size larger than the monitor causes crashes
281+
pub clamp_size_to_monitor_size: Option<bool>,
282+
278283
pub fullscreen: Option<bool>,
279284
pub maximized: Option<bool>,
280285
pub resizable: Option<bool>,
@@ -493,6 +498,15 @@ impl ViewportBuilder {
493498
self
494499
}
495500

501+
/// Sets whether clamp the window's size to monitor's size. The default is `true` on linux, otherwise it is `false`.
502+
///
503+
/// Note: On some Linux systems, a window size larger than the monitor causes crashes
504+
#[inline]
505+
pub fn with_clamp_size_to_monitor_size(mut self, value: bool) -> Self {
506+
self.clamp_size_to_monitor_size = Some(value);
507+
self
508+
}
509+
496510
/// Does not work on X11.
497511
#[inline]
498512
pub fn with_close_button(mut self, value: bool) -> Self {
@@ -606,6 +620,7 @@ impl ViewportBuilder {
606620
inner_size: new_inner_size,
607621
min_inner_size: new_min_inner_size,
608622
max_inner_size: new_max_inner_size,
623+
clamp_size_to_monitor_size: new_clamp_size_to_monitor_size,
609624
fullscreen: new_fullscreen,
610625
maximized: new_maximized,
611626
resizable: new_resizable,
@@ -740,6 +755,13 @@ impl ViewportBuilder {
740755

741756
let mut recreate_window = false;
742757

758+
if new_clamp_size_to_monitor_size.is_some()
759+
&& self.clamp_size_to_monitor_size != new_clamp_size_to_monitor_size
760+
{
761+
self.clamp_size_to_monitor_size = new_clamp_size_to_monitor_size;
762+
recreate_window = true;
763+
}
764+
743765
if new_active.is_some() && self.active != new_active {
744766
self.active = new_active;
745767
recreate_window = true;

0 commit comments

Comments
 (0)