`webgpu_preferred_adapter`¶

Since: Version 20221119-145034-49b9839f

The functionality described in this section requires version 20221119-145034-49b9839f of wezterm, or a more recent version.

Specifies which WebGpu adapter should be used.

This option is only applicable when you have configured front_end = "WebGpu".

You can use the wezterm.gui.enumerate_gpus() function to return a list of GPUs.

If you open the Debug Overlay (default: CTRL + SHIFT + L) you can interactively review the list:

> wezterm.gui.enumerate_gpus()
[
    {
        "backend": "Vulkan",
        "device": 29730,
        "device_type": "DiscreteGpu",
        "driver": "radv",
        "driver_info": "Mesa 22.3.4",
        "name": "AMD Radeon Pro W6400 (RADV NAVI24)",
        "vendor": 4098,
    },
    {
        "backend": "Vulkan",
        "device": 0,
        "device_type": "Cpu",
        "driver": "llvmpipe",
        "driver_info": "Mesa 22.3.4 (LLVM 15.0.7)",
        "name": "llvmpipe (LLVM 15.0.7, 256 bits)",
        "vendor": 65541,
    },
    {
        "backend": "Gl",
        "device": 0,
        "device_type": "Other",
        "name": "AMD Radeon Pro W6400 (navi24, LLVM 15.0.7, DRM 3.49, 6.1.9-200.fc37.x86_64)",
        "vendor": 4098,
    },
]

Based on that list, I might choose to explicitly target the discrete Gpu like this (but note that this would be the default selection anyway):

config.webgpu_preferred_adapter = {
  backend = 'Vulkan',
  device = 29730,
  device_type = 'DiscreteGpu',
  driver = 'radv',
  driver_info = 'Mesa 22.3.4',
  name = 'AMD Radeon Pro W6400 (RADV NAVI24)',
  vendor = 4098,
}
config.front_end = 'WebGpu'

alternatively, I might use:

local wezterm = require 'wezterm'
local config = {}
local gpus = wezterm.gui.enumerate_gpus()

config.webgpu_preferred_adapter = gpus[1]
config.front_end = 'WebGpu'
return config

If you have a more complex situation you can get a bit more elaborate; this example will only enable WebGpu if there is an integrated GPU available with Vulkan drivers:

local wezterm = require 'wezterm'
local config = {}

for _, gpu in ipairs(wezterm.gui.enumerate_gpus()) do
  if gpu.backend == 'Vulkan' and gpu.device_type == 'IntegratedGpu' then
    config.webgpu_preferred_adapter = gpu
    config.front_end = 'WebGpu'
    break
  end
end

return config

webgpu_preferred_adapter¶

`webgpu_preferred_adapter`¶