blender/blender
166
520
Fork 792
Code Issues 6.8k Pull Requests 952 Projects 21 Wiki Activity

UI: Add Input descriptions for Principled BSDF parameters #119131

Merged
Brecht Van Lommel merged 2 commits from Bartosz-Kosiorek/blender:desc into main 2024-03-06 18:24:32 +01:00
Conversation 0 Commits 2 Files Changed 1 +45 -11
Bartosz Kosiorek commented 2024-03-06 17:16:51 +01:00
Contributor
Copy Link

The BSDF Principled is a default shader.
It is missing Input descriptions, which cause confusion for beginners.
Instead of description there is only message:

  Input value used for unconnected socket.

Which is unclear for beginners.

With this commit the Input parameters are described for BSDG Principled.
It is now eadier to understand the meanings of Input Parameters.

The BSDF Principled is a default shader. It is missing Input descriptions, which cause confusion for beginners. Instead of description there is only message: ``` Input value used for unconnected socket. ``` Which is unclear for beginners. With this commit the Input parameters are described for BSDG Principled. It is now eadier to understand the meanings of Input Parameters.
Screenshot 2024-03-06.png
34 KiB
Screenshot after fix with description.png
85 KiB
Screenshot 2024-03-06.png Screenshot after fix with description.png
👍 1 ❤️ 3
Bartosz Kosiorek requested review from Omar Emara 2024-03-06 17:19:32 +01:00
Bartosz Kosiorek requested review from Brecht Van Lommel 2024-03-06 17:20:43 +01:00
Brecht Van Lommel requested review from Lukas Stockner 2024-03-06 17:22:11 +01:00
Brecht Van Lommel removed review request for Omar Emara 2024-03-06 17:22:12 +01:00
Brecht Van Lommel requested review from Weizhen Huang 2024-03-06 17:22:12 +01:00
Hans Goudey changed title from Fix: Add Input description for BSDF Principled parameters. to UI: Add Input descriptions for Principled BSDF parameters 2024-03-06 17:31:07 +01:00
Bartosz Kosiorek force-pushed desc from 156334b358 to dcd995991d 2024-03-06 17:54:20 +01:00 Compare
Bartosz Kosiorek force-pushed desc from dcd995991d to f50cc052ad 2024-03-06 17:57:33 +01:00 Compare
Brecht Van Lommel added 1 commit 2024-03-06 18:21:14 +01:00
Brecht Van Lommel approved these changes 2024-03-06 18:21:56 +01:00
Brecht Van Lommel left a comment
Owner
Copy Link

Thanks!

Thanks!
Brecht Van Lommel merged commit bfee43a5c9 into main 2024-03-06 18:24:32 +01:00
Brecht Van Lommel deleted branch desc 2024-03-06 18:24:34 +01:00
Hans Goudey reviewed 2024-03-06 18:28:12 +01:00
Hans Goudey left a comment
Member
Copy Link

Some of these are much more detailed than typical descriptions (for example "The default value of 1.5 is a good approximation for glass" isn't something we'd usually write in a tooltip). But this is such a common node that maybe it's fine. It is probably helpful anyway.

