From 61a6ec51a181e52191a6eeb5170e22370190e7ab Mon Sep 17 00:00:00 2001 From: Digvijaysinh Gohil Date: Sun, 15 Oct 2023 15:08:30 +0530 Subject: [PATCH] Update README.md Documentation for nodes, NoiseSineWave, SawtoothWave, SquareWave, TriangleWave. --- README.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) diff --git a/README.md b/README.md index 38ada45..7d3c9ee 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,77 @@ Copy the contents of **_addons/ShaderLib_** into the same folder in your project Delete the contents of **_addons/ShaderLib_** folder from your project. Make sure to delete it using the Godot editor instead of your default file system program. # Nodes documentation
+

Maths nodes

 +
+

Wave

 +
+

Noise Sine Wave node

 +Returns the sine of the value of input in. For variance, psuedo-random noise is added to the amplitude of the sine wave, within a range determined by input min max. +
+ +**Inputs** +|Name|Type|Binding|Description| +|---|---|---|---| +|in|Dynamic vector|none|Input value| +|min max|vec2|none|Minimum and Maximum values for noise intensity| + +**Outputs** +|Name|Type|Binding|Description| +|---|---|---|---| +|out|Dynamic vector|None|Output value| +___ +
+
+

Sawtooth Wave node

 +Returns a sawtooth wave from the value of input in. Resulting output values will be between -1 and 1. +
+ +**Inputs** +|Name|Type|Binding|Description| +|---|---|---|---| +|in|Dynamic vector|none|Input value| + +**Outputs** +|Name|Type|Binding|Description| +|---|---|---|---| +|out|Dynamic vector|None|Output value| +___ +
+
+

Square Wave node

 +Returns a square wave from the value of input in. Resulting output values will be between -1 and 1. +
+ +**Inputs** +|Name|Type|Binding|Description| +|---|---|---|---| +|in|Dynamic vector|none|Input value| + +**Outputs** +|Name|Type|Binding|Description| +|---|---|---|---| +|out|Dynamic vector|None|Output value| +___ +
+
+

Triangle Wave node

 +Returns a triangle wave from the value of input in. Resulting output values will be between -1 and 1. +
+ +**Inputs** +|Name|Type|Binding|Description| +|---|---|---|---| +|in|Dynamic vector|none|Input value| + +**Outputs** +|Name|Type|Binding|Description| +|---|---|---|---| +|out|Dynamic vector|None|Output value| +___ +
+
+
+

Procedural nodes

Checker Board node