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

Jump to bottom

Update options docs to clarify linux webview gpu defaults #4162

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update options docs to clarify linux webview gpu defaults #4162

wants to merge 4 commits into from

Conversation

brianetaveras
Copy link

@brianetaveras brianetaveras commented Mar 25, 2025 •
edited by coderabbitai bot
Loading

Description

I noticed a significant performance degradation when working with Pixi.js on my wails app vs the browser. Community members on Discord helped me figure out that hardware acceleration is disabled by default for linux builts - this is documented in code but not reflected on the docs.

wails-performance.mp4

Please let me know if I need to include more details.

Fixes # (issue)

N/A

Type of change

Please select the option that is relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using wails doctor.

  • Windows
  • macOS
  • Linux
  • N/A: Docs Change

If you checked Linux, please specify the distro and version.

Test Configuration

Please paste the output of wails doctor. If you are unable to run this command, please describe your environment in as much detail as possible.

N/A: Docs Change

Checklist:

  • I have updated website/src/pages/changelog.mdx with details of this PR
  • My code follows the general coding style of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • New Features
    • Adjusted Linux behavior so that GPU hardware acceleration is now disabled by default, ensuring a consistent experience across platforms.
  • Documentation

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 25, 2025 •
edited
Loading

Walkthrough

The pull request updates the documentation in the configuration file for version v2.10. Specifically, the Linux option for WebviewGpuPolicy is changed from WebviewGpuPolicyAlways to WebviewGpuPolicyNever. The documentation now explicitly notes that while Windows and macOS retain WebviewGpuPolicyAlways, Linux defaults to WebviewGpuPolicyNever. Additionally, a changelog entry has been added to clarify this change.

Changes

File Change Summary
website/.../options.mdx Updated the Linux WebviewGpuPolicy default from WebviewGpuPolicyAlways to WebviewGpuPolicyNever and revised documentation to reflect OS-specific defaults.
website/.../changelog.mdx Added a changelog entry under "Changed" section to clarify the default behavior of WebviewGpuPolicy on Linux, referencing PR #4162 and contributor @brianetaveras.

Possibly related PRs

Suggested reviewers

  • leaanthony

Poem

I’m the rabbit on the run, hopping through the code,
With changes crisp and clear, I lighten every load.
Linux now takes a pause for GPU, never in a dash,
While Windows and mac still enjoy a speedy flash.
Hop along with me, in this doc-filled, joyful spree!
🐰✨

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Mar 25, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
website/versioned_docs/version-v2.10/reference/options.mdx (1)

1067-1071: Enhanced Default Values Documentation for GPU Policy
The updated section now explicitly documents that while Windows and macOS use WebviewGpuPolicyAlways, Linux defaults to WebviewGpuPolicyNever. This clarification is beneficial for users comparing Linux behavior against other OSes. To further improve clarity, consider adding a brief note explaining the rationale—such as performance issues encountered with hardware acceleration in Linux environments—for users who might wish to override this default.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 993fde1 and 9c7dc05.

📒 Files selected for processing (1)
  • website/versioned_docs/version-v2.10/reference/options.mdx (2 hunks)
🔇 Additional comments (1)
website/versioned_docs/version-v2.10/reference/options.mdx (1)

127-131: Linux GPU Policy Default Update
The Linux options now set WebviewGpuPolicy to linux.WebviewGpuPolicyNever. This change clearly indicates that GPU hardware acceleration is disabled by default on Linux. Given the performance concerns raised with Pixi.js, this update mitigates confusion by aligning the documentation with the actual defaults used in Linux builds.

@leaanthony
Copy link
Member

Thanks 🙏 Please could you add an entry to the changelog located at website/src/pages/changelog.mdx?

coderabbitai[bot]
coderabbitai bot reviewed Apr 1, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
website/src/pages/changelog.mdx (1)

19-19: Clarify the Updated Default Value in the Changelog Entry

The changelog entry clearly indicates that the documentation for WebviewGpuPolicy on Linux was updated in [#4162]. For extra clarity, consider including the specific default value (i.e., WebviewGpuPolicyNever) directly in the entry. This extra detail can help users immediately understand that Linux builds now disable GPU acceleration by default, which is central to the PR's objective.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9c7dc05 and e7643b8.

📒 Files selected for processing (2)
  • website/src/pages/changelog.mdx (1 hunks)
  • website/versioned_docs/version-v2.10/reference/options.mdx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • website/versioned_docs/version-v2.10/reference/options.mdx

@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Apr 1, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@brianetaveras
Copy link
Author

Thanks 🙏 Please could you add an entry to the changelog located at website/src/pages/changelog.mdx?

Done. I thought that was only for code changes - my bad! I also added a bit more context to the documentation changes. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@brianetaveras @leaanthony