mirror of
https://github.com/DigvijaysinhGohil/Godot-Shader-Lib.git
synced 2025-01-07 01:43:35 +08:00
Update README.md
Document formatting
This commit is contained in:
parent
b8a00eca12
commit
9c789fdc8b
48
README.md
48
README.md
@ -2,34 +2,36 @@
|
||||
Visual shader node library for Godot engine.
|
||||
|
||||
Adds various extra nodes to use in built-in visual shader editor.
|
||||
## Installation
|
||||
# Installation
|
||||
Copy the contents of **_addons/ShaderLib_** into the same folder in your project. No activation needed. Custom visual shader nodes work the same way as standard visual shader nodes.
|
||||
## Uninstallation
|
||||
# Uninstallation
|
||||
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
|
||||
### Procedural nodes
|
||||
___
|
||||
# Nodes documentation
|
||||
<details>
|
||||
<summary>#### Voronoi node</summary>
|
||||
<summary><h1>Procedural nodes</h1></summary>
|
||||
<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.
|
||||
|
||||
|
||||
**Inputs**
|
||||
|Name|Type|Binding|Description|
|
||||
|---|---|---|---|
|
||||
|uv|vec2|UV|Input UV value|
|
||||
|cell density|float|none|Density of generated cells|
|
||||
|angle offset|float|none|Offset values for points|
|
||||
|
||||
|
||||
**Outputs**
|
||||
|Name|Type|Binding|Description|
|
||||
|---|---|---|---|
|
||||
|output|float|None|Output noise value|
|
||||
|cells|float|None|Raw cell data|
|
||||
___
|
||||
</details>
|
||||
___
|
||||
### UV nodes
|
||||
___
|
||||
#### Flipbook node
|
||||
</details>
|
||||
<details>
|
||||
<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_**.
|
||||
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.
|
||||
|
||||
@ -48,7 +50,9 @@ This node can be used to create a texture animation functionality, commonly used
|
||||
|---|---|---|---|
|
||||
|uv|vec2|None|Output UV value|
|
||||
___
|
||||
#### Radial Shear node
|
||||
</details>
|
||||
<details>
|
||||
<summary><h3>Radial Shear node</h3></summary>
|
||||
Applies a radial shear warping effect similar to a wave to the value of input UV.
|
||||
|
||||
**Inputs**
|
||||
@ -64,7 +68,9 @@ Applies a radial shear warping effect similar to a wave to the value of input UV
|
||||
|---|---|---|---|
|
||||
|uv|vec2|None|Output UV value|
|
||||
___
|
||||
#### Rotate node
|
||||
</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_**.
|
||||
|
||||
**Inputs**
|
||||
@ -80,7 +86,9 @@ Rotates value of input UV around a reference point defined by input **_center_**
|
||||
|---|---|---|---|
|
||||
|uv|vec2|None|Output UV value|
|
||||
___
|
||||
#### Spherize node
|
||||
</details>
|
||||
<details>
|
||||
<summary><h3>Spherize node</h3></summary>
|
||||
Applies a spherical warping effect similar to a fisheye camera lens to the value of input UV.
|
||||
|
||||
**Inputs**
|
||||
@ -96,7 +104,9 @@ Applies a spherical warping effect similar to a fisheye camera lens to the value
|
||||
|---|---|---|---|
|
||||
|uv|vec2|None|Output UV value|
|
||||
___
|
||||
#### Tiling and Offset node
|
||||
</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.
|
||||
|
||||
**Inputs**
|
||||
@ -111,7 +121,9 @@ Tiles and offsets the value of input UV by the inputs **_tiling_** and **_offset
|
||||
|---|---|---|---|
|
||||
|uv|vec2|None|Output UV value|
|
||||
___
|
||||
#### Twirl node
|
||||
</details>
|
||||
<details>
|
||||
<summary><h3>Twirl node</h3></summary>
|
||||
Applies a twirl warping effect similar to a black hole to the value of input UV.
|
||||
|
||||
**Inputs**
|
||||
@ -127,3 +139,5 @@ Applies a twirl warping effect similar to a black hole to the value of input UV.
|
||||
|---|---|---|---|
|
||||
|uv|vec2|None|Output UV value|
|
||||
___
|
||||
</details>
|
||||
</details>
|
Loading…
x
Reference in New Issue
Block a user