Skip to content

Commit 8269acd

Browse files
committed
Updated documentation
1 parent dd0b987 commit 8269acd

7 files changed

+28
-5
lines changed
Loading
536 Bytes
Loading
-2.81 KB
Loading
33.8 KB
Loading

material_maker/doc/shader_nodes.rst

+7-2
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ the new parameter. On this line:
3838
* the first text field is the name of the parameter, that will be used in the shader code
3939
* the second text field is an optional label that will be displayed in the user interface.
4040
There are a few tricks with this label that can help tweaking the UI.
41+
* the yellow document button can be used to add a tooltip to the parameter.
4142
* the option button can be used to select a type for the parameter. The available types
4243
are **float**, **size**, **enum**, **boolean**, **color** and **gradient**
4344
* on the right of the type selector, controls can be used to define a default value and
@@ -58,7 +59,9 @@ Inputs can be added and removed, have a name and a label (but no label trick) ju
5859
like parameters. they also have a type that can be **Greyscale**, **Color** or
5960
**RGBA**.
6061
Please note that Material Maker will convert automatically if you connect an input
61-
to an output of a different type.
62+
to an output of a different but compatible type.
63+
64+
The yellow document button can be used to define a name and add a tooltip to the input.
6265

6366
On the right of the input type, you must define a default value that will be used
6467
if the input is not connected. The default value is a GLSL expression that must
@@ -70,7 +73,7 @@ Blend filter and has a vertical and an horizontal gradient as default inputs).
7073

7174
The "Function" checkbox changes the way the code is generated for this input.
7275
When set to true, the input is generated as a function and can be used in the *Instance
73-
functions* section. If the parameter is false, the input code is inlined. is is not advised
76+
functions* section. If the parameter is false, the input code is inlined. It is not advised
7477
to set this parameter to true when not required, because generating functions can have
7578
an impact on performance.
7679

@@ -89,6 +92,8 @@ And generally, complex nodes mean complex output expressions. You may thus want
8992
write simple expressions in the **Outputs** tab and keep complex code in the 3
9093
remaining tabs.
9194

95+
The yellow document button can be used to define a name and add a tooltip to the input.
96+
9297
.. image:: images/node_editor_outputs.png
9398
:align: center
9499

material_maker/doc/subgraph_nodes.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ This will replace all selected nodes with a single subgraph node, without
1010
modifying the overall material description.
1111

1212
When the subgraph is created, it is shown in the graph editor, and can be
13-
renamed using the top right text field.
13+
renamed using the top right text field. the yellow doc button next to this
14+
text field can be used to define the Group Node's tooltip.
1415

1516
The subgraph node is not editable by default, but using the **Control+W**
1617
shortcut will make it possible to edit its contents using the pencil button.
@@ -25,9 +26,14 @@ The newly created subgraph contains:
2526
of the subgraph. Selecting them and using the **Control+W** shortcut makes them
2627
editable so the subgraph inputs and outputs can be added, removed, reordered,
2728
renamed or have their types modified.
29+
Subgraph inputs and outputs can also be assigned tooltips (by clicking on the
30+
yellow document button) and be associated to a port group (by clicking on the
31+
blue circle button).
2832
Please note that all those operations will (when possible) keep connectivity
2933
inside and outside the subgraph.
3034
* A **Parameters** node that is a **remote** can be edited to expose selected
3135
parameters to the parent graph. When grouping nodes with a **remote**, the
3236
remote will automatically be used as **Parameters** node in the nealy created
3337
subgraph.
38+
Remote parameters can also be assigned tooltips by clicking on the yellow
39+
document button.

material_maker/doc/user_interface.rst

+14-2
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ The *Model* menu can be used to:
216216
* generate a mesh normal or inverse UV map (this option is only available for custom meshes)
217217

218218
Selecting the *Custom* option in the model list will show a file dialog to select a
219-
3D model in Wavefront (.obj) format. The model should have UV information to correctly
219+
3D model in Wavefront .obj format. The model should have UV information to correctly
220220
display materials (normals will be generated if they are missing).
221221

222222
When generating a map from a custom mesh, an image node for the generated map will
@@ -328,14 +328,22 @@ Edit menu
328328
Pasting also unselects all previously selected nodes and selects all newly created nodes,
329329
so they can easily be moved around.
330330

331+
* *Load Selection* Loads a graph selection previously saved into a file
332+
333+
* *Save Selection* Saves the current graph selection into a file
334+
335+
* *Set Theme* is used to select the UI Theme
336+
337+
* *Preferences* shows the *Preferences* dialog
338+
331339
View menu
332340
^^^^^^^^^
333341

334342
* *Center view* Centers the current material graph view
335343

336344
* *Reset zoom* Resets the zoom level of the current material graph view
337345

338-
* the *Panes* submenu can be used to show or hide all side panels
346+
* the *Panels* submenu can be used to show or hide all side panels
339347

340348
Tools menu
341349
^^^^^^^^^^
@@ -359,6 +367,10 @@ Tools menu
359367
* *Export the nodes library* will prompt for a location on the disk and
360368
save the whole node library.
361369

370+
* *Create a screenshot of the current graph* will prompt for an image file name
371+
on the disk and save a screenshot of the whole current graph (it will automatically
372+
pan the graph to create the screenshot).
373+
362374
Help menu
363375
^^^^^^^^^
364376

0 commit comments

Comments
 (0)