GameDev/Godot-Shader-Lib
1
0
Fork 0
mirror of https://github.com/DigvijaysinhGohil/Godot-Shader-Lib.git synced 2025-01-05 00:53:36 +08:00
Code Actions Activity

Maths node documentation updated

Browse Source
This commit is contained in:
Digvijaysinh Gohil 2024-04-15 22:29:35 +05:30
parent b7c13a973a
commit 8a036a2abf
3 changed files with 54 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
documentation/Nodes/Maths/Vector/Distance/ChebyshevDistance.md
View File

@ -18,4 +18,26 @@ Returns the distance between two points using Chebyshev distance matrix.
|Name|Type|Binding|Description|
|---|---|---|---|
|distance|float|None|Distance between 2 points|
**ShaderInc location**
<br>For 2D - `res://addons/ShaderLib/Maths/Vector/Distance/Chebyshev2D.gdshaderinc`
<br>For 3D - `res://addons/ShaderLib/Maths/Vector/Distance/Chebyshev3D.gdshaderinc`
**Method signature**
<br>For 2D - `float chebyshev_distance_2d(vec2 point1, vec2 point2, float power)`
<br>For 3D - `float chebyshev_distance_3d(vec3 point1, vec3 point2, float power)`
**Parameters for 2D**
|Name|Type|Description|
|---|---|---|
|point1|vec2|Point a|
|point2|vec2|Point b|
|power|float|Power for Chebyshev distance|
**Parameters for 3D**
|Name|Type|Description|
|---|---|---|
|point1|vec3|Point a|
|point2|vec3|Point b|
|power|float|Power for Chebyshev distance|
___

20
documentation/Nodes/Maths/Vector/Distance/ManhattanDistance.md
View File

@ -17,4 +17,24 @@ Returns the distance between two points using Manhattan distance matrix.
|Name|Type|Binding|Description|
|---|---|---|---|
|distance|float|None|Distance between 2 points|
**ShaderInc location**
<br>For 2D - `res://addons/ShaderLib/Maths/Vector/Distance/Manhattan2D.gdshaderinc`
<br>For 3D - `res://addons/ShaderLib/Maths/Vector/Distance/Manhattan3D.gdshaderinc`
**Method signature**
<br>For 2D - `float manhattan_distance_2d(vec2 point1, vec2 point2)`
<br>For 3D - `float manhattan_distance_3d(vec3 point1, vec3 point2)`
**Parameters for 2D**
|Name|Type|Description|
|---|---|---|
|point1|vec2|Point a|
|point2|vec2|Point b|
**Parameters for 3D**
|Name|Type|Description|
|---|---|---|
|point1|vec3|Point a|
|point2|vec3|Point b|
___

12
documentation/Nodes/Maths/Wave/NoiseSineWave.md
View File

@ -17,4 +17,16 @@ Returns the sine of the value of input <b><i>in</i></b>. For variance, psuedo-ra
|Name|Type|Binding|Description|
|---|---|---|---|
|out|Dynamic vector|None|Output value|
**ShaderInc location**
<br>`res://addons/ShaderLib/Maths/Wave/NoiseSineWave.gdshaderinc`
**Method signature**
<br>`vec4 noise_sine_wave(vec4 input, vec2 min_max)`
**Parameters**
|Name|Type|Description|
|---|---|---|
|input|vec4|Input vector|
|min_max|vec2|Minimum and Maximum values for noise intensity|
___