mirror of
https://github.com/emilk/egui.git
synced 2026-08-30 21:30:03 -04:00
3af907919b
Hey! I am not sure if this is something that's been considered before and decided against (I couldn't find any PR's or issues). This change removes the internal profiling macros in library crates and the `puffin` feature and replaces it with similar functions in the [profiling](https://github.com/aclysma/profiling) crate. This crate provides a layer of abstraction over various profiler instrumentation crates and allows library users to pick their favorite (supported) profiler. An additional benefit for puffin users is that dependencies of egui are included in the instrumentation output too (mainly wgpu which uses the profiling crate), so more details might be available when profiling. A breaking change is that instead of using the `puffin` feature on egui, users that want to profile the crate with puffin instead have to enable the `profile-with-puffin` feature on the profiling crate. Similarly they could instead choose to use `profile-with-tracy` etc. I tried to add a 'tracy' feature to egui_demo_app in order to showcase , however the /scripts/check.sh currently breaks on mutually exclusive features (which this introduces), so I decided against including it for the initial PR. I'm happy to iterate more on this if there is interest in taking this PR though. Screenshot showing the additional info for wgpu now available when using puffin 
86 lines
2.6 KiB
Rust
86 lines
2.6 KiB
Rust
//! Demo app for egui
|
|
|
|
#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] // hide console window on Windows in release
|
|
#![allow(rustdoc::missing_crate_level_docs)] // it's an example
|
|
#![allow(clippy::never_loop)] // False positive
|
|
|
|
// When compiling natively:
|
|
fn main() -> eframe::Result {
|
|
for arg in std::env::args().skip(1) {
|
|
match arg.as_str() {
|
|
"--profile" => {
|
|
#[cfg(feature = "puffin")]
|
|
start_puffin_server();
|
|
|
|
#[cfg(not(feature = "puffin"))]
|
|
panic!("Unknown argument: {arg} - you need to enable the 'puffin' feature to use this.");
|
|
}
|
|
|
|
_ => {
|
|
panic!("Unknown argument: {arg}");
|
|
}
|
|
}
|
|
}
|
|
|
|
{
|
|
// Silence wgpu log spam (https://github.com/gfx-rs/wgpu/issues/3206)
|
|
let mut rust_log = std::env::var("RUST_LOG").unwrap_or_else(|_| {
|
|
if cfg!(debug_assertions) {
|
|
"debug".to_owned()
|
|
} else {
|
|
"info".to_owned()
|
|
}
|
|
});
|
|
for loud_crate in ["naga", "wgpu_core", "wgpu_hal"] {
|
|
if !rust_log.contains(&format!("{loud_crate}=")) {
|
|
rust_log += &format!(",{loud_crate}=warn");
|
|
}
|
|
}
|
|
std::env::set_var("RUST_LOG", rust_log);
|
|
}
|
|
|
|
env_logger::init(); // Log to stderr (if you run with `RUST_LOG=debug`).
|
|
|
|
let options = eframe::NativeOptions {
|
|
viewport: egui::ViewportBuilder::default()
|
|
.with_inner_size([1280.0, 1024.0])
|
|
.with_drag_and_drop(true),
|
|
|
|
#[cfg(feature = "wgpu")]
|
|
renderer: eframe::Renderer::Wgpu,
|
|
|
|
..Default::default()
|
|
};
|
|
|
|
eframe::run_native(
|
|
"egui demo app",
|
|
options,
|
|
Box::new(|cc| Ok(Box::new(egui_demo_app::WrapApp::new(cc)))),
|
|
)
|
|
}
|
|
|
|
#[cfg(feature = "puffin")]
|
|
fn start_puffin_server() {
|
|
puffin::set_scopes_on(true); // tell puffin to collect data
|
|
|
|
match puffin_http::Server::new("127.0.0.1:8585") {
|
|
Ok(puffin_server) => {
|
|
log::info!("Run: cargo install puffin_viewer && puffin_viewer --url 127.0.0.1:8585");
|
|
|
|
std::process::Command::new("puffin_viewer")
|
|
.arg("--url")
|
|
.arg("127.0.0.1:8585")
|
|
.spawn()
|
|
.ok();
|
|
|
|
// We can store the server if we want, but in this case we just want
|
|
// it to keep running. Dropping it closes the server, so let's not drop it!
|
|
#[allow(clippy::mem_forget)]
|
|
std::mem::forget(puffin_server);
|
|
}
|
|
Err(err) => {
|
|
log::error!("Failed to start puffin server: {err}");
|
|
}
|
|
};
|
|
}
|