Automatically generate screenshots for all examples (#2379)

examples/confirm_exit/Cargo.toml

@@ -9,4 +9,6 @@ publish = false
 
 
 [dependencies]
-eframe = { path = "../../crates/eframe" }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }

examples/confirm_exit/README.md

@@ -1,3 +1,7 @@
+Example how to show a confirm dialog before exiting an application.
+
 ```sh
 cargo run -p confirm_exit
 ```
+
+![](screenshot.png)

examples/confirm_exit/src/main.rs

@@ -3,7 +3,10 @@
 use eframe::egui;
 
 fn main() {
-    let options = eframe::NativeOptions::default();
+    let options = eframe::NativeOptions {
+        initial_window_size: Some(egui::vec2(320.0, 240.0)),
+        ..Default::default()
+    };
     eframe::run_native(
         "Confirm exit",
         options,

examples/custom_3d_glow/Cargo.toml

@@ -9,6 +9,8 @@ publish = false
 
 
 [dependencies]
-eframe = { path = "../../crates/eframe", features = ["glow"] }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }
 egui_glow = { path = "../../crates/egui_glow" }
 glow = "0.11"

examples/custom_3d_glow/README.md

@@ -13,3 +13,5 @@ If you are content of having egui sit on top of a 3D background, take a look at:
 ```sh
 cargo run -p custom_3d_glow
 ```
+
+![](screenshot.png)

examples/custom_3d_three-d/Cargo.toml

@@ -11,7 +11,9 @@ publish = false
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
-eframe = { path = "../../crates/eframe", features = ["glow"] }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }
 egui_glow = { path = "../../crates/egui_glow" }
 glow = "0.11"
 three-d = { version = "0.13", default-features = false }

examples/custom_3d_three-d/README.md

@@ -18,3 +18,5 @@ cargo run -p custom_3d_three-d
 ```
 wasm-pack build examples/custom_3d_three-d --target web
 ```
+
+![](screenshot.png)

examples/custom_font/Cargo.toml

@@ -9,4 +9,6 @@ publish = false
 
 
 [dependencies]
-eframe = { path = "../../crates/eframe" }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }

examples/custom_font/README.md

@@ -1,3 +1,7 @@
+Example of how to use custom fonts.
+
 ```sh
 cargo run -p custom_font
 ```
+
+![](screenshot.png)

examples/custom_font/src/main.rs

@@ -3,7 +3,10 @@
 use eframe::egui;
 
 fn main() {
-    let options = eframe::NativeOptions::default();
+    let options = eframe::NativeOptions {
+        initial_window_size: Some(egui::vec2(320.0, 240.0)),
+        ..Default::default()
+    };
     eframe::run_native(
         "egui example: custom font",
         options,

examples/custom_font_style/Cargo.toml

@@ -9,4 +9,6 @@ publish = false
 
 
 [dependencies]
-eframe = { path = "../../crates/eframe" }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }

examples/custom_font_style/README.md

@@ -1,4 +1,7 @@
+Example how to define custom test styles.
+
 ```sh
 cargo run -p custom_font_style
 ```
-![custom_font_style example](custom_font_style.png)
+
+![](screenshot.png)

examples/custom_window_frame/Cargo.toml

@@ -9,4 +9,6 @@ publish = false
 
 
 [dependencies]
-eframe = { path = "../../crates/eframe" }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }

examples/custom_window_frame/README.md

@@ -1,3 +1,7 @@
+Example how to show a custom window frame instead of the default OS window chrome decorations.
+
 ```sh
 cargo run -p custom_window_frame
 ```
+
+![](screenshot.png)

examples/custom_window_frame/src/main.rs

@@ -11,6 +11,7 @@ fn main() {
         // To have rounded corners we need transparency:
         transparent: true,
         min_window_size: Some(egui::vec2(320.0, 100.0)),
+        initial_window_size: Some(egui::vec2(320.0, 240.0)),
         ..Default::default()
     };
     eframe::run_native(

examples/download_image/Cargo.toml

@@ -9,7 +9,9 @@ publish = false
 
 
 [dependencies]
-eframe = { path = "../../crates/eframe" }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }
 egui_extras = { path = "../../crates/egui_extras", features = ["image"] }
 ehttp = "0.2"
 image = { version = "0.24", default-features = false, features = ["jpeg"] }

examples/download_image/README.md

@@ -1,3 +1,7 @@
+Example how to download and show an image with eframe/egui.
+
 ```sh
 cargo run -p download_image
 ```
+
+![](screenshot.png)

examples/file_dialog/Cargo.toml

@@ -9,5 +9,7 @@ publish = false
 
 
 [dependencies]
-eframe = { path = "../../crates/eframe" }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }
 rfd = "0.10"

examples/file_dialog/README.md

