Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Warn user when a software rasterizer is used #5655

Merged
merged 4 commits into from
Mar 25, 2024
Merged

Warn user when a software rasterizer is used #5655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3d95195
Warn user when a software rasterizer is used
emilk Mar 22, 2024
9d7dd5b
Fix typo
emilk Mar 25, 2024
4b82372
Improve copy
emilk Mar 25, 2024
4b81773
even better copy
emilk Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions crates/re_renderer/src/context.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,7 @@ fn log_adapter_info(info: &wgpu::AdapterInfo) {
let human_readable_summary = adapter_info_summary(info);

if is_software_rasterizer_with_known_crashes {
re_log::warn!("Software rasterizer detected - expect poor performance and crashes. See: https://www.rerun.io/docs/getting-started/troubleshooting#graphics-issues");
re_log::warn!("Bad software rasterizer detected - expect poor performance and crashes. See: https://www.rerun.io/docs/getting-started/troubleshooting#graphics-issues");
re_log::info!("wgpu adapter {human_readable_summary}");
} else if info.device_type == wgpu::DeviceType::Cpu {
re_log::warn!("Software rasterizer detected - expect poor performance. See: https://www.rerun.io/docs/getting-started/troubleshooting#graphics-issues");
Expand All @@ -543,7 +543,7 @@ fn log_adapter_info(info: &wgpu::AdapterInfo) {
}

/// A human-readable summary about an adapter
fn adapter_info_summary(info: &wgpu::AdapterInfo) -> String {
pub fn adapter_info_summary(info: &wgpu::AdapterInfo) -> String {
let wgpu::AdapterInfo {
name,
vendor: _, // skip integer id
Expand Down
2 changes: 1 addition & 1 deletion crates/re_renderer/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ pub use colormap::{
colormap_inferno_srgb, colormap_magma_srgb, colormap_plasma_srgb, colormap_srgb,
colormap_turbo_srgb, colormap_viridis_srgb, grayscale_srgb, Colormap,
};
pub use context::RenderContext;
pub use context::{adapter_info_summary, RenderContext};
pub use debug_label::DebugLabel;
pub use depth_offset::DepthOffset;
pub use line_drawable_builder::{LineDrawableBuilder, LineStripBuilder};
Expand Down
25 changes: 25 additions & 0 deletions crates/re_viewer/src/ui/top_panel.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,31 @@ fn top_bar_ui(
connection_status_ui(ui, app.msg_receive_set());
}

if let Some(wgpu) = frame.wgpu_render_state() {
let info = wgpu.adapter.get_info();
if info.device_type == wgpu::DeviceType::Cpu {
// TODO(#4304): replace with a panel showing recent log messages
ui.hyperlink_to(
egui::RichText::new("⚠ Software rasterizer ⚠")
.small()
.color(ui.visuals().warn_fg_color),
"https://www.rerun.io/docs/getting-started/troubleshooting#graphics-issues",
)
.on_hover_ui(|ui| {
ui.label("Software rasterizer detected - expect poor performance.");
ui.label(
"Rerun requires hardware accelerated graphics (i.e. a GPU) for good performance.",
);
ui.label("Click for troubleshooting.");
ui.add_space(8.0);
ui.label(format!(
"wgpu adapter {}",
re_renderer::adapter_info_summary(&info)
));
});
}
}

// Warn if in debug build
if cfg!(debug_assertions) && !app.is_screenshotting() {
ui.vertical_centered(|ui| {
Expand Down
Loading