-
-
Notifications
You must be signed in to change notification settings - Fork 23.8k
Fix miscellaneous oddities around the class reference (part 7) #113261
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
Fix miscellaneous oddities around the class reference (part 7) #113261
Conversation
fedde33 to
2103fe3
Compare
AThousandShips
left a comment
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.
The phrasing and formatting looks good to me, would be good to get some area eyes to make sure the descriptions are correct while we're here so we don't have to fix them again later
And of course make sure to remove the CI disable before merge
| Returns [code]true[/code] if OpenXR's foveation extension is supported, the interface must be initialized before this returns a valid value. | ||
| [b]Note:[/b] This feature is only available on the Compatibility renderer and currently only available on some stand alone headsets. For Vulkan set [member Viewport.vrs_mode] to [code]VRS_XR[/code] on desktop. | ||
| Returns [code]true[/code] if OpenXR's foveation extension is supported. The interface must be initialized before this returns a valid value. | ||
| [b]Note:[/b] This feature is only available on the Compatibility renderer and currently only available on some standalone headsets. For Vulkan set [member Viewport.vrs_mode] to [code]VRS_XR[/code] on 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.
Oo, this line isn't true anymore. I guess I should probably do this in another PR, but the truth is more like this:
| [b]Note:[/b] This feature is only available on the Compatibility renderer and currently only available on some standalone headsets. For Vulkan set [member Viewport.vrs_mode] to [code]VRS_XR[/code] on desktop. | |
| [b]Note:[/b] On Vulkan, also set [member Viewport.vrs_mode] to [code]VRS_XR[/code]. |
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.
I didn't use the exact suggestion but I assume you meant something like this:
[b]Note:[/b] When using the Vulkan rendering driver, [member Viewport.vrs_mode] must be set to [constant Viewport.VRS_XR] to support foveation.
dsnopek
left a comment
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.
The XR related changes look good to me!
2103fe3 to
5b8b9ac
Compare
5b8b9ac to
4dec668
Compare
Repiteo
left a comment
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.
Great work!
|
Thanks! |
Continuation of #107536
This PR addressed yet yet another huge chunk of class reference oddities I remembered to note down for later while localizing the class reference. Some of these are clear typos, some are inconsistencies, some are just awkward.
Of particular note:
[method duplicate][code](true)[/code]ProjectSettings.gui/common/swap_cancel_okandEditorSettings.interface/editor/accept_dialog_cancel_ok_buttonsDisplayServer.get_swap_cancel_okshould be encouraged, instead.Dictionary.set's description aroundDictionary.set()return value in docs #112261 . If you have suggestions feel free to say[code]tags more oftenResourceUID.ensure_pathProjectSettings.audio/general/text_to_speechPath3D.debug_custom_colorPerformance.NAVIGATION_2D/3D_ACTIVE_MAPSmentioning two maps, leftover from the NavigationServer splitFor some of the descriptions affected, additional tweaks have been made to justify a whole translation string change.