✨ [Nodes] Show description of inputs next to the pin

changelog.md

@@ -22,6 +22,7 @@
 
 - ✨ The slider for some parameters (Zoom, Time Speed, etc.) now behaves logarithmically, meaning it will have equal precision in the 0-1 range as in 1-∞. Basically this means they are more practical to use.
 - ✨ When using a Drag widget, the mouse position now stays locked in place instead of wrapping around the screen.
+- ✨ Some node inputs now have a little info icon next to their pin, explaining what the parameter does in more details.
 - 🐛 Remove incompatible link when creating a link backward from a pin
 
 ## 🐣beta-15

src/Nodes/NodeInputDefinition.h

@@ -15,6 +15,7 @@ class NodeInputDefinition {
     NodeInputDefinition(NodeInputDefinition_Data const&);
 
     auto name() const -> auto const& { return _data.name; }
+    auto description() const -> auto const& { return _data.description; }
     auto signature() const -> auto const& { return _data.signature; }
     void set_description(std::string const& description) { _data.description = description; }
 

src/Nodes/NodesConfig.cpp

@@ -410,13 +410,13 @@ static auto make_node(Cool::NodeDefinitionAndCategoryName const& cat_id, Cool::G
     {
         for (size_t i = 0; i < def.signature().arity; ++i)
         {
-            node.input_pins().push_back(Cool::InputPin{/*pin_name=*/Cool::String::replace_all(def.main_function().argument_names[i], "_", " ")});
+            node.input_pins().push_back(Cool::InputPin{/*pin_name=*/Cool::String::replace_all(def.main_function().argument_names[i], "_", " "), ""});
         }
     }
-    node.output_pins().emplace_back("OUT");
+    node.output_pins().emplace_back("OUT", "");
 
     for (auto const& function_input : def.function_inputs())
-        node.input_pins().push_back(Cool::InputPin{function_input.name()});
+        node.input_pins().push_back(Cool::InputPin{function_input.name(), function_input.description()});
 
     for (auto const& value_input_def : def.value_inputs())
     {
@@ -429,7 +429,7 @@ static auto make_node(Cool::NodeDefinitionAndCategoryName const& cat_id, Cool::G
                                              }; },
             value_input_def
         ));
-        node.input_pins().push_back(Cool::InputPin{std::visit([](auto&& value_input_def) { return value_input_def.var_data.name; }, value_input_def)});
+        node.input_pins().push_back(std::visit([](auto&& value_input_def) { return Cool::InputPin{value_input_def.var_data.name, value_input_def.description.value_or("")}; }, value_input_def));
     }
 
     // Get the variables from the inputs
@@ -440,7 +440,7 @@ static auto make_node(Cool::NodeDefinitionAndCategoryName const& cat_id, Cool::G
     apply_settings_to_inputs_no_history(settings, node.value_inputs(), to_string(node));
 
     for (auto const& output_index_name : def.output_indices())
-        node.output_pins().push_back(Cool::OutputPin{output_index_name});
+        node.output_pins().push_back(Cool::OutputPin{output_index_name, ""});
 
     return node;
 }

website/content/Tutorials/30-Writing Nodes/20-Inputs.md

@@ -61,4 +61,15 @@ To declare a function that takes multiple inputs, here is the syntax:
 INPUT (Oklab_PremultipliedA, Oklab_PremultipliedA)->Oklab_PremultipliedA 'Blend Mode';
 ```
 
-All the possible types for function inputs are the same as for the `main` function (see the [Primitive Types section](10-Primitive%20types.md)).
+All the possible types for function inputs are the same as for the `main` function (see the [Primitive Types section](10-Primitive%20types.md)).
+
+## Descriptions
+
+You can add a description to your inputs, by using a comment with **3 slashes (`///`)** :
+
+```glsl
+INPUT float 'Progression'; /// When set to 0 you get Curve 1; when set to 1 you get Curve 2.
+```
+
+This will add a "<span class="icon-info"></span>" next to the pin, that will show your description when hovered.
+![Description](img/description.png)