blender
/
blender
135
403
Fork 586
Code Issues 6.2k Pull Requests 756 Projects 19 Wiki Activity

UI: Add input descriptions for Shader Nodes and fix Principled BSDF parameters. #119169

Merged
Brecht Van Lommel merged 3 commits from Bartosz-Kosiorek/blender:desc2 into main 2024-03-11 13:19:26 +01:00
Conversation 1 Commits 3 Files Changed 6 +73 -23
Bartosz Kosiorek commented 2024-03-07 16:30:38 +01:00
Contributor
Copy Link

The Popup tipes are important way for understand how shaders work, especially for beginners.

With this commit I have added bunch of new tips, taken from documentation, and I have also updated Principled BSDF parameters, according to review:
#119131

Corresponding PR for documentation:
blender/blender-manual#104730

The changes were separated to two commits.

I would create separate PR for documentation update.

The Popup tipes are important way for understand how shaders work, especially for beginners. With this commit I have added bunch of new tips, taken from documentation, and I have also updated Principled BSDF parameters, according to review: https://projects.blender.org/blender/blender/pulls/119131 Corresponding PR for documentation: https://projects.blender.org/blender/blender-manual/pulls/104730 The changes were separated to two commits. I would create separate PR for documentation update.
👍 1
Bartosz Kosiorek requested review from Weizhen Huang 2024-03-07 16:31:27 +01:00
Bartosz Kosiorek requested review from Hans Goudey 2024-03-07 16:31:40 +01:00
Bartosz Kosiorek requested review from Brecht Van Lommel 2024-03-07 16:31:48 +01:00
Bartosz Kosiorek force-pushed desc2 from 74fc16fbd3 to 7c0a891868 2024-03-07 17:32:19 +01:00 Compare
Brecht Van Lommel approved these changes 2024-03-07 19:30:39 +01:00
Brecht Van Lommel left a comment
Owner
Copy Link

Fine with me. I will wait to land in case there are more comments.

Fine with me. I will wait to land in case there are more comments.
RedMser reviewed 2024-03-07 19:49:30 +01:00
source/blender/nodes/shader/nodes/node_shader_color_ramp.cc Outdated
@ -24,2 +24,3 @@
b.is_function_node();
b.add_input<decl::Float>("Fac").default_value(0.5f).min(0.0f).max(1.0f).subtype(PROP_FACTOR);
b.add_input<decl::Float>("Fac").default_value(0.5f).min(0.0f).max(1.0f).subtype(PROP_FACTOR)
.description("The color to map. 0.0 results in the leftmost color, while 1.0 results in the rightmost.");
RedMser commented 2024-03-07 19:49:30 +01:00
Contributor
Copy Link

Remove period at the end.

Also "The color to map" sounds wrong, since Fac is a number input. Maybe "The input value to map onto the color gradient."

Remove period at the end. Also "The color to map" sounds wrong, since Fac is a number input. Maybe "The input value to map onto the color gradient."
Bartosz-Kosiorek marked this conversation as resolved
Weizhen Huang reviewed 2024-03-07 21:13:19 +01:00
Weizhen Huang left a comment
Member
Copy Link

Thank you! This is much appreciated.

Thank you! This is much appreciated.
source/blender/nodes/shader/nodes/node_shader_bsdf_principled.cc Outdated
@ -53,3 +53,3 @@
#define SOCK_ROUGHNESS_ID 2
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. "
"Index Of Refraction (IOR) for specular reflection and transmission. "
Weizhen Huang commented 2024-03-07 20:33:46 +01:00
Member
Copy Link

"of" should be lower case

"of" should be lower case
Bartosz-Kosiorek marked this conversation as resolved
source/blender/nodes/shader/nodes/node_shader_bsdf_principled.cc Outdated
@ -107,3 +107,3 @@
.subtype(PROP_FACTOR)
.short_label("IOR")
.description("Index of refraction used for rays that enter the subsurface component");
.description("Index Of Refraction (IOR) used for rays that enter the subsurface component");
Weizhen Huang commented 2024-03-07 20:34:02 +01:00
Member
Copy Link

same here, of

