mirror of
https://github.com/emilk/egui.git
synced 2026-08-30 13:20:05 -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 
113 lines
3.4 KiB
Rust
113 lines
3.4 KiB
Rust
//! [`egui`] bindings for [`glow`](https://github.com/grovesNL/glow).
|
|
//!
|
|
//! The main type you want to look at is [`Painter`].
|
|
//!
|
|
//! If you are writing an app, you may want to look at [`eframe`](https://docs.rs/eframe) instead.
|
|
//!
|
|
//! ## Feature flags
|
|
#![cfg_attr(feature = "document-features", doc = document_features::document_features!())]
|
|
//!
|
|
|
|
#![allow(clippy::float_cmp)]
|
|
#![allow(clippy::manual_range_contains)]
|
|
#![allow(clippy::undocumented_unsafe_blocks)]
|
|
|
|
pub mod painter;
|
|
pub use glow;
|
|
pub use painter::{CallbackFn, Painter, PainterError};
|
|
mod misc_util;
|
|
mod shader_version;
|
|
mod vao;
|
|
|
|
pub use shader_version::ShaderVersion;
|
|
|
|
#[cfg(feature = "winit")]
|
|
pub mod winit;
|
|
#[cfg(feature = "winit")]
|
|
pub use winit::*;
|
|
|
|
/// Check for OpenGL error and report it using `log::error`.
|
|
///
|
|
/// Only active in debug builds!
|
|
///
|
|
/// ``` no_run
|
|
/// # let glow_context = todo!();
|
|
/// use egui_glow::check_for_gl_error;
|
|
/// check_for_gl_error!(glow_context);
|
|
/// check_for_gl_error!(glow_context, "during painting");
|
|
/// ```
|
|
#[macro_export]
|
|
macro_rules! check_for_gl_error {
|
|
($gl: expr) => {{
|
|
if cfg!(debug_assertions) {
|
|
$crate::check_for_gl_error_impl($gl, file!(), line!(), "")
|
|
}
|
|
}};
|
|
($gl: expr, $context: literal) => {{
|
|
if cfg!(debug_assertions) {
|
|
$crate::check_for_gl_error_impl($gl, file!(), line!(), $context)
|
|
}
|
|
}};
|
|
}
|
|
|
|
/// Check for OpenGL error and report it using `log::error`.
|
|
///
|
|
/// WARNING: slow! Only use during setup!
|
|
///
|
|
/// ``` no_run
|
|
/// # let glow_context = todo!();
|
|
/// use egui_glow::check_for_gl_error_even_in_release;
|
|
/// check_for_gl_error_even_in_release!(glow_context);
|
|
/// check_for_gl_error_even_in_release!(glow_context, "during painting");
|
|
/// ```
|
|
#[macro_export]
|
|
macro_rules! check_for_gl_error_even_in_release {
|
|
($gl: expr) => {{
|
|
$crate::check_for_gl_error_impl($gl, file!(), line!(), "")
|
|
}};
|
|
($gl: expr, $context: literal) => {{
|
|
$crate::check_for_gl_error_impl($gl, file!(), line!(), $context)
|
|
}};
|
|
}
|
|
|
|
#[doc(hidden)]
|
|
pub fn check_for_gl_error_impl(gl: &glow::Context, file: &str, line: u32, context: &str) {
|
|
use glow::HasContext as _;
|
|
#[allow(unsafe_code)]
|
|
let error_code = unsafe { gl.get_error() };
|
|
if error_code != glow::NO_ERROR {
|
|
let error_str = match error_code {
|
|
glow::INVALID_ENUM => "GL_INVALID_ENUM",
|
|
glow::INVALID_VALUE => "GL_INVALID_VALUE",
|
|
glow::INVALID_OPERATION => "GL_INVALID_OPERATION",
|
|
glow::STACK_OVERFLOW => "GL_STACK_OVERFLOW",
|
|
glow::STACK_UNDERFLOW => "GL_STACK_UNDERFLOW",
|
|
glow::OUT_OF_MEMORY => "GL_OUT_OF_MEMORY",
|
|
glow::INVALID_FRAMEBUFFER_OPERATION => "GL_INVALID_FRAMEBUFFER_OPERATION",
|
|
glow::CONTEXT_LOST => "GL_CONTEXT_LOST",
|
|
0x8031 => "GL_TABLE_TOO_LARGE1",
|
|
0x9242 => "CONTEXT_LOST_WEBGL",
|
|
_ => "<unknown>",
|
|
};
|
|
|
|
if context.is_empty() {
|
|
log::error!(
|
|
"GL error, at {}:{}: {} (0x{:X}). Please file a bug at https://github.com/emilk/egui/issues",
|
|
file,
|
|
line,
|
|
error_str,
|
|
error_code,
|
|
);
|
|
} else {
|
|
log::error!(
|
|
"GL error, at {}:{} ({}): {} (0x{:X}). Please file a bug at https://github.com/emilk/egui/issues",
|
|
file,
|
|
line,
|
|
context,
|
|
error_str,
|
|
error_code,
|
|
);
|
|
}
|
|
}
|
|
}
|