-
-
Notifications
You must be signed in to change notification settings - Fork 21.5k
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
Fill out Material documentation and clarify render_priority
and next_pass
sorting
#83931
Conversation
893dce4
to
f81e878
Compare
render_priority
and next_pass
sortingrender_priority
and next_pass
sorting
f81e878
to
85ca0a4
Compare
85ca0a4
to
6a66395
Compare
[b]Note:[/b] This only applies to [StandardMaterial3D]s and [ShaderMaterial]s with type "Spatial". | ||
[b]Note:[/b] This only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority). | ||
[b]Note:[/b] This will not impact how transparent objects are sorted relative to opaque objects or how dynamic meshes will be sorted relative to other opaque meshes. This is because all transparent objects are drawn after all opaque objects and all dynamic opaque meshes are drawn before other opaque meshes. |
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.
[b]Note:[/b] This will not impact how transparent objects are sorted relative to opaque objects or how dynamic meshes will be sorted relative to other opaque meshes. This is because all transparent objects are drawn after all opaque objects and all dynamic opaque meshes are drawn before other opaque meshes. | |
[b]Note:[/b] This will not affect how transparent objects are sorted relative to opaque objects, or how dynamic meshes will be sorted relative to other opaque meshes. This is because all transparent objects are drawn after all opaque objects and all dynamic opaque meshes are drawn before other opaque meshes. |
Small style nitpick (didn't just correct the spelling)
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 prefer "impact" and the comma is incorrect. Thanks anyways!
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 comma breaks up the long sentence, but impact/affect is preference based
But to me the current sentence is too long and needs a pause, the comma is correct (I'm not assuming an oxford comma incorrectly) but a matter of preference
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.
Generally speaking "impact" is considered to be more powerful than "affect" and generally considered negative (for example docs regularly use it to refer to performance), but it's a matter of preference
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.
We discussed following one of the existing patterns for the first sentences of virtual methods, which may still be worth doing. But this should be a great addition already.
Let's go forwards with this, additional style improvements can be done in a follow-up. Thanks! |
Cherry-picked for 4.1.4. (Including some changes from previous PRs updating the descriptions, since they were causing conflicts and we're invalidating translations anyway.) |
Partially address: #83774 (we still need to add more detail to the manual)