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

Ray march node documentation added.

Browse Source
This commit is contained in:
Digvijaysinh Gohil 2024-03-27 11:21:47 +05:30
parent 6b57a43325
commit 033b54ea93
3 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
documentation/Nodes/RayMarching/Expression.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 74 KiB

BIN
documentation/Nodes/RayMarching/GlobalExpression.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 120 KiB

21
documentation/Nodes/RayMarching/RayMarch.md
View File

@ -1,5 +1,5 @@
# Ray March node
A simple ray marcher.
A simple ray marcher for primitive shapes.
<hr>
**Controls**
@ -23,21 +23,17 @@ A simple ray marcher.
|cube pos|vec3|SDBox|Position offset of the box shape|
|cube eulers|vec3|SDBox|Rotation of the box shape in Degrees|
|cube scale|vec3|SDBox|Scale of the box shape|
|---|---|---|---|
|sphere pos|vec3|SDSphere|Position offset of the sphere shape|
|sphere eulers|vec3|SDSphere|Rotation of the box sphere in Degrees|
|sphere scale|vec3|SDSphere|Scale of the sphere shape|
|---|---|---|---|
|capsule pos|vec3|SDCapsule|Position offset of the capsule shape|
|capsule eulers|vec3|SDCapsule|Rotation of the capsule shape in Degrees|
|capsule height|float|SDCapsule|Height of the capsule shape|
|capsule radius|float|SDCapsule|Radius of the capsule shape|
|---|---|---|---|
|cylinder pos|vec3|SDCylinder|Position offset of the cylinder shape|
|cylinder eulers|vec3|SDCylinder|Rotation of the cylinder shape in Degrees|
|cylinder height|float|SDCylinder|Height of the cylinder shape|
|cylinder radius|float|SDCylinder|Radius of the cylinder shape|
|---|---|---|---|
|torus pos|vec3|SDTorus|Position offset of the torus shape|
|torus eulers|vec3|SDTorus|Rotation of the torus shape in Degrees|
|torus small radius|float|SDTorus|Small radius of the torus shape|
@ -47,4 +43,17 @@ A simple ray marcher.
|Name|Type|Binding|Description|
|---|---|---|---|
|distance|float|None|Ray intersection distance|
___
___
**Extras**
This node is only simple ray marching example, the true power of raymarching can only be achieved by custom SDFs. At the moment I am unable to inject the custom code via visual shaders, so I have provided the custom template at the following location.<br><br>
The default location can be found at<br>
`res://addons/ShaderLib/RayMarching/RayMarchCustom.gdshaderinc`
You can copy the code from `RayMarchCustom.gdshaderinc` and then create a <b><i>Global Expression/i></b> node and paste it in your visual shader.<br>
![Global Expression Node](GlobalExpression.jpg)<br>
Lastly you also need to create an <b><i>Expression/i></b> node, define required input and output parameters and call the custom ray marching function as below.<br>
![Expression Node](Expression.jpg)
___