Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update options docs to clarify linux webview gpu defaults #4162

Merged
merged 4 commits into from
Apr 8, 2025
Merged

Update options docs to clarify linux webview gpu defaults #4162

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9c7dc05
Update options docs to clarify linux webview gpu defaults
brianetaveras Mar 25, 2025
9763cd3
Added updates to the changelog
brianetaveras Mar 31, 2025
e7643b8
Added more information to the documentation
brianetaveras Apr 1, 2025
dadf638
Merge branch 'master' into patch-3
brianetaveras Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions website/src/pages/changelog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed
- Updated recommendation for Svelte router in [#4085](https://github.com/wailsapp/wails/pull/4085) by [@benmccann](https://github.com/benmccann)
- Updated documentation to clarify `WebviewGpuPolicy` default behavior on Linux in [#4162](https://github.com/wailsapp/wails/pull/4162) by [@brianetaveras](https://github.com/brianetaveras)

### Added
- Added "Branding" section to `wails doctor` to correctly identify Windows 11 [#3891](https://github.com/wailsapp/wails/pull/3891) by [@ronen25](https://github.com/ronen25)
Expand Down
7 changes: 5 additions & 2 deletions website/versioned_docs/version-v2.10/reference/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ func main() {
Linux: &linux.Options{
Icon: icon,
WindowIsTranslucent: false,
WebviewGpuPolicy: linux.WebviewGpuPolicyAlways,
WebviewGpuPolicy: linux.WebviewGpuPolicyNever,
ProgramName: "wails"
},
Debug: options.Debug{
Expand Down Expand Up @@ -1066,7 +1066,10 @@ This option is used for determining the webview's hardware acceleration policy.

Name: WebviewGpuPolicy<br/>
Type: [`options.WebviewGpuPolicy`](#webviewgpupolicy-type)<br/>
Default: `WebviewGpuPolicyAlways`
Default (Windows, macOS): `WebviewGpuPolicyAlways`<br/>
Default (Linux): Due to [#2977](https://github.com/wailsapp/wails/issues/2977,), if `options.Linux` is nil
in the call to `wails.Run()`, `WebviewGpuPolicy` is set by default to `WebviewGpuPolicyNever`. You can override this behavior by passing a non-nil `Options` and set `WebviewGpuPolicy` as needed.


##### WebviewGpuPolicy type

Expand Down