Merge pull request #8459 from ShlomiRex/visual_shaders_interface

Add visual shader node interface explanation
godotengine · Nov 24, 2023 · fabd885 · fabd885
2 parents d82940e + ee9e10e
commit fabd885
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 0 deletions.
diff --git a/tutorials/shaders/img/vs_boolean.webp b/tutorials/shaders/img/vs_boolean.webp
diff --git a/tutorials/shaders/img/vs_node.webp b/tutorials/shaders/img/vs_node.webp
diff --git a/tutorials/shaders/img/vs_sampler.webp b/tutorials/shaders/img/vs_sampler.webp
diff --git a/tutorials/shaders/img/vs_scalar.webp b/tutorials/shaders/img/vs_scalar.webp
diff --git a/tutorials/shaders/img/vs_transform.webp b/tutorials/shaders/img/vs_transform.webp
diff --git a/tutorials/shaders/img/vs_vector.webp b/tutorials/shaders/img/vs_vector.webp
diff --git a/tutorials/shaders/visual_shaders.rst b/tutorials/shaders/visual_shaders.rst
@@ -92,6 +92,56 @@ the vector will take the value of the scalar.
 When connecting any ``vector`` output to a ``scalar`` input, the value of the
 scalar will be the average of the vector's components.
 
+Visual Shader node interface
+------------------------------
+
+Visual shader nodes have input and output ports. The input ports are located on the left side of the node, and output ports are located on the right side of the node.
+
+.. figure:: img/vs_node.webp
+
+These ports are colored to differentiate type of port:
+
+.. |scalar| image:: img/vs_scalar.webp
+.. |vector| image:: img/vs_vector.webp
+.. |boolean| image:: img/vs_boolean.webp
+.. |transform| image:: img/vs_transform.webp
+.. |sampler| image:: img/vs_sampler.webp
+
+
+.. list-table:: Port types
+   :widths: auto
+   :header-rows: 1
+
+   * - Type
+     - Color
+     - Description
+     - Example
+   * - Scalar
+     - Cyan
+     - Scalar is a single value.
+     - |scalar|
+   * - Vector
+     - Purple
+     - Vector is a set of values.
+     - |vector|
+   * - Boolean
+     - Blue
+     - On or off, true or false.
+     - |boolean|
+   * - Transform
+     - Orange
+     - A matrix, usually used to transform vertices.
+     - |transform|
+   * - Sampler
+     - Yellow
+     - A texture sampler. It can be used to sample textures.
+     - |sampler|
+
+All of the types are used in the calculations of vertices, fragments, and lights in the shader. For example: matrix multiplication, 
+vector addition, or scalar division.
+
+There are other types but these are the main ones.
+
 Visual Shader nodes
 -------------------