1
0
mirror of https://github.com/DigvijaysinhGohil/Godot-Shader-Lib.git synced 2025-09-20 12:25:59 +08:00

Procedural nodes documentation updated

This commit is contained in:
Digvijaysinh Gohil
2024-04-15 22:50:04 +05:30
parent 8a036a2abf
commit 2dadda73fc
11 changed files with 156 additions and 0 deletions

View File

@ -12,4 +12,16 @@ Generates a gradient, or Perlin noise based on input UV. The resulting <b><i>out
|Name|Type|Binding|Description|
|---|---|---|---|
|output|float|None|Output noise value|
**ShaderInc location**
<br>`res://addons/ShaderLib/Procedural/Noise/GradientNoise.gdshaderinc`
**Method signature**
<br>`float gradient_noise(vec2 uv, float scale)`
**Parameters**
|Name|Type|Description|
|---|---|---|
|uv|vec2|Input UV value|
|scale|float|Noise scale|
___

View File

@ -15,4 +15,19 @@ Generates a gyroid noise based on input UV. The resulting <b><i>output</i></b> v
|Name|Type|Binding|Description|
|---|---|---|---|
|output|float|None|Output noise value|
**ShaderInc location**
<br>`res://addons/ShaderLib/Procedural/Noise/GyroidNoise.gdshaderinc`
**Method signature**
<br>`float gyroid_noise(vec2 uv, float scale, vec2 ratio, float height, float thickness)`
**Parameters**
|Name|Type|Description|
|---|---|---|
|uv|vec2|Input UV value|
|scale|float|Noise scale|
|ratio|vec2|Noise ratio for X and Y axes|
|height|float|Noise height|
|thickness|float|Noise thickness, clamped between 0 and 1|
___

View File

@ -13,4 +13,17 @@ Generates a simplex, or value noise based on input UV. The resulting <b><i>outpu
|Name|Type|Binding|Description|
|---|---|---|---|
|output|float|None|Output noise value|
**ShaderInc location**
<br>`res://addons/ShaderLib/Procedural/Noise/SimpleNoise.gdshaderinc`
**Method signature**
<br>`float simple_noise(vec2 uv, float scale, int octaves)`
**Parameters**
|Name|Type|Description|
|---|---|---|
|uv|vec2|Input UV value|
|scale|float|Noise scale|
|octaves|int|Octaves/Layers of noise, clamped between 1 and 6.|
___

View File

@ -20,4 +20,21 @@ Generates a Voronoi or Worley noise based on input UV. Voronoi noise is generate
|---|---|---|---|
|output|float|None|Output noise value|
|cells|float|None|Raw cell data|
**ShaderInc location**
<br>`res://addons/ShaderLib/Procedural/Noise/Voronoi.gdshaderinc`
**Method signature**
<br>`void voronoi_noise(vec2 uv, float cell_density, float angle_offset, int distance_index, float chebyshev_power, out float output, out float cells)`
**Parameters**
|Name|Type|Description|
|---|---|---|
|uv|vec2|Input UV value|
|cell_density|float|Density of generated cells|
|angle_offset|float|Offset values for points|
|distance_index|int|Distance matrix to use for Voronoi, 0 = Euclidean, 1 = Manhattan, 2 = Chebyshev|
|chebyshev_power|float|Power for Chebyshev distance|
|output|out float|Output noise value|
|cells|out float|Output raw cell data|
___