mirror of
https://github.com/DigvijaysinhGohil/Godot-Shader-Lib.git
synced 2025-01-05 00:53:36 +08:00
Procedural nodes documentation updated
This commit is contained in:
parent
8a036a2abf
commit
2dadda73fc
@ -14,4 +14,18 @@ Generates a checkerboard of alternating colors between inputs <b><i>color A</i><
|
||||
|Name|Type|Binding|Description|
|
||||
|---|---|---|---|
|
||||
|output|vec3|None|Output checkerboard value|
|
||||
|
||||
**ShaderInc location**
|
||||
<br>`res://addons/ShaderLib/Procedural/CheckerBoard.gdshaderinc`
|
||||
|
||||
**Method signature**
|
||||
<br>`vec3 checker_board(vec2 uv, vec3 color_a, vec3 color_b, vec2 frequency)`
|
||||
|
||||
**Parameters**
|
||||
|Name|Type|Description|
|
||||
|---|---|---|
|
||||
|uv|vec2|Input UV value|
|
||||
|color a|vec3|First checker color|
|
||||
|color b|vec3|Second checker color|
|
||||
|frequency|vec2|Scale of checkerboard per axis|
|
||||
___
|
@ -16,4 +16,20 @@ Generates an koch curve similar to ice fractal shape based on input UV at the si
|
||||
|---|---|---|---|
|
||||
|out|float|None|Output fractal value|
|
||||
|uv|vec2|None|Output UV value|
|
||||
|
||||
**ShaderInc location**
|
||||
<br>`res://addons/ShaderLib/Procedural/Fractals/KochFractal.gdshaderinc`
|
||||
|
||||
**Method signature**
|
||||
<br>`float koch_fractal(vec2 uv, float outline, int iteration, float shape_width, float shape_height, out vec2 koch_uv)`
|
||||
|
||||
**Parameters**
|
||||
|Name|Type|Description|
|
||||
|---|---|---|
|
||||
|uv|vec2|Input UV value|
|
||||
|outline|float|Shape outline thickness|
|
||||
|iterations|int|Number of steps to repeat the fractal shape|
|
||||
|shape_width|float|Fractal width|
|
||||
|shape_height|float|Fractal height|
|
||||
|koch_uv|out vec2|Returns Koch fractal UV|
|
||||
___
|
@ -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|
|
||||
___
|
@ -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|
|
||||
___
|
@ -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.|
|
||||
___
|
@ -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|
|
||||
___
|
@ -13,4 +13,17 @@ Generates an ellipse shape based on input UV at the size specified by inputs <b>
|
||||
|Name|Type|Binding|Description|
|
||||
|---|---|---|---|
|
||||
|output|float|None|Output ellipse value|
|
||||
|
||||
**ShaderInc location**
|
||||
<br>`res://addons/ShaderLib/Procedural/Shapes/Ellipse.gdshaderinc`
|
||||
|
||||
**Method signature**
|
||||
<br>`float ellipse_shape(vec2 uv, float width, float height)`
|
||||
|
||||
**Parameters**
|
||||
|Name|Type|Description|
|
||||
|---|---|---|
|
||||
|uv|vec2|Input UV value|
|
||||
|width|float|Ellipse width|
|
||||
|height|float|Ellipse height|
|
||||
___
|
@ -14,4 +14,18 @@ Generates a regular polygon shape based on input UV at the size specified by inp
|
||||
|Name|Type|Binding|Description|
|
||||
|---|---|---|---|
|
||||
|output|float|None|Output polygon value|
|
||||
|
||||
**ShaderInc location**
|
||||
<br>`res://addons/ShaderLib/Procedural/Shapes/Polygon.gdshaderinc`
|
||||
|
||||
**Method signature**
|
||||
<br>`float polygon_shape(vec2 uv, int sides, float width, float height)`
|
||||
|
||||
**Parameters**
|
||||
|Name|Type|Description|
|
||||
|---|---|---|
|
||||
|uv|vec2|Input UV value|
|
||||
|sides|int|Number of sides of the polygon|
|
||||
|width|float|Polygon width|
|
||||
|height|float|Polygon height|
|
||||
___
|
@ -13,4 +13,17 @@ Generates a rectangle shape based on input UV at the size specified by inputs <b
|
||||
|Name|Type|Binding|Description|
|
||||
|---|---|---|---|
|
||||
|output|float|None|Output rectangle value|
|
||||
|
||||
**ShaderInc location**
|
||||
<br>`res://addons/ShaderLib/Procedural/Shapes/Rectangle.gdshaderinc`
|
||||
|
||||
**Method signature**
|
||||
<br>`float rectangle_shape(vec2 uv, float width, float height)`
|
||||
|
||||
**Parameters**
|
||||
|Name|Type|Description|
|
||||
|---|---|---|
|
||||
|uv|vec2|Input UV value|
|
||||
|width|float|Rectangle width|
|
||||
|height|float|Rectangle height|
|
||||
___
|
@ -15,4 +15,19 @@ Generates a rounded polygon shape based on input UV at the size specified by inp
|
||||
|Name|Type|Binding|Description|
|
||||
|---|---|---|---|
|
||||
|output|float|None|Output rounded polygon value|
|
||||
|
||||
**ShaderInc location**
|
||||
<br>`res://addons/ShaderLib/Procedural/Shapes/RoundedPolygon.gdshaderinc`
|
||||
|
||||
**Method signature**
|
||||
<br>`float rounded_polygon_shape(vec2 uv, float width, float height, float sides, float roundness)`
|
||||
|
||||
**Parameters**
|
||||
|Name|Type|Description|
|
||||
|---|---|---|
|
||||
|uv|vec2|Input UV value|
|
||||
|width|float|Ellipse width|
|
||||
|height|float|Ellipse height|
|
||||
|sides|float|Number of sides of the polygon|
|
||||
|roundness|float|Corner radius|
|
||||
___
|
@ -14,4 +14,18 @@ Generates a rounded rectangle shape based on input UV at the size specified by i
|
||||
|Name|Type|Binding|Description|
|
||||
|---|---|---|---|
|
||||
|output|float|None|Output rounded rectangle value|
|
||||
|
||||
**ShaderInc location**
|
||||
<br>`res://addons/ShaderLib/Procedural/Shapes/RoundedRectangle.gdshaderinc`
|
||||
|
||||
**Method signature**
|
||||
<br>`float rounded_rectangle_shape(vec2 uv, float width, float height, float radius)`
|
||||
|
||||
**Parameters**
|
||||
|Name|Type|Description|
|
||||
|---|---|---|
|
||||
|uv|vec2|Input UV value|
|
||||
|width|float|Rectangle width|
|
||||
|height|float|Rectangle height|
|
||||
|radius|float|Corner radius|
|
||||
___
|
Loading…
x
Reference in New Issue
Block a user