From 9f8087e91de3b2f19c8a38ad1bae4807fab26024 Mon Sep 17 00:00:00 2001 From: Digvijaysinh Gohil Date: Mon, 15 Apr 2024 23:04:10 +0530 Subject: [PATCH] UV nodes documentation updated --- documentation/Nodes/UV/Flipbook.md | 14 ++++++++++++++ documentation/Nodes/UV/ParallaxMapping.md | 17 +++++++++++++++++ documentation/Nodes/UV/RadialShear.md | 14 ++++++++++++++ documentation/Nodes/UV/Rotate.md | 16 +++++++++++++++- documentation/Nodes/UV/Spherize.md | 14 ++++++++++++++ documentation/Nodes/UV/Swirl.md | 14 ++++++++++++++ documentation/Nodes/UV/Twirl.md | 14 ++++++++++++++ 7 files changed, 102 insertions(+), 1 deletion(-) diff --git a/documentation/Nodes/UV/Flipbook.md b/documentation/Nodes/UV/Flipbook.md index a27ea9e..112f984 100644 --- a/documentation/Nodes/UV/Flipbook.md +++ b/documentation/Nodes/UV/Flipbook.md @@ -15,4 +15,18 @@ This node can be used to create a texture animation functionality, commonly used |Name|Type|Binding|Description| |---|---|---|---| |uv|vec2|None|Output UV value| + +**ShaderInc location** +
`res://addons/ShaderLib/UV/FlipbookUV.gdshaderinc` + +**Method signature** +
`vec2 flipbook_uv(vec2 uv, int rows, int columns, float anim_speed)` + +**Parameters** +|Name|Type|Description| +|---|---|---| +|uv|vec2|Input UV value| +|rows|int|Amount of horizontal tiles in texture sheet| +|columns|int|Amount of vertical tiles in texture sheet| +|anim speed|float|Animation speed| ___ \ No newline at end of file diff --git a/documentation/Nodes/UV/ParallaxMapping.md b/documentation/Nodes/UV/ParallaxMapping.md index 61df2bd..dee1ed2 100644 --- a/documentation/Nodes/UV/ParallaxMapping.md +++ b/documentation/Nodes/UV/ParallaxMapping.md @@ -12,4 +12,21 @@ The Parallax Mapping node lets you create a parallax effect that displaces a Mat |Name|Type|Binding|Description| |---|---|---|---| |uv|vec2|None|Output UV value| + +**ShaderInc location** +
`res://addons/ShaderLib/UV/ParallaxMappingUV.gdshaderinc` + +**Method signature** +
`vec2 parallax_mapping_uv(sampler2D height, float amplitude, vec2 uv, vec3 tangent, vec3 normal, vec3 binormal, vec3 view)` + +**Parameters** +|Name|Type|Description| +|---|---|---| +|height|sampler2D|Height map texture| +|amplitude|float|amplitude or depth of the effect| +|uv|vec2|Input uv| +|tangent|vec3|Tangent vector| +|normal|vec3|Normal vector| +|binormal|vec3|Binormal vector| +|view|vec3|View vector| ___ \ No newline at end of file diff --git a/documentation/Nodes/UV/RadialShear.md b/documentation/Nodes/UV/RadialShear.md index f2defec..dd5724d 100644 --- a/documentation/Nodes/UV/RadialShear.md +++ b/documentation/Nodes/UV/RadialShear.md @@ -14,4 +14,18 @@ Applies a radial shear warping effect similar to a wave to the value of input UV |Name|Type|Binding|Description| |---|---|---|---| |uv|vec2|None|Output UV value| + +**ShaderInc location** +
`res://addons/ShaderLib/UV/RadialShearUV.gdshaderinc` + +**Method signature** +
`vec2 radial_shear_uv(vec2 uv, vec2 center, float strength, vec2 offset)` + +**Parameters** +|Name|Type|Description| +|---|---|---| +|uv|vec2|Input uv| +|center|vec2|Center reference point| +|strength|float|Strength of the effect| +|offset|vec2|Individual channel offsets| ___ \ No newline at end of file diff --git a/documentation/Nodes/UV/Rotate.md b/documentation/Nodes/UV/Rotate.md index 27b4013..053c2e8 100644 --- a/documentation/Nodes/UV/Rotate.md +++ b/documentation/Nodes/UV/Rotate.md @@ -7,7 +7,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| +|rotation|float|none|Rotation amount| **Controls** |Name|Options|Description| @@ -18,4 +18,18 @@ Rotates value of input UV around a reference point defined by input center |Name|Type|Binding|Description| |---|---|---|---| |uv|vec2|None|Output UV value| + +**ShaderInc location** +
`res://addons/ShaderLib/UV/RotateUV.gdshaderinc` + +**Method signature** +
`vec2 rotate_uv(vec2 uv, vec2 center, float rotation, bool use_degrees)` + +**Parameters** +|Name|Type|Description| +|---|---|---| +|uv|vec2|Input uv| +|center|vec2|Center reference point| +|rotation|float|Rotation amount| +|use_degrees|bool|Specifies the unit for rotation, true = Degrees, false = Radians| ___ \ No newline at end of file diff --git a/documentation/Nodes/UV/Spherize.md b/documentation/Nodes/UV/Spherize.md index e541be4..087366e 100644 --- a/documentation/Nodes/UV/Spherize.md +++ b/documentation/Nodes/UV/Spherize.md @@ -14,4 +14,18 @@ Applies a spherical warping effect similar to a fisheye camera lens to the value |Name|Type|Binding|Description| |---|---|---|---| |uv|vec2|None|Output UV value| + +**ShaderInc location** +
`res://addons/ShaderLib/UV/SpherizeUV.gdshaderinc` + +**Method signature** +
`vec2 spherize_uv(vec2 uv, vec2 center, float strength, vec2 offset)` + +**Parameters** +|Name|Type|Description| +|---|---|---| +|uv|vec2|Input uv| +|center|vec2|Center reference point| +|strength|float|Strength of the effect| +|offset|vec2|Individual channel offsets| ___ \ No newline at end of file diff --git a/documentation/Nodes/UV/Swirl.md b/documentation/Nodes/UV/Swirl.md index 2e979dd..b7df4b5 100644 --- a/documentation/Nodes/UV/Swirl.md +++ b/documentation/Nodes/UV/Swirl.md @@ -14,4 +14,18 @@ Applies a swirl warping effect similar to a black hole to the value of input UV. |Name|Type|Binding|Description| |---|---|---|---| |uv|vec2|None|Output UV value| + +**ShaderInc location** +
`res://addons/ShaderLib/UV/SwirlUV.gdshaderinc` + +**Method signature** +
`vec2 swirl_uv(vec2 uv, vec2 center, float strength, vec2 offset)` + +**Parameters** +|Name|Type|Description| +|---|---|---| +|uv|vec2|Input uv| +|center|vec2|Center reference point| +|strength|float|Strength of the effect| +|offset|vec2|Individual channel offsets| ___ \ No newline at end of file diff --git a/documentation/Nodes/UV/Twirl.md b/documentation/Nodes/UV/Twirl.md index 935ed51..bf0ec5c 100644 --- a/documentation/Nodes/UV/Twirl.md +++ b/documentation/Nodes/UV/Twirl.md @@ -14,4 +14,18 @@ Applies a twirl warping effect similar to a black hole to the value of input UV. |Name|Type|Binding|Description| |---|---|---|---| |uv|vec2|None|Output UV value| + +**ShaderInc location** +
`res://addons/ShaderLib/UV/TwirlUV.gdshaderinc` + +**Method signature** +
`vec2 twirl_uv(vec2 uv, vec2 center, float strength, vec2 offset)` + +**Parameters** +|Name|Type|Description| +|---|---|---| +|uv|vec2|Input uv| +|center|vec2|Center reference point| +|strength|float|Strength of the effect| +|offset|vec2|Individual channel offsets| ___ \ No newline at end of file