blender
/
blender
134
398
Fork 581
Code Issues 6.3k Pull Requests 755 Projects 19 Wiki Activity

UI: Add tooltips with description of Composite Nodes #121038

Merged
Brecht Van Lommel merged 2 commits from Bartosz-Kosiorek/blender:composite into main 2024-04-29 14:48:53 +02:00
Conversation 3 Commits 2 Files Changed 1 +102 -102
Bartosz Kosiorek commented 2024-04-24 17:56:47 +02:00
Contributor
Copy Link

No response

_No response_
composite-tooltips.png
561 KiB
composite-tooltips.png
🚀 1
Bartosz Kosiorek added 1 commit 2024-04-24 17:56:55 +02:00
Bartosz Kosiorek requested review from Brecht Van Lommel 2024-04-24 17:57:11 +02:00
Bartosz Kosiorek requested review from Hans Goudey 2024-04-24 17:57:20 +02:00
Bartosz Kosiorek force-pushed composite from 8a30e3edaf to d763a10e7d 2024-04-26 23:29:06 +02:00 Compare
Iliya Katushenock added this to the Compositing project 2024-04-26 23:48:49 +02:00
Iliya Katushenock added the
Module
Nodes & Physics
Interest
User Interface
 labels 2024-04-26 23:48:58 +02:00
Brecht Van Lommel added 1 commit 2024-04-29 14:43:22 +02:00
c40e539a8f Tweak descriptions: 
* Various wording changes for clarity and brevity
* Use consistent verb conjugation at the start of the tooltip
* Remove some unecessary capitalizations
Brecht Van Lommel approved these changes 2024-04-29 14:44:03 +02:00
Brecht Van Lommel left a comment
Owner
Copy Link

I started reviewing but found it quicker to just update the text myself, so I've done that.

I started reviewing but found it quicker to just update the text myself, so I've done that.
source/blender/nodes/NOD_static_types.h Outdated
@ -147,3 +127,1 @@
DefNode(CompositorNode, CMP_NODE_IMAGE, def_cmp_image, "IMAGE", Image, "Image", "" )
DefNode(CompositorNode, CMP_NODE_R_LAYERS, def_cmp_render_layers, "R_LAYERS", RLayers, "Render Layers", "" )
DefNode(CompositorNode, CMP_NODE_COMPOSITE, def_cmp_composite, "COMPOSITE", Composite, "Composite", "" )
DefNode(CompositorNode, CMP_NODE_VIEWER, def_cmp_viewer, "VIEWER", Viewer, "Viewer", "Visualize data from inside a node graph as a backdrop in the compositor")
Brecht Van Lommel commented 2024-04-24 21:54:02 +02:00
Owner
Copy Link

It's not just for backdrops, also for image editor.

It's not just for backdrops, also for image editor.
brecht marked this conversation as resolved
source/blender/nodes/NOD_static_types.h Outdated
@ -149,1 +127,3 @@
DefNode(CompositorNode, CMP_NODE_COMPOSITE, def_cmp_composite, "COMPOSITE", Composite, "Composite", "" )
DefNode(CompositorNode, CMP_NODE_VIEWER, def_cmp_viewer, "VIEWER", Viewer, "Viewer", "Visualize data from inside a node graph as a backdrop in the compositor")
DefNode(CompositorNode, CMP_NODE_RGB, 0, "RGB", RGB, "RGB", "A color picker")
DefNode(CompositorNode, CMP_NODE_VALUE, 0, "VALUE", Value, "Value", "Used to Input numerical values to other nodes in the tree")
Brecht Van Lommel commented 2024-04-24 21:54:21 +02:00
Owner
Copy Link

Leave out "Used to", it doesn't add anything.

Leave out "Used to", it doesn't add anything.
brecht marked this conversation as resolved
source/blender/nodes/NOD_static_types.h Outdated
@ -150,0 +127,4 @@
DefNode(CompositorNode, CMP_NODE_VIEWER, def_cmp_viewer, "VIEWER", Viewer, "Viewer", "Visualize data from inside a node graph as a backdrop in the compositor")
DefNode(CompositorNode, CMP_NODE_RGB, 0, "RGB", RGB, "RGB", "A color picker")
DefNode(CompositorNode, CMP_NODE_VALUE, 0, "VALUE", Value, "Value", "Used to Input numerical values to other nodes in the tree")
DefNode(CompositorNode, CMP_NODE_MIX_RGB, def_mix_rgb, "MIX_RGB", MixRGB, "Mix", "Blend two images together, by using selecte d Blending Mode")
Brecht Van Lommel commented 2024-04-24 21:54:48 +02:00
Owner
Copy Link

Don't capitalize Blending.

Don't capitalize Blending.
brecht marked this conversation as resolved
source/blender/nodes/NOD_static_types.h Outdated
@ -224,3 +151,1 @@
DefNode(CompositorNode, CMP_NODE_SEPARATE_COLOR, def_cmp_combsep_color, "SEPARATE_COLOR", SeparateColor, "Separate Color", "" )
DefNode(CompositorNode, CMP_NODE_COMBINE_COLOR, def_cmp_combsep_color, "COMBINE_COLOR", CombineColor, "Combine Color", "" )
DefNode(CompositorNode, CMP_NODE_KUWAHARA, def_cmp_kuwahara, "KUWAHARA", Kuwahara, "Kuwahara", "" )
DefNode(CompositorNode, CMP_NODE_OUTPUT_FILE, 0, "OUTPUT_FILE", OutputFile, "File Output", "Write file image based on provided input image")
Brecht Van Lommel commented 2024-04-24 21:56:35 +02:00
Owner
Copy Link

