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

Document RenderingServer.get_video_adapter_name() may report a fixed name #80445

Merged
merged 1 commit into from
Aug 16, 2023
Merged

Document RenderingServer.get_video_adapter_name() may report a fixed name #80445

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 doc/classes/RenderingServer.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1450,6 +1450,7 @@
<description>
Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2").
[b]Note:[/b] When running a headless or server binary, this function returns an empty string.
[b]Note:[/b] On the web platform, some browsers such as Firefox may report a different, fixed GPU name such as "GeForce GTX 980" (regardless of the user's actual GPU model). This is done to make fingerprinting more difficult.
Copy link
Member

Choose a reason for hiding this comment

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

We'll need to unify the casing of "Web" vs "web", and define some guidelines.

$ rg -g"*.xml" " Web[, ]" | wc -l
45
$ rg -g"*.xml" " web[, ]" | wc -l
30

I think at least when referring to Godot's "Web" platform, it should be capitalized, like it is in OS.get_name().

Then maybe when referring to "the web", it can be lowercase.

Here with "the web platform", are we talking about the web as a platform, or Godot's "Web" platform?

Copy link
Member Author

Choose a reason for hiding this comment

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

Here with "the web platform", are we talking about the web as a platform, or Godot's "Web" platform?

I'd say the latter, but I don't have a strong opinion on it.

Copy link
Member

Choose a reason for hiding this comment

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

I guess this can/should be handled in a separate PR anyway, so let's merge this one.

</description>
</method>
<method name="get_video_adapter_type" qualifiers="const">
Expand Down
Loading