Some of these are much more detailed than typical descriptions (for example "The default value of 1.5 is a good approximation for glass" isn't something we'd usually write in a tooltip). But this is such a common node that maybe it's fine. It is probably helpful anyway.
source/blender/nodes/shader/nodes/node_shader_bsdf_principled.cc
@ -98,0 +117,4 @@
.description(
"Directionanltiy of volume scattering within the subsurface medium. "
"Zero scatters uniformly in all directions, with higher values "
"scattering more strongly forward. For example skin has been measured "
Hans Goudey commented 2024-03-06 18:26:24 +01:00
Member
Copy Link

For example -> For example,

`For example` -> `For example,`
Bartosz-Kosiorek marked this conversation as resolved
source/blender/nodes/shader/nodes/node_shader_bsdf_principled.cc
@ -135,2 +163,3 @@
.max(1.0f)
.subtype(PROP_FACTOR);
.subtype(PROP_FACTOR)
.description("Rotates the direction of anisotropy, with 1.0 going full circle");
Hans Goudey commented 2024-03-06 18:25:50 +01:00
Member
Copy Link

going full circle -> meaning a full rotation

`going full circle` -> `meaning a full rotation`
Weizhen Huang commented 2024-03-06 21:38:30 +01:00
Member
Copy Link

Still not quite clear to me. Might be better to change the unit of the input to degrees, but it's out of scope of this patch.

Still not quite clear to me. Might be better to change the unit of the input to degrees, but it's out of scope of this patch.
Bartosz-Kosiorek marked this conversation as resolved
source/blender/nodes/shader/nodes/node_shader_bsdf_principled.cc
@ -225,1 +256,3 @@
.short_label("Strength");
.short_label("Strength")
.description(
"Strength of the emitted light. A value of 1.0 will ensure "
Hans Goudey commented 2024-03-06 18:25:21 +01:00
Member
Copy Link
  • will ensure -> ensures
- `will ensure` -> `ensures`
Bartosz-Kosiorek marked this conversation as resolved
Weizhen Huang reviewed 2024-03-06 22:01:50 +01:00
source/blender/nodes/shader/nodes/node_shader_bsdf_principled.cc
@ -43,1 +54,3 @@
b.add_input<decl::Float>("IOR").default_value(1.5f).min(1.0f).max(1000.0f);
b.add_input<decl::Float>("IOR").default_value(1.5f).min(1.0f).max(1000.0f).description(
"Index of refraction for specular reflection and transmission. "
"For most materials, the IOR is between 1.0 (vacuum and air) and 4.0 (germanium). "
Weizhen Huang commented 2024-03-06 21:58:53 +01:00
Member
Copy Link

This sentence doesn't appear in the manual. Is it taken from somewhere else?

This sentence doesn't appear in the manual. Is it taken from somewhere else?
Bartosz Kosiorek commented 2024-03-06 23:25:33 +01:00
Author
Contributor
Copy Link

https://en.m.wikipedia.org/wiki/List_of_refractive_indices

https://en.m.wikipedia.org/wiki/List_of_refractive_indices
Bartosz-Kosiorek marked this conversation as resolved
source/blender/nodes/shader/nodes/node_shader_bsdf_principled.cc
@ -97,1 +116,3 @@
.short_label("Anisotropy");
.short_label("Anisotropy")
.description(
"Directionanltiy of volume scattering within the subsurface medium. "
Weizhen Huang commented 2024-03-06 22:01:14 +01:00
Member
Copy Link

Directionality

Directionality
Bartosz-Kosiorek marked this conversation as resolved
source/blender/nodes/shader/nodes/node_shader_bsdf_principled.cc
@ -137,2 +166,3 @@
#define SOCK_ANISOTROPIC_ROTATION_ID 15
spec.add_input<decl::Vector>("Tangent").hide_value();
spec.add_input<decl::Vector>("Tangent").hide_value().description(
"Controls the tangent line for the Anisotropic layer");
Weizhen Huang commented 2024-03-06 21:49:29 +01:00
Member
Copy Link

"Controls the tangent direction for anisotropy"
tangent direction is not the same as tangent line, and anisotropic is not a layer.

"Controls the tangent direction for anisotropy" tangent direction is not the same as tangent line, and anisotropic is not a layer.
Bartosz-Kosiorek marked this conversation as resolved
Sign in to join this conversation.
Reviewers
No reviewers
Lukas Stockner
Weizhen Huang
Brecht Van Lommel
Labels
Clear labels   
Interest
Alembic

  
Interest
Animation & Rigging

  
Interest
Audio

  
Interest
Automated Testing

  
Interest
Blender Asset Bundle

  
Interest
BlendFile

  
Interest
Code Documentation
Code comments, Python/RNA API descriptions

  
Interest
Collada

  
Interest
Compatibility
Backward and forward compatibility

  
Interest
Compositing

  
Interest
Core

  
Interest
Cycles

  
Interest
Dependency Graph

  
Interest
Development Management

  
Interest
EEVEE

  
Interest
Freestyle

  
Interest
Geometry Nodes

  
Interest
Grease Pencil

  
Interest
ID Management

  
Interest
Images & Movies

  
Interest
Import Export

  
Interest
Line Art

  
Interest
Masking

  
Interest
Metal

  
Interest
Modeling

  
Interest
Modifiers

  
Interest
Motion Tracking

  
Interest
Nodes & Physics

  
Interest
OpenGL

  
Interest
Overlay

  
Interest
Overrides

  
Interest
Performance

  
Interest
Physics

  
Interest
Pipeline & IO

  
Interest
Platforms, Builds & Tests

  
Interest
Python API

  
Interest
Render & Cycles

  
Interest
Render Pipeline

  
Interest
Sculpt, Paint & Texture

  
Interest
Text Editor

  
Interest
Translations

  
Interest
Triaging

  
Interest
Undo

  
Interest
USD

  
Interest
User Interface

  
Interest
UV Editing

  
Interest
VFX & Video

  
Interest
Video Sequencer

  
Interest
Viewport & EEVEE

  
Interest
Virtual Reality

  
Interest
Vulkan

  
Interest
Wayland
Wayland windowing on Unix

  
Interest
Workbench

  
Interest: X11

Xorg/X11 windowing

  
Legacy
Asset Browser Project

Archived

  
Legacy
Blender 2.8 Project

Archived

  
Legacy
Milestone 1: Basic, Local Asset Browser

Archived

  
Legacy
OpenGL Error

Archived

  
Meta
Good First Issue

  
Meta
Papercut

  
Meta
Retrospective

  
Meta
Security
Related to security, see policy: https://developer.blender.org/docs/handbook/bug_reports/vulnerability_reports/

  
Module
Animation & Rigging

  
Module
Asset System
Asset datablocks, libraries, browser and shelf

  
Module
Asset System

  
Module
Core

  
Module
Development Management

  
Module
Grease Pencil

  
Module
Modeling

  
Module
Nodes & Physics

  
Module
Pipeline & IO

  
Module
Platforms, Builds & Tests

  
Module
Python API

  
Module
Render & Cycles

  
Module
Sculpt, Paint & Texture

  
Module
Triaging

  
Module
User Interface

  
Module
VFX & Video

  
Module
Viewport & EEVEE

  
Platform
FreeBSD

  
Platform
Linux

  
Platform
macOS

  
Platform
Windows

  
Severity
High

  
Severity
Low

  
Severity
Normal

  
Severity
Unbreak Now!

  
Status
Archived

  
Status
Confirmed

  
Status
Duplicate

  
Status
Needs Info from Developers

  
Status
Needs Information from User

  
Status
Needs Triage

  
Status
Resolved

  
Type
Bug

  
Type
Design

  
Type
Known Issue

  
Type
Patch

Archived

  
Type
Report

Archived

  
Type
To Do

No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Code Documentation
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Viewport & EEVEE
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Asset Browser Project
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Asset System
Module
Asset System
Module
Core
Module
Development Management
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Module
Viewport & EEVEE
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Severity
High
Severity
Low
Severity
Normal
Severity
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
4 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#119131
No description provided.
Delete Branch "Bartosz-Kosiorek/blender:desc"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?