Use profiling crate to support more profiler backends

Cargo.lock

@@ -1235,7 +1235,7 @@ dependencies = [
  "parking_lot",
  "percent-encoding",
  "pollster 0.4.0",
- "puffin",
+ "profiling",
  "raw-window-handle 0.6.2",
  "ron",
  "serde",
@@ -1263,7 +1263,7 @@ dependencies = [
  "epaint",
  "log",
  "nohash-hasher",
- "puffin",
+ "profiling",
  "ron",
  "serde",
 ]
@@ -1278,7 +1278,7 @@ dependencies = [
  "egui",
  "epaint",
  "log",
- "puffin",
+ "profiling",
  "thiserror",
  "type-map",
  "web-time",
@@ -1296,7 +1296,7 @@ dependencies = [
  "document-features",
  "egui",
  "log",
- "puffin",
+ "profiling",
  "raw-window-handle 0.6.2",
  "serde",
  "smithay-clipboard",
@@ -1321,6 +1321,7 @@ dependencies = [
  "image",
  "log",
  "poll-promise",
+ "profiling",
  "puffin",
  "puffin_http",
  "rfd",
@@ -1360,7 +1361,7 @@ dependencies = [
  "image",
  "log",
  "mime_guess2",
- "puffin",
+ "profiling",
  "resvg",
  "serde",
  "syntect",
@@ -1380,7 +1381,7 @@ dependencies = [
  "glutin-winit",
  "log",
  "memoffset",
- "puffin",
+ "profiling",
  "wasm-bindgen",
  "web-sys",
  "winit",
@@ -1528,7 +1529,7 @@ dependencies = [
  "log",
  "nohash-hasher",
  "parking_lot",
- "puffin",
+ "profiling",
  "rayon",
  "serde",
 ]
@@ -3109,6 +3110,20 @@ name = "profiling"
 version = "1.0.16"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "afbdc74edc00b6f6a218ca6a5364d6226a259d4b8ea1af4a0ea063f27e179f4d"
+dependencies = [
+ "profiling-procmacros",
+ "puffin",
+]
+
+[[package]]
+name = "profiling-procmacros"
+version = "1.0.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a65f2e60fbf1063868558d69c6beacf412dc755f9fc020f514b7955fc914fe30"
+dependencies = [
+ "quote",
+ "syn",
+]
 
 [[package]]
 name = "puffin"
@@ -3147,6 +3162,7 @@ dependencies = [
  "eframe",
  "env_logger",
  "log",
+ "profiling",
  "puffin",
  "puffin_http",
 ]

Cargo.toml

@@ -87,6 +87,7 @@ log = { version = "0.4", features = ["std"] }
 nohash-hasher = "0.2"
 parking_lot = "0.12"
 pollster = "0.4"
+profiling = {version = "1.0", default-features = false }
 puffin = "0.19"
 puffin_http = "0.16"
 raw-window-handle = "0.6.0"

crates/eframe/Cargo.toml

@@ -71,19 +71,6 @@ persistence = [
   "serde",
 ]
 
-## Enable profiling with the [`puffin`](https://docs.rs/puffin) crate.
-##
-## `eframe` will call `puffin::GlobalProfiler::lock().new_frame()` for you
-##
-## Only enabled on native, because of the low resolution (1ms) of clocks in browsers.
-puffin = [
-  "dep:puffin",
-  "egui/puffin",
-  "egui_glow?/puffin",
-  "egui-wgpu?/puffin",
-  "egui-winit/puffin",
-]
-
 ## Enables wayland support and fixes clipboard issue.
 wayland = ["egui-winit/wayland", "egui-wgpu?/wayland", "egui_glow?/wayland", "glutin?/wayland", "glutin-winit?/wayland"]
 
@@ -127,6 +114,7 @@ ahash.workspace = true
 document-features.workspace = true
 log.workspace = true
 parking_lot.workspace = true
+profiling.workspace = true
 raw-window-handle.workspace = true
 static_assertions = "1.1.0"
 web-time.workspace = true
@@ -157,7 +145,6 @@ pollster = { workspace = true, optional = true } # needed for wgpu
 glutin = { workspace = true, optional = true, default-features = false, features = ["egl", "wgl"] }
 glutin-winit = { workspace = true, optional = true, default-features = false, features = ["egl", "wgl"] }
 home = { workspace = true, optional = true }
-puffin = { workspace = true, optional = true }
 wgpu = { workspace = true, optional = true, features = [
   # Let's enable some backends so that users can use `eframe` out-of-the-box
   # without having to explicitly opt-in to backends

crates/eframe/src/epi.rs

@@ -788,8 +788,7 @@ pub struct IntegrationInfo {
     ///
     /// This includes [`App::update`] as well as rendering (except for vsync waiting).
     ///
-    /// For a more detailed view of cpu usage, use the [`puffin`](https://crates.io/crates/puffin)
-    /// profiler together with the `puffin` feature of `eframe`.
+    /// For a more detailed view of cpu usage, connect your preferred profiler by enabling it's feature in [`profiling`](https://crates.io/crates/profiling).
     ///
     /// `None` if this is the first frame.
     pub cpu_usage: Option<f32>,
@@ -831,7 +830,7 @@ impl Storage for DummyStorage {
 /// Get and deserialize the [RON](https://github.com/ron-rs/ron) stored at the given key.
 #[cfg(feature = "ron")]
 pub fn get_value<T: serde::de::DeserializeOwned>(storage: &dyn Storage, key: &str) -> Option<T> {
-    crate::profile_function!(key);
+    profiling::function_scope!(key);
     storage
         .get_string(key)
         .and_then(|value| match ron::from_str(&value) {
@@ -847,7 +846,7 @@ pub fn get_value<T: serde::de::DeserializeOwned>(storage: &dyn Storage, key: &st
 /// Serialize the given value as [RON](https://github.com/ron-rs/ron) and store with the given key.
 #[cfg(feature = "ron")]
 pub fn set_value<T: serde::Serialize>(storage: &mut dyn Storage, key: &str, value: &T) {
-    crate::profile_function!(key);
+    profiling::function_scope!(key);
     match ron::ser::to_string(value) {
         Ok(string) => storage.set_string(key, string),
         Err(err) => log::error!("eframe failed to encode data using ron: {}", err),

crates/eframe/src/icon_data.rs

@@ -22,7 +22,7 @@ pub trait IconDataExt {
 /// # Errors
 /// If this is not a valid png.
 pub fn from_png_bytes(png_bytes: &[u8]) -> Result<IconData, image::ImageError> {
-    crate::profile_function!();
+    profiling::function_scope!();
     let image = image::load_from_memory(png_bytes)?;
     Ok(from_image(image))
 }
@@ -38,7 +38,7 @@ fn from_image(image: image::DynamicImage) -> IconData {
 
 impl IconDataExt for IconData {
     fn to_image(&self) -> Result<image::RgbaImage, String> {
-        crate::profile_function!();
+        profiling::function_scope!();
         let Self {
             rgba,
             width,
@@ -48,7 +48,7 @@ impl IconDataExt for IconData {
     }
 
     fn to_png_bytes(&self) -> Result<Vec<u8>, String> {
-        crate::profile_function!();
+        profiling::function_scope!();
         let image = self.to_image()?;
         let mut png_bytes: Vec<u8> = Vec::new();
         image

crates/eframe/src/lib.rs

@@ -129,6 +129,17 @@
 //! ## Feature flags
 #![doc = document_features::document_features!()]
 //!
+//! ## Instrumentation
+//! This crate supports using the [profiling](https://crates.io/crates/profiling) crate for instrumentation.
+//! You can enable features on the profiling crates in your application to add instrumentation for all
+//! crates that support it, including egui. See the profiling crate docs for more information.
+//! ```toml
+//! [dependencies]
+//! profiling = "1.0"
+//! [features]
+//! profile-with-puffin = ["profiling/profile-with-puffin"]
+//! ```
+//!
 
 #![warn(missing_docs)] // let's keep eframe well-documented
 #![allow(clippy::needless_doctest_main)]
@@ -445,33 +456,3 @@ impl std::fmt::Display for Error {
 
 /// Short for `Result<T, eframe::Error>`.
 pub type Result<T = (), E = Error> = std::result::Result<T, E>;
-
-// ---------------------------------------------------------------------------
-
-mod profiling_scopes {
-    #![allow(unused_macros)]
-    #![allow(unused_imports)]
-
-    /// Profiling macro for feature "puffin"
-    macro_rules! profile_function {
-        ($($arg: tt)*) => {
-            #[cfg(feature = "puffin")]
-            #[cfg(not(target_arch = "wasm32"))] // Disabled on web because of the coarse 1ms clock resolution there.
-            puffin::profile_function!($($arg)*);
-        };
-    }
-    pub(crate) use profile_function;
-
-    /// Profiling macro for feature "puffin"
-    macro_rules! profile_scope {
-        ($($arg: tt)*) => {
-            #[cfg(feature = "puffin")]
-            #[cfg(not(target_arch = "wasm32"))] // Disabled on web because of the coarse 1ms clock resolution there.
-            puffin::profile_scope!($($arg)*);
-        };
-    }
-    pub(crate) use profile_scope;
-}
-
-#[allow(unused_imports)]
-pub(crate) use profiling_scopes::{profile_function, profile_scope};

crates/eframe/src/native/app_icon.rs

@@ -59,7 +59,7 @@ enum AppIconStatus {
 /// Since window creation can be lazy, call this every frame until it's either successfully or gave up.
 /// (See [`AppIconStatus`])
 fn set_title_and_icon(_title: &str, _icon_data: Option<&IconData>) -> AppIconStatus {
-    crate::profile_function!();
+    profiling::function_scope!();
 
     #[cfg(target_os = "windows")]
     {
@@ -201,7 +201,7 @@ fn set_app_icon_windows(icon_data: &IconData) -> AppIconStatus {
 #[allow(unsafe_code)]
 fn set_title_and_icon_mac(title: &str, icon_data: Option<&IconData>) -> AppIconStatus {
     use crate::icon_data::IconDataExt as _;
-    crate::profile_function!();
+    profiling::function_scope!();
 
     use objc2::ClassType;
     use objc2_app_kit::{NSApplication, NSImage};
@@ -237,7 +237,7 @@ fn set_title_and_icon_mac(title: &str, icon_data: Option<&IconData>) -> AppIconS
             log::trace!("NSImage::initWithData…");
             let app_icon = NSImage::initWithData(NSImage::alloc(), &data);
 
-            crate::profile_scope!("setApplicationIconImage_");
+            profiling::scope!("setApplicationIconImage_");
             log::trace!("setApplicationIconImage…");
             app.setApplicationIconImage(app_icon.as_deref());
         }
@@ -246,7 +246,7 @@ fn set_title_and_icon_mac(title: &str, icon_data: Option<&IconData>) -> AppIconS
         if let Some(main_menu) = app.mainMenu() {
             if let Some(item) = main_menu.itemAtIndex(0) {
                 if let Some(app_menu) = item.submenu() {
-                    crate::profile_scope!("setTitle_");
+                    profiling::scope!("setTitle_");
                     app_menu.setTitle(&NSString::from_str(title));
                 }
             }