Add tooltips for the shader item
ClosedPublic
Actions

Authored by Arye Ramaty (BelgaratTheGrey) on May 6 2022, 5:39 PM.

Details

Reviewers

Commits

rB52c1f983cba3: UI: add missing tooltips for the shader node options

Summary

This patch adds tooltips to dropdown menus in the shader editor.
Be aware that this patch does not overlap and is complimentary to the awesome work done by @Filip Krátký (filip_kratky) .

https://developer.blender.org/D14866

Before

Currently, some of the nodes in the Shader editor lack tooltip. (there's not even a popup):

After

This patch adds some description to all of the dropdown menus.

Open Question

Some of those tooltips are from my observation and can be arguable. (Backmann, GGX, Ashikmim Shirley) .

Diff Detail

Repository: rB Blender

Event Timeline

Arye Ramaty (BelgaratTheGrey) requested review of this revision.May 6 2022, 5:39 PM

Arye Ramaty (BelgaratTheGrey) created this revision.

Arye Ramaty (BelgaratTheGrey) edited the summary of this revision. (Show Details)May 6 2022, 5:43 PM

Arye Ramaty (BelgaratTheGrey) edited the summary of this revision. (Show Details)

Arye Ramaty (BelgaratTheGrey) edited the summary of this revision. (Show Details)May 6 2022, 5:53 PM

Filip Krátký (filip_kratky) awarded a token.May 6 2022, 10:28 PM

@Lukas Stockner (lukasstockner97) @Brecht Van Lommel (brecht) Hey, maybe you can take a look at this patch please?

Brecht Van Lommel (brecht) requested changes to this revision.May 16 2022, 2:09 PM

Brecht Van Lommel (brecht) added inline comments.

source/blender/makesrna/intern/rna_nodetree.c
4549–4555	I don't think these description about "more impactful" or "brighter" are correct in general. I would not try to describe the difference like this because it's too difficult to say anything meaningful.
5658	I think more accurate would be "Number of dimensions to output noise for".
5664	This type of tooltip is not adding information, I rather have no tooltip unless there is something useful to say.
5721	Not adding information.
5728	Not adding information.
6048	I don't think the term "rendering light distribution" is correct terminology. A better description could be just: Light scattering distribution on rough surface
6114	Not sure what "base material" means.
6136	Not adding information.

This revision now requires changes to proceed.May 16 2022, 2:09 PM

Arye Ramaty (BelgaratTheGrey) added inline comments.May 17 2022, 9:39 PM

source/blender/makesrna/intern/rna_nodetree.c
4549–4555	I agree. My descriptions are somewhat vague indeed. The thing is, I think those specific options particularly are in need of descriptions, even the manual has no info regarding them. Adding ant descriptions may make those algorithms much more useable. IMHO, the visual characteristic is the only helpful way to describe those features. I use those articles as references, can you didact a better visual description from them? http://blog.gregzaal.com/2014/06/23/ashikhmin-shirley-distribution/ https://blender.stackexchange.com/questions/40586/what-do-glossy-distribution-models-do
5664	I think those kinds of tooltips are meant to be used as headers to the specific option tooltip. IMHO they are helpful when they are viewed in this context.
6048	I agree your description sound better, I used mine for consistency with the subsurface tooltip. Should I change it anyway?
6114	Does "The shader the toon effect is based on" make more sense?

Brecht Van Lommel (brecht) added inline comments.May 19 2022, 10:12 PM

source/blender/makesrna/intern/rna_nodetree.c
4549–4555	I don't think it's helpful to give a text description at all, users are not going to be able to pick BSDFs based on them, they need a visual comparison anyway. So just leave that out.
5664	Ok, fair enough.
6048	Yes, change it anyway. For subsurface scattering we are talking about different methods/algorithms to render the same distribution, where this is about different distributions.
6114	A better description would be "Use diffuse or glossy toon BSDF". It's really just like the difference between a Diffuse BSDF and Glossy BSDF, but for toon shading.

Updated Diff with all the requested corrections.

I am still unsure about the toon tooltip, I think it should be more like a header...

Tweak a few descriptions

Harbormaster completed remote builds in B22225: Diff 51763.May 23 2022, 7:08 PM

I've made some minor tweaks and think the descriptions are ok to commit now.

If you want to be mentioned as the git commit author, you will need to set a real name in your profile. Otherwise this will be committed with me as author, crediting your username in the description.

This revision is now accepted and ready to land.May 23 2022, 7:10 PM

Done.

Closed by commit rB52c1f983cba3: UI: add missing tooltips for the shader node options (authored by Arye Ramaty (BelgaratTheGrey), committed by Brecht Van Lommel (brecht)). · Explain WhyMay 27 2022, 5:11 PM

This revision was automatically updated to reflect the committed changes.

Brecht Van Lommel (brecht) added a commit: rB52c1f983cba3: UI: add missing tooltips for the shader node options.

Revision Contents
Changeset List

Path

Size

source/

blender/

makesrna/

intern/

rna_nodetree.c

186 lines

Diff 51252

View Options

source/blender/makesrna/intern/rna_nodetree.c

Add tooltips for the shader itemClosedPublicActions