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

Update README.md

Browse Source 
Document formatting
This commit is contained in:
Digvijaysinh Gohil 2023-10-13 14:37:21 +05:30
parent f01c3514f4
commit 0fa8d08c5b
1 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -11,8 +11,9 @@ Delete the contents of **_addons/ShaderLib_** folder from your project. Make sur
<summary><h1>Procedural nodes</h1></summary>
<details>
<summary><h3>Checker Board node</h3></summary>
Generates a checkerboard of alternating colors between inputs **_color A_** and **_color B_** based on input UV.
Generates a checkerboard of alternating colors between inputs <b><i>color A</i></b> and <b><i>color B</i></b> based on input UV.
<hr>
**Inputs**
|Name|Type|Binding|Description|
|---|---|---|---|
@ -31,8 +32,9 @@ ___
<summary><h2>Noise</h2></summary>
<details>
<summary><h3>Gradient Noise node</h3></summary>
Generates a gradient, or Perlin, noise based on input UV. The resulting **_output_** values will be between -1 and 1.
Generates a gradient, or Perlin, noise based on input UV. The resulting <b><i>output</i></b> values will be between -1 and 1.
<hr>
**Inputs**
|Name|Type|Binding|Description|
|---|---|---|---|
@ -47,8 +49,9 @@ ___
</details>
<details>
<summary><h3>Simple Noise node</h3></summary>
Generates a simple, or Value, noise based on input UV. The resulting **_output_** values will be between 0 and 1.
Generates a simple, or Value, noise based on input UV. The resulting <b><i>output</i></b> values will be between 0 and 1.
<hr>
**Inputs**
|Name|Type|Binding|Description|
|---|---|---|---|
@ -63,8 +66,9 @@ ___
</details>
<details>
<summary><h3>Voronoi node</h3></summary>
Generates a Voronoi or Worley noise based on input UV. Voronoi noise is generated by calculating distances between a pixel and a lattice of points. By offsetting these points by a pseudo-random number, controlled by **_angle offset_**, a cluster of cells can be generated.
Generates a Voronoi or Worley noise based on input UV. Voronoi noise is generated by calculating distances between a pixel and a lattice of points. By offsetting these points by a pseudo-random number, controlled by <b><i>angle offset</i></b>, a cluster of cells can be generated.
<hr>
**Inputs**
|Name|Type|Binding|Description|
|---|---|---|---|
@ -85,8 +89,9 @@ ___
<summary><h1>UV nodes</h1></summary>
<details>
<summary><h3>Flipbook node</h3></summary>
Creates a flipbook, or texture sheet animation, of the UVs supplied to input UV. The amount of tiles on the sheet are defined by the values of the inputs **_rows_** and **_columns_**.
Creates a flipbook, or texture sheet animation, of the UVs supplied to input UV. The amount of tiles on the sheet are defined by the values of the inputs <b><i>rows</i></b> and <b><i>columns</i></b>.
This node can be used to create a texture animation functionality, commonly used for particle effects and sprites, by supplying Time to the input Tile and outputting to the UV input slot of a Texture Sampler.
<hr>
**Inputs**
|Name|Type|Binding|Description|
@ -107,6 +112,7 @@ ___
<details>
<summary><h3>Radial Shear node</h3></summary>
Applies a radial shear warping effect similar to a wave to the value of input UV.
<hr>
**Inputs**
|Name|Type|Binding|Description|
@ -124,7 +130,8 @@ ___
</details>
<details>
<summary><h3>Rotate node</h3></summary>
Rotates value of input UV around a reference point defined by input **_center_** by the amount of input **_rotation_**.
Rotates value of input UV around a reference point defined by input <b><i>center</i></b> by the amount of input <b><i>rotation</i></b>.
<hr>
**Inputs**
|Name|Type|Binding|Description|
@ -132,7 +139,7 @@ Rotates value of input UV around a reference point defined by input **_center_**
|uv|vec2|UV|Input UV value|
|center|vec2|none|Center reference point|
|rotation|float|none|Rotation amount in radians|
|use degrees|bool|none|Use degrees instead of radians for **_rotation_** amount|
|use degrees|bool|none|Use degrees instead of radians for <b><i>rotation</i></b> amount|
**Outputs**
|Name|Type|Binding|Description|
@ -143,6 +150,7 @@ ___
<details>
<summary><h3>Spherize node</h3></summary>
Applies a spherical warping effect similar to a fisheye camera lens to the value of input UV.
<hr>
**Inputs**
|Name|Type|Binding|Description|
@ -160,7 +168,8 @@ ___
</details>
<details>
<summary><h3>Tiling and Offset node</h3></summary>
Tiles and offsets the value of input UV by the inputs **_tiling_** and **_offset_** respectively. This is commonly used for detail maps and scrolling textures over TIME.
Tiles and offsets the value of input UV by the inputs <b><i>tiling</i></b> and <b><i>offset</i></b> respectively. This is commonly used for detail maps and scrolling textures over TIME.
<hr>
**Inputs**
|Name|Type|Binding|Description|
@ -178,6 +187,7 @@ ___
<details>
<summary><h3>Twirl node</h3></summary>
Applies a twirl warping effect similar to a black hole to the value of input UV.
<hr>
**Inputs**
|Name|Type|Binding|Description|