@@ -3,3 +3,5 @@ How to show a file dialog using [`rfd`](https://github.com/PolyMeilex/rfd).
 ```sh
 cargo run -p file_dialog
 ```
+
+![](screenshot.png)

examples/file_dialog/src/main.rs

@@ -5,6 +5,7 @@ use eframe::egui;
 fn main() {
     let options = eframe::NativeOptions {
         drag_and_drop_support: true,
+        initial_window_size: Some(egui::vec2(320.0, 240.0)),
         ..Default::default()
     };
     eframe::run_native(

examples/hello_world/Cargo.toml

@@ -9,5 +9,7 @@ publish = false
 
 
 [dependencies]
-eframe = { path = "../../crates/eframe" }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }
 tracing-subscriber = "0.3"

examples/hello_world/README.md

@@ -1,3 +1,7 @@
+Example showing some UI controls like `Label`, `TextEdit`, `Slider`, `Button`.
+
 ```sh
 cargo run -p hello_world
 ```
+
+![](screenshot.png)

examples/hello_world/src/main.rs

@@ -6,7 +6,10 @@ fn main() {
     // Log to stdout (if you run with `RUST_LOG=debug`).
     tracing_subscriber::fmt::init();
 
-    let options = eframe::NativeOptions::default();
+    let options = eframe::NativeOptions {
+        initial_window_size: Some(egui::vec2(320.0, 240.0)),
+        ..Default::default()
+    };
     eframe::run_native(
         "My egui App",
         options,

examples/keyboard_events/Cargo.toml

@@ -9,5 +9,7 @@ publish = false
 
 
 [dependencies]
-eframe = { path = "../../crates/eframe" }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }
 tracing-subscriber = "0.3"

examples/keyboard_events/README.md

@@ -1,3 +1,5 @@
 ```sh
 cargo run -p hello_world
 ```
+
+![](screenshot.png)

examples/puffin_profiler/Cargo.toml

@@ -9,6 +9,8 @@ publish = false
 
 
 [dependencies]
-eframe = { path = "../../crates/eframe", features = ["puffin"] }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }
 puffin = "0.14"
 puffin_http = "0.11"

examples/puffin_profiler/README.md

@@ -7,3 +7,5 @@ cargo run -p puffin_profiler &
 cargo install puffin_viewer
 puffin_viewer --url 127.0.0.1:8585
 ```
+
+![](screenshot.png)

examples/retained_image/Cargo.toml

@@ -9,6 +9,8 @@ publish = false
 
 
 [dependencies]
-eframe = { path = "../../crates/eframe" }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }
 egui_extras = { path = "../../crates/egui_extras", features = ["image"] }
 image = { version = "0.24", default-features = false, features = ["png"] }

examples/retained_image/README.md

@@ -1,3 +1,7 @@
+Example how to show an image with eframe/egui.
+
 ```sh
 cargo run -p retained_image
 ```
+
+![](screenshot.png)

examples/retained_image/src/main.rs

@@ -5,7 +5,7 @@ use egui_extras::RetainedImage;
 
 fn main() {
     let options = eframe::NativeOptions {
-        initial_window_size: Some(egui::vec2(500.0, 900.0)),
+        initial_window_size: Some(egui::vec2(300.0, 900.0)),
         ..Default::default()
     };
 

examples/screenshot/Cargo.toml

@@ -9,6 +9,8 @@ publish = false
 
 
 [dependencies]
-eframe = { path = "../../crates/eframe" }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }
 egui_extras = { path = "../../crates/egui_extras", features = ["image"] }
 itertools = "0.10.3"

examples/screenshot/README.md

@@ -1,3 +1,7 @@
+Example how to take screenshots and display them with eframe/egui.
+
 ```sh
 cargo run -p screenshot
 ```
+
+![](screenshot.png)

examples/screenshot/src/main.rs

@@ -74,23 +74,25 @@ impl eframe::App for MyApp {
 
         self.take_screenshot = false;
         if let Some(gl) = frame.gl() {
-            let mut buf = vec![0u8; screen_size_px[0] as usize * screen_size_px[1] as usize * 4];
+            let [w, h] = screen_size_px;
+            let mut buf = vec![0u8; w as usize * h as usize * 4];
             let pixels = glow::PixelPackData::Slice(&mut buf[..]);
             unsafe {
                 gl.read_pixels(
                     0,
                     0,
-                    screen_size_px[0] as i32,
-                    screen_size_px[1] as i32,
+                    w as i32,
+                    h as i32,
                     glow::RGBA,
                     glow::UNSIGNED_BYTE,
                     pixels,
                 );
             }
 
+            // Flip vertically:
             let mut rows: Vec<Vec<u8>> = buf
                 .into_iter()
-                .chunks(screen_size_px[0] as usize * 4)
+                .chunks(w as usize * 4)
                 .into_iter()
                 .map(|chunk| chunk.collect())
                 .collect();

examples/serial_windows/Cargo.toml

@@ -9,4 +9,6 @@ publish = false
 
 
 [dependencies]
-eframe = { path = "../../crates/eframe" }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }

examples/serial_windows/README.md

@@ -6,3 +6,5 @@ See also <https://github.com/emilk/egui/issues/1918>.
 ```sh
 cargo run -p serial_windows
 ```
+
+![](screenshot.png)

examples/serial_windows/src/main.rs

@@ -9,6 +9,7 @@ fn main() {
 
     let options = eframe::NativeOptions {
         run_and_return: true,
+        initial_window_size: Some(egui::vec2(320.0, 240.0)),
         ..Default::default()
     };
 

examples/svg/Cargo.toml

@@ -9,5 +9,7 @@ publish = false
 
 
 [dependencies]
-eframe = { path = "../../crates/eframe" }
+eframe = { path = "../../crates/eframe", features = [
+    "__screenshot", # __screenshot is so we can dump a ascreenshot using EFRAME_SCREENSHOT_TO
+] }
 egui_extras = { path = "../../crates/egui_extras", features = ["svg"] }

examples/svg/README.md

@@ -1,6 +1,7 @@
 Example how to show an SVG image.
 
-
 ```sh
 cargo run -p svg
 ```
+
+![](screenshot.png)