Skip to content

Commit

Permalink
Print warning when using llvmpipe (bevyengine#13780)
Browse files Browse the repository at this point in the history
# Objective

Numerous people have been confused that Bevy runs slowly, when the
reason is that the `llvmpipe` software rendered is being used.

## Solution

Printing a warning could reduce the confusion.
  • Loading branch information
msvbg authored Jun 26, 2024
1 parent 19d078c commit 0ae7afb
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 2 deletions.
12 changes: 10 additions & 2 deletions crates/bevy_render/src/renderer/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ mod render_device;

use bevy_derive::{Deref, DerefMut};
use bevy_tasks::ComputeTaskPool;
use bevy_utils::tracing::{error, info, info_span};
use bevy_utils::tracing::{error, info, info_span, warn};
pub use graph_runner::*;
pub use render_device::*;

Expand All @@ -20,7 +20,8 @@ use bevy_time::TimeSender;
use bevy_utils::Instant;
use std::sync::Arc;
use wgpu::{
Adapter, AdapterInfo, CommandBuffer, CommandEncoder, Instance, Queue, RequestAdapterOptions,
Adapter, AdapterInfo, CommandBuffer, CommandEncoder, DeviceType, Instance, Queue,
RequestAdapterOptions,
};

/// Updates the [`RenderGraph`] with all of its nodes and then runs it to render the entire frame.
Expand Down Expand Up @@ -187,6 +188,13 @@ pub async fn initialize_renderer(
let adapter_info = adapter.get_info();
info!("{:?}", adapter_info);

if adapter_info.device_type == DeviceType::Cpu {
warn!(
"The selected adapter is using the a driver that only supports software rendering. \
This is likely to be very slow. See https://bevyengine.org/learn/errors/b0006/"
);
}

#[cfg(feature = "wgpu_trace")]
let trace_path = {
let path = std::path::Path::new("wgpu_trace");
Expand Down
30 changes: 30 additions & 0 deletions errors/B0006.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# B0006

A runtime warning.

Bevy's renderer is designed to be used with hardware acceleration. When initializing the renderer, Bevy will print an `AdapterInfo` line. If the driver in the `AdapterInfo` is indicated to be a software renderer, then the driver does not support hardware acceleration and Bevy will most likely be slow.

## Possible solutions

- Update your graphics driver. Your driver could simply be outdated.
- It is possible that the hardware itself is too old.
- You could try using a different backend for the `RenderPlugin`, for example the OpenGL backend. However, please be aware that this could reduce the renderer's performance on other systems that don't have this problem. Here's an example of how to do this:

```rust
fn main() {
App::new()
.add_plugins(
DefaultPlugins.set(RenderPlugin {
render_creation: WgpuSettings {
backends: Some(Backends::GL),
..default()
}
.into(),
..default()
}),
)
.run();
}
```

The backend can also be configured using environment variables, by setting `WGPU_BACKEND=[backend]` on Linux/Mac or `set WGPU_BACKEND=[backend]` on Windows, where `[backend]` is one of `vulkan`, `metal`, `dx12`, or `gl`.

0 comments on commit 0ae7afb

Please sign in to comment.