file image -> image file

file image -> image file
brecht marked this conversation as resolved
source/blender/nodes/NOD_static_types.h Outdated
@ -225,2 +151,2 @@
DefNode(CompositorNode, CMP_NODE_COMBINE_COLOR, def_cmp_combsep_color, "COMBINE_COLOR", CombineColor, "Combine Color", "" )
DefNode(CompositorNode, CMP_NODE_KUWAHARA, def_cmp_kuwahara, "KUWAHARA", Kuwahara, "Kuwahara", "" )
DefNode(CompositorNode, CMP_NODE_OUTPUT_FILE, 0, "OUTPUT_FILE", OutputFile, "File Output", "Write file image based on provided input image")
DefNode(CompositorNode, CMP_NODE_TEXTURE, def_texture, "TEXTURE", Texture, "Texture", "Input texture from a scene")
Brecht Van Lommel commented 2024-04-24 21:57:15 +02:00
Owner
Copy Link

Not sure why "from a scene", the texture is not part of a scene.

Not sure why "from a scene", the texture is not part of a scene.
brecht marked this conversation as resolved
source/blender/nodes/NOD_static_types.h Outdated
@ -227,0 +158,4 @@
DefNode(CompositorNode, CMP_NODE_DESPECKLE, def_cmp_despeckle, "DESPECKLE", Despeckle, "Despeckle", "Smooth areas of an image in which noise is noticeable, while leaving complex areas untouched")
DefNode(CompositorNode, CMP_NODE_ROTATE, def_cmp_rotate, "ROTATE", Rotate, "Rotate", "Rotate an input image by specific angle")
DefNode(CompositorNode, CMP_NODE_SCALE, def_cmp_scale, "SCALE", Scale, "Scale", "Change the size of the image")
DefNode(CompositorNode, CMP_NODE_SEPYCCA_LEGACY, def_cmp_ycc, "SEPYCCA", SepYCCA, "Separate YCbCrA", "Deprecated")
Brecht Van Lommel commented 2024-04-24 21:56:23 +02:00
Owner
Copy Link

Better to leave the description empty than use Deprecated I think. It doesn't seem like a good description by itself.

Better to leave the description empty than use Deprecated I think. It doesn't seem like a good description by itself.
brecht marked this conversation as resolved
Brecht Van Lommel commented 2024-04-29 14:45:30 +02:00
Owner
Copy Link

I also made some adjustments in the manual to match:
blender/blender-manual@8608d47c2a

I also made some adjustments in the manual to match: blender/blender-manual@8608d47c2a0fef4870e798bacff8de438fb499d6
Brecht Van Lommel merged commit d655e63044 into main 2024-04-29 14:48:53 +02:00
Brecht Van Lommel deleted branch composite 2024-04-29 14:48:55 +02:00
Brecht Van Lommel commented 2024-04-29 14:49:42 +02:00
Owner
Copy Link

In case you are planning to do the same for texture nodes, those are considered legacy and will be replaced hopefully soon. So I would not bother adding tooltips for those.

In case you are planning to do the same for texture nodes, those are considered legacy and will be replaced hopefully soon. So I would not bother adding tooltips for those.
Bartosz Kosiorek commented 2024-05-01 08:09:27 +02:00
Author
Contributor
Copy Link

In case you are planning to do the same for texture nodes, those are considered legacy and will be replaced hopefully soon. So I would not bother adding tooltips for those.

Thanks @brecht for merging it. I think it is far more efficient to edit the Pull Request and just push it.

Regarding Texture nodes, I would add explicetely information that it is deprecated, like: Deprecated. Use shader nodes instead.
Or even more explicit per node: Deprecated. Use Invert Color shader node instead.
What do you think?

Could you take a look at two more Pull Requests where tooltips were added/updated?
#119641
and
#119810

> In case you are planning to do the same for texture nodes, those are considered legacy and will be replaced hopefully soon. So I would not bother adding tooltips for those. Thanks @brecht for merging it. I think it is far more efficient to edit the Pull Request and just push it. Regarding `Texture nodes`, I would add explicetely information that it is deprecated, like: `Deprecated. Use shader nodes instead`. Or even more explicit per node: `Deprecated. Use Invert Color shader node instead`. What do you think? Could you take a look at two more Pull Requests where tooltips were added/updated? https://projects.blender.org/blender/blender/pulls/119641 and https://projects.blender.org/blender/blender/pulls/119810
Sign in to join this conversation.
Reviewers
No reviewers
Hans Goudey
Brecht Van Lommel
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
Compositing
Assignees
Clear assignees
No Assignees
2 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#121038
No description provided.
Delete Branch "Bartosz-Kosiorek/blender:composite"

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?