Skip to content

Commit

Permalink
docs: improve docs; refactor: GpuAdapter - pick() -> pick_best()
Browse files Browse the repository at this point in the history
  • Loading branch information
KevinSilvester committed Apr 1, 2024
1 parent 6f7d291 commit bac5682
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,17 @@
1. <details>
<summary>Best GPU available</summary>

(`Discrete` > `Integrated` > `Other` (for `wgpu`'s OpenGl implementation on Discrete GPU) > `Cpu`)
`Discrete` > `Integrated` > `Other` (for `wgpu`'s OpenGl implementation on Discrete GPU) > `Cpu`
</details>

2. <details>
<summary>Best graphics API available (based off my very scientific scroll a big log file in Neovim test 😁)</summary>

> see: <https://github.com/gfx-rs/wgpu#supported-platforms> for more info
> :bulb:<br>
> The available graphics API choices change based on your OS.<br>
> These options correspond to the APIs the `wgpu` crate which (powers WezTerm's gui in `WebGpu` mode)<br>
> currenly has support implemented for.<br>
> See: <https://github.com/gfx-rs/wgpu#supported-platforms> for more info
- Windows: `Dx12` > `Vulkan` > `OpenGl`
- Linux: `Vulkan` > `OpenGl`
Expand Down
2 changes: 1 addition & 1 deletion config/appearance.lua
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ return {
max_fps = 60,
front_end = 'WebGpu',
webgpu_power_preference = 'HighPerformance',
webgpu_preferred_adapter = gpu_adapters:pick(),
webgpu_preferred_adapter = gpu_adapters:pick_best(),

-- color scheme
colors = colors,
Expand Down
2 changes: 1 addition & 1 deletion utils/gpu_adapter.lua
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ end
---If you want to manually choose the adapter, use `GpuAdapters:pick_manual(backend, device_type)`
---Or feel free to re-arrange `GpuAdapters.AVAILABLE_BACKENDS` to you liking
---@return WeztermGPUAdapter|nil
function GpuAdapters:pick()
function GpuAdapters:pick_best()
local adapters_options = self.DiscreteGpu

if not adapters_options then
Expand Down

0 comments on commit bac5682

Please sign in to comment.