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.

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

Merged
merged 1 commit into from
Nov 14, 2024

Conversation

skyace65
Copy link
Contributor

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.

@skyace65 skyace65 added enhancement area:manual Issues and PRs related to the Manual/Tutorials section of the documentation cherrypick:4.3 labels Nov 13, 2024
@skyace65 skyace65 force-pushed the XR-Renderer branch 2 times, most recently from f672e4b to 8a3aa61 Compare November 13, 2024 01:36
Comment on lines 151 to 153
| XR | ✔️ Yes. Recommended for | ✔️ Yes. Recommended for | ⚠️ Supported, but poorly |
| | stand-alone headsets | desktop headsets | optimized. Use Mobile or |
| | | | Compatibility instead. |
Copy link
Contributor

@tetrapod00 tetrapod00 Nov 13, 2024

Choose a reason for hiding this comment

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

Suggested change
| 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

Suggested change
| 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. |

- 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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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

@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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.

Suggested change
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.

Copy link
Contributor Author

@skyace65 skyace65 Nov 13, 2024

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.

Copy link
Contributor

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

Copy link
Contributor

@tetrapod00 tetrapod00 left a 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

@@ -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 |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| XR | ✔️ Yes. Recommended for | ✔️ Yes. Recommended for | ⚠️ Supported, but poorly |
| XR | ✔️ Yes. Recommended for | ✔️ Yes. Recommended for | ⚠️ Supported, but poorly |

@mhilbrunner mhilbrunner merged commit 19804cc into godotengine:master Nov 14, 2024
1 check passed
@mhilbrunner
Copy link
Member

Thanks!

@tetrapod00
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:manual Issues and PRs related to the Manual/Tutorials section of the documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants