-
-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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.
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 recommended renderer for XR #10256
Conversation
f672e4b
to
8a3aa61
Compare
tutorials/rendering/renderers.rst
Outdated
| XR | ✔️ Yes. Recommended for | ✔️ Yes. Recommended for | ⚠️ Supported, but poorly | | ||
| | stand-alone headsets | desktop headsets | optimized. Use Mobile or | | ||
| | | | Compatibility instead. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| XR | ✔️ Yes. Recommended for | ✔️ Yes. Recommended for | ⚠️ Supported, but poorly | | |
| | stand-alone headsets | desktop headsets | optimized. Use Mobile or | | |
| | | | Compatibility instead. | | |
| XR | ✔️ Yes. Recommended for | ✔️ Yes. Recommended for | ⚠️ Supported, but poorly | | |
| | stand-alone headsets. | desktop headsets. | optimized. Use Mobile or | | |
| | | | Compatibility instead. | |
The tables are misaligned. It's because emojis are annoyingly not monospaced, but a space and a half. I did my best guess to fix it with the web UI.
Also while I'm here, the rest of the table uses periods at the end.
Also consider "standalone" as one word instead of hyphenated. It's currently split within the docs and "standalone" seems common in general usage
| XR | ✔️ Yes. Recommended for | ✔️ Yes. Recommended for | ⚠️ Supported, but poorly | | |
| | stand-alone headsets | desktop headsets | optimized. Use Mobile or | | |
| | | | Compatibility instead. | | |
| XR | ✔️ Yes. Recommended for | ✔️ Yes. Recommended for | ⚠️ Supported, but poorly | | |
| | standalone headsets. | desktop headsets. | optimized. Use Mobile or | | |
| | | | Compatibility instead. | |
tutorials/rendering/renderers.rst
Outdated
- You are developing for older mobile devices, or older desktop devices. The | ||
Compatibility renderer supports the widest range of hardware. | ||
- You are developing for older mobile devices, older desktop devices, or | ||
stand-alone XR. The Compatibility renderer supports the widest range of hardware. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
stand-alone XR. The Compatibility renderer supports the widest range of hardware. | |
standalone XR. The Compatibility renderer supports the widest range of hardware. |
Consider "standalone" as one word instead of hyphenated. It's currently split within the docs and "standalone" seems common in general usage
tutorials/xr/setting_up_xr.rst
Outdated
@@ -40,7 +40,8 @@ While in Godot 3 most things worked out of the box, Godot 4 needs a little more | |||
|
|||
.. note:: | |||
Godot 4 has 3 renderer options, Compatibility, Mobile, and Forward+. In the future XR desktop projects should use Forward+, and projects for stand-alone headsets | |||
should use Mobile. However Compatibility is the recommended renderer for now due to it having the best XR performance. | |||
should use Mobile. Currently Compatibility is the recommended renderer for stand-alone headsets, and ironically Mobile is the recommended renderer for desktop. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should use Mobile. Currently Compatibility is the recommended renderer for stand-alone headsets, and ironically Mobile is the recommended renderer for desktop. | |
should use Mobile. Currently Compatibility is the recommended renderer for standalone headsets, and ironically Mobile is the recommended renderer for desktop. |
Single word, not hyphenated.
should use Mobile. Currently Compatibility is the recommended renderer for stand-alone headsets, and ironically Mobile is the recommended renderer for desktop. | |
should use Mobile. Currently Compatibility is the recommended renderer for standalone headsets, and Mobile is the recommended renderer for desktop XR. Forward+ *can* run XR, but struggles with performance. |
Optional suggestion. Subjectively I'm not a fan of "ironically" here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Normally I wouldn't want to be casual and use "ironically". However I feel like if we don't put in something to say "we didn't mix up the recommendations" people are gonna assume we accidentally swapped the recommendations, because you would logically assume Mobile is for stand-alone headsets.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense, like I said, subjective and optional suggestion
8a3aa61
to
177c7f6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Table still needs another space
tutorials/rendering/renderers.rst
Outdated
@@ -148,8 +148,9 @@ Overall comparison | |||
| | | | optimized. Use Mobile or | | |||
| | | | Compatibility instead. | | |||
+---------------------+--------------------------+--------------------------+--------------------------+ | |||
| XR | ✔️ Yes. | ✔️ Yes. | ✔️ Yes. | | |||
| | | | | | |||
| XR | ✔️ Yes. Recommended for | ✔️ Yes. Recommended for | ⚠️ Supported, but poorly | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| XR | ✔️ Yes. Recommended for | ✔️ Yes. Recommended for | ⚠️ Supported, but poorly | | |
| XR | ✔️ Yes. Recommended for | ✔️ Yes. Recommended for | ⚠️ Supported, but poorly | |
177c7f6
to
36088f3
Compare
Thanks! |
IMO this is not a cherrypick because it's half a change to the tables introduced in #10114, which was not cherrypicked. The other half changes the recommended renderer for desktop, but recommending Compatibility isn't exactly harmful so I don't think this is the most important thing to cherrypick, and it doesn't apply cleanly. |
Updates the renderer recommendation for XR projects in the renderers page as well as the XR page. These recommendations were provided by Mux213 in rocket chat.