Add performance rendering example (#198)

Author: michalsustr

Cargo.lock

@@ -910,6 +910,7 @@ dependencies = [
  "linked_axes",
  "log",
  "markers",
+ "performance",
  "plot_span",
  "save_plot",
  "stacked_bar",
@@ -2688,6 +2689,16 @@ version = "2.3.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9b4f627cb1b25917193a259e49bdad08f671f8d9708acfd5fe0a8c1455d87220"
 
+[[package]]
+name = "performance"
+version = "0.1.0"
+dependencies = [
+ "eframe",
+ "egui_plot",
+ "env_logger",
+ "examples_utils",
+]
+
 [[package]]
 name = "pin-project"
 version = "1.1.10"

Cargo.toml

@@ -35,6 +35,7 @@ legend_sort = { version = "0.1.0", path = "examples/legend_sort" }
 lines = { version = "0.1.0", path = "examples/lines" }
 linked_axes = { version = "0.1.0", path = "examples/linked_axes" }
 markers = { version = "0.1.0", path = "examples/markers" }
+performance = { version = "0.1.0", path = "examples/performance" }
 plot_span = { version = "0.1.0", path = "examples/plot_span" }
 save_plot = { version = "0.1.0", path = "examples/save_plot" }
 stacked_bar = { version = "0.1.0", path = "examples/stacked_bar" }

demo/Cargo.toml

@@ -41,6 +41,7 @@ legend_sort.workspace = true
 lines.workspace = true
 linked_axes.workspace = true
 markers.workspace = true
+performance.workspace = true
 plot_span.workspace = true
 save_plot.workspace = true
 stacked_bar.workspace = true

demo/src/app.rs

@@ -47,6 +47,7 @@ impl DemoGallery {
             Box::new(lines::LineExample::default()),
             Box::new(linked_axes::LinkedAxesExample::default()),
             Box::new(markers::MarkerDemo::default()),
+            Box::new(performance::PerformanceDemo::default()),
             Box::new(plot_span::PlotSpanDemo::default()),
             Box::new(save_plot::SavePlotExample::default()),
             Box::new(stacked_bar::StackedBarExample::default()),

examples/performance/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "performance"
+version = "0.1.0"
+authors = ["egui_plot contributors"]
+license.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+publish = false
+
+[lints]
+workspace = true
+
+[dependencies]
+eframe = { workspace = true, features = ["default"] }
+egui_plot.workspace = true
+env_logger = { workspace = true, default-features = false, features = [
+    "auto-color",
+    "humantime",
+] }
+examples_utils.workspace = true
+
+[package.metadata.cargo-shear]
+ignored = ["env_logger"] # env_logger used by make_main! macro

examples/performance/README.md

@@ -0,0 +1,20 @@
+# Performance Demo
+
+This example demonstrates plotting performance with a large number of markers. Use the controls to adjust the number of markers and observe rendering performance.
+
+## Running
+
+Native
+```sh
+cargo run -p performance
+```
+
+Web (WASM)
+```sh
+cd examples/performance
+trunk serve
+```
+
+![](screenshot.png)
+
+

examples/performance/screenshot.png

@@ -0,0 +1,94 @@
+use eframe::egui;
+use eframe::egui::Response;
+use egui_plot::MarkerShape;
+use egui_plot::Plot;
+use egui_plot::Points;
+
+/// Simple LCG pseudo-random number generator. Returns a value in [0.0, 1.0].
+fn rng(state: &mut u64) -> f64 {
+    let mut x = *state;
+    x ^= x << 13;
+    x ^= x >> 7;
+    x ^= x << 17;
+    *state = x;
+    (x as f64) / (u64::MAX as f64)
+}
+
+fn make_markers(target_count: usize) -> Vec<[f64; 2]> {
+    let mut state = 42u64;
+    (0..target_count).map(|_| [rng(&mut state), rng(&mut state)]).collect()
+}
+
+pub struct PerformanceDemo {
+    target_count: usize,
+    marker_radius: f32,
+    markers: Vec<[f64; 2]>,
+    marker_shape: MarkerShape,
+}
+
+impl Default for PerformanceDemo {
+    fn default() -> Self {
+        Self {
+            target_count: 100,
+            marker_radius: 1.0,
+            markers: make_markers(100),
+            marker_shape: MarkerShape::Circle,
+        }
+    }
+}
+
+impl PerformanceDemo {
+    pub fn show_plot(&self, ui: &mut egui::Ui) -> Response {
+        Plot::new("performance_demo")
+            .data_aspect(1.0)
+            .show(ui, |plot_ui| {
+                plot_ui.points(
+                    Points::new("markers", self.markers.clone())
+                        .radius(self.marker_radius)
+                        .shape(self.marker_shape)
+                        .filled(true),
+                );
+            })
+            .response
+    }
+
+    pub fn show_controls(&mut self, ui: &mut egui::Ui) -> Response {
+        ui.ctx().request_repaint(); // Continuous repaint for FPS counter
+        let fps = (1.0 / ui.ctx().input(|i| i.stable_dt)).round();
+
+        ui.horizontal(|ui| {
+            ui.label("Markers:");
+            if ui
+                .add(
+                    egui::DragValue::new(&mut self.target_count)
+                        .speed(100)
+                        .range(100..=10_000_000),
+                )
+                .changed()
+            {
+                self.markers = make_markers(self.target_count);
+            }
+
+            ui.label("Radius:");
+            ui.add(
+                egui::DragValue::new(&mut self.marker_radius)
+                    .speed(0.1)
+                    .range(0.5..=5.0),
+            );
+
+            ui.label("Shape:");
+            egui::ComboBox::from_id_salt("marker_shape")
+                .selected_text(format!("{:?}", self.marker_shape))
+                .show_ui(ui, |ui| {
+                    for shape in MarkerShape::all() {
+                        ui.selectable_value(&mut self.marker_shape, shape, format!("{shape:?}"));
+                    }
+                });
+
+            ui.label(format!("FPS: {fps}"));
+        });
+
+        ui.label("Note: Less than 100k markers should work fine, beyond that may cause issues.");
+        ui.response()
+    }
+}

examples/performance/screenshot_thumb.png

@@ -0,0 +1,41 @@
+#![doc = include_str!("../README.md")]
+
+use eframe::egui;
+use examples_utils::PlotExample;
+
+mod app;
+pub use app::PerformanceDemo;
+
+impl PlotExample for PerformanceDemo {
+    fn name(&self) -> &'static str {
+        "performance"
+    }
+
+    fn title(&self) -> &'static str {
+        "Performance Demo"
+    }
+
+    fn description(&self) -> &'static str {
+        "This example demonstrates plotting performance with a large number of markers. Use the controls to adjust the number of markers and observe rendering performance."
+    }
+
+    fn tags(&self) -> &'static [&'static str] {
+        &["performance", "markers"]
+    }
+
+    fn thumbnail_bytes(&self) -> &'static [u8] {
+        include_bytes!("../screenshot_thumb.png")
+    }
+
+    fn code_bytes(&self) -> &'static [u8] {
+        include_bytes!("./app.rs")
+    }
+
+    fn show_ui(&mut self, ui: &mut egui::Ui) -> egui::Response {
+        self.show_plot(ui)
+    }
+
+    fn show_controls(&mut self, ui: &mut egui::Ui) -> egui::Response {
+        self.show_controls(ui)
+    }
+}