From 81b9ce7fc1ce5c4fd28bd7947fe642954fa74634 Mon Sep 17 00:00:00 2001 From: Andreas Reich Date: Thu, 4 Jul 2024 10:50:40 +0200 Subject: [PATCH] Update troubleshooting guide with graphics driver updating advice --- docs/content/getting-started/troubleshooting.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/content/getting-started/troubleshooting.md b/docs/content/getting-started/troubleshooting.md index a4aca4a3a114..d35386e4356a 100644 --- a/docs/content/getting-started/troubleshooting.md +++ b/docs/content/getting-started/troubleshooting.md @@ -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 \ @@ -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: @@ -66,6 +75,8 @@ rerun reset +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.