Skip to content

Commit

Permalink
Update troubleshooting guide with graphics driver updating advice
Browse files Browse the repository at this point in the history
  • Loading branch information
Wumpf committed Jul 4, 2024
1 parent 01d163c commit 81b9ce7
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/content/getting-started/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ sudo dnf install \
pkg-config
```

On WSL2, in addition to the above packages for Linux, you also need to run:
### WSL2

In addition to the above packages for Linux, you also need to run:

```sh
sudo apt-get -y install \
Expand All @@ -54,6 +56,13 @@ sudo apt-get -y install \
[TODO(#1250)](https://github.com/rerun-io/rerun/issues/1250): Running with the wayland window manager
sometimes causes Rerun to crash. Try unsetting the wayland display (`unset WAYLAND_DISPLAY` or `WAYLAND_DISPLAY= `) as a workaround.

If you have a multi-gpu setup, Mesa may only report the integrated GPU such that Rerun can't pick the dedicated graphics card.
To mitigate that set `export MESA_D3D12_DEFAULT_ADAPTER_NAME=NVIDIA` (or `export MESA_D3D12_DEFAULT_ADAPTER_NAME=AMD` respectively for an AMD graphics card).

Since the Mesa driver on WSL dispatches to the Windows host graphics driver, it is important to keep the Windows drivers up-to-date as well.
For example, [line rendering issues](https://github.com/rerun-io/rerun/issues/6749) have been observed when running from WSL with an
outdated AMD driver on the Windows host.

## Startup issues

If Rerun is having trouble starting, you can try resetting its memory with:
Expand All @@ -66,6 +75,8 @@ rerun reset

<!-- This section is linked to from `crates/re_viewer/src/native.rs` -->

Make sure to keep your graphics drivers updated.

[Wgpu](https://github.com/gfx-rs/wgpu) (the graphics API we use) maintains a list of
[known driver issues](https://github.com/gfx-rs/wgpu/wiki/Known-Driver-Issues) and workarounds for them.

Expand Down

0 comments on commit 81b9ce7

Please sign in to comment.