same here, of
Bartosz-Kosiorek marked this conversation as resolved
source/blender/nodes/shader/nodes/node_shader_bsdf_principled.cc Outdated
@ -136,3 +136,3 @@
.short_label("IOR Level")
.description(
"Adjustment to the IOR to increase or decrease specular intensity "
"Adjustment to the Index Of Refraction (IOR) to increase or decrease specular intensity "
Weizhen Huang commented 2024-03-07 20:34:31 +01:00
Member
Copy Link

Same here.

Same here.
Bartosz-Kosiorek marked this conversation as resolved
source/blender/nodes/shader/nodes/node_shader_bsdf_principled.cc Outdated
@ -206,3 +206,3 @@
.short_label("IOR")
.description(
"The index of refraction of the coat layer "
"The Index Of Refraction (IOR) of the coat layer "
Weizhen Huang commented 2024-03-07 20:36:14 +01:00
Member
Copy Link

same here

same here
Bartosz-Kosiorek marked this conversation as resolved
source/blender/nodes/shader/nodes/node_shader_tex_noise.cc Outdated
@ -33,0 +31,4 @@
b.add_input<decl::Float>("Scale").min(-1000.0f).max(1000.0f).default_value(5.0f)
.description("Scale of the base noise octave");
b.add_input<decl::Float>("Detail").min(0.0f).max(15.0f).default_value(2.0f)
.description("The number of noise octaves. Higher values give more detailed noise and higher render time");
Weizhen Huang commented 2024-03-07 20:45:54 +01:00
Member
Copy Link

..give more detailed noise but increase render time.

..give more detailed noise but increase render time.
Bartosz-Kosiorek marked this conversation as resolved
source/blender/nodes/shader/nodes/node_shader_tex_noise.cc Outdated
@ -36,2 +38,3 @@
.default_value(0.5f)
.subtype(PROP_FACTOR);
.subtype(PROP_FACTOR)
.description("Blend between a smoother noise pattern, and rougher with sharper peaks");
Weizhen Huang commented 2024-03-07 21:09:03 +01:00
Member
Copy Link

"Blend factor between an octave and its previous one. A value of zero corresponds to zero detail"
At least this is my understanding, maybe someone could verify this.

"Blend factor between an octave and its previous one. A value of zero corresponds to zero detail" At least this is my understanding, maybe someone could verify this.
Bartosz-Kosiorek marked this conversation as resolved
source/blender/nodes/shader/nodes/node_shader_tex_noise.cc Outdated
@ -40,3 +43,3 @@
.max(1000.0f)
.default_value(2.0f)
.description("The scale of a Perlin noise octave relative to that of the previous octave");
.description("The difference between the scale of each two consecutive octaves. Larger values corresponds to larger scale for higher octaves");
Weizhen Huang commented 2024-03-07 20:52:22 +01:00
Member
Copy Link

This is rather hard to understand. Maybe "The difference in scale between two consecutive octaves. A larger value corresponds to a larger difference".

This is rather hard to understand. Maybe "The difference in scale between two consecutive octaves. A larger value corresponds to a larger difference".
Bartosz-Kosiorek marked this conversation as resolved
Bartosz Kosiorek force-pushed desc2 from 7c0a891868 to 61a5ac8202 2024-03-07 21:58:32 +01:00 Compare
Bartosz Kosiorek force-pushed desc2 from 61a5ac8202 to 2322acd9ad 2024-03-07 21:58:50 +01:00 Compare
Weizhen Huang approved these changes 2024-03-07 22:02:31 +01:00
Brecht Van Lommel commented 2024-03-11 12:55:22 +01:00
Owner
Copy Link

@blender-bot build linux

@blender-bot build linux
Brecht Van Lommel added 1 commit 2024-03-11 13:18:14 +01:00
Brecht Van Lommel merged commit 0a1dd4be05 into main 2024-03-11 13:19:26 +01:00
Brecht Van Lommel deleted branch desc2 2024-03-11 13:19:29 +01:00
Sign in to join this conversation.
Reviewers
No reviewers
Hans Goudey
Brecht Van Lommel
Weizhen Huang
Labels
Clear labels   
Interest
Alembic

  
Interest
Animation & Rigging

  
Interest
Asset Browser

  
Interest
Asset Browser Project Overview

  
Interest
Audio

  
Interest
Automated Testing

  
Interest
Blender Asset Bundle

  
Interest
BlendFile

  
Interest
Collada

  
Interest
Compatibility
This issue affects/is about backward or forward compatibility

  
Interest
Compositing

  
Interest
Core

  
Interest
Cycles

  
Interest
Dependency Graph

  
Interest
Development Management

  
Interest
EEVEE

  
Interest
EEVEE & Viewport

  
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, Assets & 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
Virtual Reality

  
Interest
Vulkan

  
Interest
Wayland
Issues relating to Wayland windowing support.

  
Interest
Workbench

  
Interest: X11

Issues relating to Xorg/X11 support.

  
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
Issues relating to security: https://wiki.blender.org/wiki/Process/Vulnerability_Reports

  
Module
Animation & Rigging

  
Module
Core

  
Module
Development Management

  
Module
EEVEE & Viewport

  
Module
Grease Pencil

  
Module
Modeling

  
Module
Nodes & Physics

  
Module
Pipeline, Assets & IO

  
Module
Platforms, Builds & Tests

  
Module
Python API

  
Module
Render & Cycles

  
Module
Sculpt, Paint & Texture

  
Module
Triaging

  
Module
User Interface

  
Module
VFX & Video

  
Platform
FreeBSD

  
Platform
Linux

  
Platform
macOS

  
Platform
Windows

  
Priority
High

  
Priority
Low

  
Priority
Normal

  
Priority
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

No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset Browser
Interest
Asset Browser Project Overview
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
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, Assets & 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
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
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
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
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#119169
No description provided.
Delete Branch "Bartosz-Kosiorek/blender:desc2"

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?