Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
---
overview: overviews/RdlCurveGeometryOverview.md
image_path: /assets/images/user-reference/scene-objects/geometry

attributes:
shadow_ray_epsilon_falloff:
videos:
- video: sreFalloffWedge.mp4
text: "shadow_ray_epsilon_falloff [0, 1]"
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
---
overview: overviews/RdlInstancerGeometryOverview.md
image_path: /assets/images/user-reference/scene-objects/geometry

attributes:
shadow_ray_epsilon_falloff:
videos:
- video: sreFalloffWedge.mp4
text: "shadow_ray_epsilon_falloff [0, 1]"
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
---
overview: overviews/RdlMeshGeometryOverview.md
image_path: /assets/images/user-reference/scene-objects/geometry

attributes:
shadow_ray_epsilon_falloff:
videos:
- video: sreFalloffWedge.mp4
text: "shadow_ray_epsilon_falloff [0, 1]"
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
---
overview: overviews/RdlPointGeometryOverview.md
image_path: /assets/images/user-reference/scene-objects/geometry

attributes:
shadow_ray_epsilon_falloff:
videos:
- video: sreFalloffWedge.mp4
text: "shadow_ray_epsilon_falloff [0, 1]"
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,7 @@ attributes:
phi_max:
videos:
- video: phi_max.mp4
shadow_ray_epsilon_falloff:
videos:
- video: ../sreFalloffWedge.mp4
text: "shadow_ray_epsilon_falloff [0, 1]"
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
---
overview: overviews/UsdGeometryOverview.md
image_path: /assets/images/user-reference/scene-objects/geometry

attributes:
shadow_ray_epsilon_falloff:
videos:
- video: sreFalloffWedge.mp4
text: "shadow_ray_epsilon_falloff [0, 1]"
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
---
overview: overviews/UsdInstanceGeometryOverview.md
image_path: /assets/images/user-reference/scene-objects/geometry

attributes:
shadow_ray_epsilon_falloff:
videos:
- video: sreFalloffWedge.mp4
text: "shadow_ray_epsilon_falloff [0, 1]"
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
---
overview: overviews/VdbGeometryOverview.md
image_path: /assets/images/user-reference/scene-objects/geometry

attributes:
shadow_ray_epsilon_falloff:
videos:
- video: sreFalloffWedge.mp4
text: "shadow_ray_epsilon_falloff [0, 1]"
14 changes: 14 additions & 0 deletions docs/_data/user-reference/scene-objects/lights/CylinderLight.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,17 @@ image_path: /assets/images/user-reference/scene-objects/lights/CylinderLight
gallery:
- image: CylinderLight.png
text: CylinderLight example

attributes:
min_shadow_distance_falloff:
videos:
- video: ../minSDFalloffWedge.mp4
text: "min_shadow_distance_falloff [0, 1]"
max_shadow_distance_falloff:
videos:
- video: ../maxSDFalloffWedge.mp4
text: "max_shadow_distance_falloff [0, 1]"
clear_radius_falloff:
videos:
- video: ../clearRadFalloffWedge.mp4
text: "clear_radius_falloff [0, 1]"
14 changes: 14 additions & 0 deletions docs/_data/user-reference/scene-objects/lights/DiskLight.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,17 @@ image_path: /assets/images/user-reference/scene-objects/lights/DiskLight
gallery:
- image: DiskLight.png
text: DiskLight example

attributes:
min_shadow_distance_falloff:
videos:
- video: ../minSDFalloffWedge.mp4
text: "min_shadow_distance_falloff [0, 1]"
max_shadow_distance_falloff:
videos:
- video: ../maxSDFalloffWedge.mp4
text: "max_shadow_distance_falloff [0, 1]"
clear_radius_falloff:
videos:
- video: ../clearRadFalloffWedge.mp4
text: "clear_radius_falloff [0, 1]"
14 changes: 14 additions & 0 deletions docs/_data/user-reference/scene-objects/lights/DistantLight.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,17 @@ image_path: /assets/images/user-reference/scene-objects/lights/DistantLight
gallery:
- image: DistantLight.png
text: DistantLight example

attributes:
min_shadow_distance_falloff:
videos:
- video: ../minSDFalloffWedge.mp4
text: "min_shadow_distance_falloff [0, 1]"
max_shadow_distance_falloff:
videos:
- video: ../maxSDFalloffWedge.mp4
text: "max_shadow_distance_falloff [0, 1]"
clear_radius_falloff:
videos:
- video: ../clearRadFalloffWedge.mp4
text: "clear_radius_falloff [0, 1]"
14 changes: 14 additions & 0 deletions docs/_data/user-reference/scene-objects/lights/EnvLight.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,17 @@ image_path: /assets/images/user-reference/scene-objects/lights/EnvLight
gallery:
- image: EnvLight.png
text: EnvLight example

attributes:
min_shadow_distance_falloff:
videos:
- video: ../minSDFalloffWedge.mp4
text: "min_shadow_distance_falloff [0, 1]"
max_shadow_distance_falloff:
videos:
- video: ../maxSDFalloffWedge.mp4
text: "max_shadow_distance_falloff [0, 1]"
clear_radius_falloff:
videos:
- video: ../clearRadFalloffWedge.mp4
text: "clear_radius_falloff [0, 1]"
14 changes: 14 additions & 0 deletions docs/_data/user-reference/scene-objects/lights/MeshLight.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,17 @@ image_path: /assets/images/user-reference/scene-objects/lights/MeshLight
gallery:
- image: MeshLight.png
text: MeshLight example

attributes:
min_shadow_distance_falloff:
videos:
- video: ../minSDFalloffWedge.mp4
text: "min_shadow_distance_falloff [0, 1]"
max_shadow_distance_falloff:
videos:
- video: ../maxSDFalloffWedge.mp4
text: "max_shadow_distance_falloff [0, 1]"
clear_radius_falloff:
videos:
- video: ../clearRadFalloffWedge.mp4
text: "clear_radius_falloff [0, 1]"
14 changes: 14 additions & 0 deletions docs/_data/user-reference/scene-objects/lights/RectLight.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,17 @@ image_path: /assets/images/user-reference/scene-objects/lights/RectLight
gallery:
- image: RectLight.png
text: RectLight example

attributes:
min_shadow_distance_falloff:
videos:
- video: ../minSDFalloffWedge.mp4
text: "min_shadow_distance_falloff [0, 1]"
max_shadow_distance_falloff:
videos:
- video: ../maxSDFalloffWedge.mp4
text: "max_shadow_distance_falloff [0, 1]"
clear_radius_falloff:
videos:
- video: ../clearRadFalloffWedge.mp4
text: "clear_radius_falloff [0, 1]"
14 changes: 14 additions & 0 deletions docs/_data/user-reference/scene-objects/lights/SphereLight.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,17 @@ image_path: /assets/images/user-reference/scene-objects/lights/SphereLight
gallery:
- image: SphereLight.png
text: SphereLight example

attributes:
min_shadow_distance_falloff:
videos:
- video: ../minSDFalloffWedge.mp4
text: "min_shadow_distance_falloff [0, 1]"
max_shadow_distance_falloff:
videos:
- video: ../maxSDFalloffWedge.mp4
text: "max_shadow_distance_falloff [0, 1]"
clear_radius_falloff:
videos:
- video: ../clearRadFalloffWedge.mp4
text: "clear_radius_falloff [0, 1]"
14 changes: 14 additions & 0 deletions docs/_data/user-reference/scene-objects/lights/SpotLight.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,17 @@ image_path: /assets/images/user-reference/scene-objects/lights/SpotLight
gallery:
- image: SpotLight.png
text: SpotLight example

attributes:
min_shadow_distance_falloff:
videos:
- video: ../minSDFalloffWedge.mp4
text: "min_shadow_distance_falloff [0, 1]"
max_shadow_distance_falloff:
videos:
- video: ../maxSDFalloffWedge.mp4
text: "max_shadow_distance_falloff [0, 1]"
clear_radius_falloff:
videos:
- video: ../clearRadFalloffWedge.mp4
text: "clear_radius_falloff [0, 1]"
Git LFS file not shown
Git LFS file not shown
Git LFS file not shown
Git LFS file not shown
38 changes: 0 additions & 38 deletions docs/user-reference/how-to-guides/shadow-controls.md

This file was deleted.

12 changes: 12 additions & 0 deletions docs/user-reference/how-to-guides/shadow-ray-manipulation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ MoonRay provides a number of different controls that allow us to ignore occludin
- [max_shadow_distance](#max-shadow-distance)
- [clear_radius](#clear-radius)

There are also accompanying falloff controls to help soften the terminator:

- `shadow_ray_epsilon_falloff`
- `min_shadow_distance_falloff`
- `max_shadow_distance_falloff`
- `clear_radius`

Each is a value [0, 1] that determines the shadow falloff, with 0 being no shadow falloff, and 1 being full falloff.

< [!WARNING]
< Enabling any of these attributes will result in a performance hit, and the impact will depend on how large the shadow gradients are in your scene.

## What are shadow rays?

At each shading point in the scene, we must determine whether (and how much) the point is in shadow. The way we measure
Expand Down
10 changes: 10 additions & 0 deletions docs/user-reference/scene-objects/geometry/RdlCurveGeometry.md
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,16 @@ title: RdlCurveGeometry
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.shadow_ray_epsilon.videos data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.shadow_ray_epsilon.links heading=4-%}
</p>
<h3>shadow_ray_epsilon_falloff</h3>
<p class="scene-class-type">
<b>Float</b>
<br>
default: 0.0
<p class="scene-class-comments">Value [0, 1] that controls the softness of the shadow_ray_epsilon terminator, where 0 means no falloff and 1 means full linear falloff from shadow_ray_epsilon to 0.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.shadow_ray_epsilon_falloff.images data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.shadow_ray_epsilon_falloff.videos data=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlCurveGeometry.attributes.shadow_ray_epsilon_falloff.links heading=4-%}
</p>
</p>
</details>
<details open>
Expand Down
10 changes: 10 additions & 0 deletions docs/user-reference/scene-objects/geometry/RdlInstancerGeometry.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,16 @@ title: RdlInstancerGeometry
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlInstancerGeometry.attributes.shadow_ray_epsilon.videos data=site.data.user-reference.scene-objects.geometry.RdlInstancerGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlInstancerGeometry.attributes.shadow_ray_epsilon.links heading=4-%}
</p>
<h3>shadow_ray_epsilon_falloff</h3>
<p class="scene-class-type">
<b>Float</b>
<br>
default: 0.0
<p class="scene-class-comments">Value [0, 1] that controls the softness of the shadow_ray_epsilon terminator, where 0 means no falloff and 1 means full linear falloff from shadow_ray_epsilon to 0.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlInstancerGeometry.attributes.shadow_ray_epsilon_falloff.images data=site.data.user-reference.scene-objects.geometry.RdlInstancerGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlInstancerGeometry.attributes.shadow_ray_epsilon_falloff.videos data=site.data.user-reference.scene-objects.geometry.RdlInstancerGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlInstancerGeometry.attributes.shadow_ray_epsilon_falloff.links heading=4-%}
</p>
</p>
</details>
<details open>
Expand Down
10 changes: 10 additions & 0 deletions docs/user-reference/scene-objects/geometry/RdlMeshGeometry.md
Original file line number Diff line number Diff line change
Expand Up @@ -486,6 +486,16 @@ title: RdlMeshGeometry
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.shadow_ray_epsilon.videos data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.shadow_ray_epsilon.links heading=4-%}
</p>
<h3>shadow_ray_epsilon_falloff</h3>
<p class="scene-class-type">
<b>Float</b>
<br>
default: 0.0
<p class="scene-class-comments">Value [0, 1] that controls the softness of the shadow_ray_epsilon terminator, where 0 means no falloff and 1 means full linear falloff from shadow_ray_epsilon to 0.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.shadow_ray_epsilon_falloff.images data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.shadow_ray_epsilon_falloff.videos data=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlMeshGeometry.attributes.shadow_ray_epsilon_falloff.links heading=4-%}
</p>
</p>
</details>
<details open>
Expand Down
10 changes: 10 additions & 0 deletions docs/user-reference/scene-objects/geometry/RdlPointGeometry.md
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,16 @@ title: RdlPointGeometry
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlPointGeometry.attributes.shadow_ray_epsilon.videos data=site.data.user-reference.scene-objects.geometry.RdlPointGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlPointGeometry.attributes.shadow_ray_epsilon.links heading=4-%}
</p>
<h3>shadow_ray_epsilon_falloff</h3>
<p class="scene-class-type">
<b>Float</b>
<br>
default: 0.0
<p class="scene-class-comments">Value [0, 1] that controls the softness of the shadow_ray_epsilon terminator, where 0 means no falloff and 1 means full linear falloff from shadow_ray_epsilon to 0.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.RdlPointGeometry.attributes.shadow_ray_epsilon_falloff.images data=site.data.user-reference.scene-objects.geometry.RdlPointGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.RdlPointGeometry.attributes.shadow_ray_epsilon_falloff.videos data=site.data.user-reference.scene-objects.geometry.RdlPointGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.RdlPointGeometry.attributes.shadow_ray_epsilon_falloff.links heading=4-%}
</p>
</p>
</details>
<details open>
Expand Down
10 changes: 10 additions & 0 deletions docs/user-reference/scene-objects/geometry/SphereGeometry.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,16 @@ title: SphereGeometry
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.SphereGeometry.attributes.shadow_ray_epsilon.videos data=site.data.user-reference.scene-objects.geometry.SphereGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.SphereGeometry.attributes.shadow_ray_epsilon.links heading=4-%}
</p>
<h3>shadow_ray_epsilon_falloff</h3>
<p class="scene-class-type">
<b>Float</b>
<br>
default: 0.0
<p class="scene-class-comments">Value [0, 1] that controls the softness of the shadow_ray_epsilon terminator, where 0 means no falloff and 1 means full linear falloff from shadow_ray_epsilon to 0.</p>
{%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.SphereGeometry.attributes.shadow_ray_epsilon_falloff.images data=site.data.user-reference.scene-objects.geometry.SphereGeometry-%}
{%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.SphereGeometry.attributes.shadow_ray_epsilon_falloff.videos data=site.data.user-reference.scene-objects.geometry.SphereGeometry-%}
{%-include see-also.html links=site.data.user-reference.scene-objects.geometry.SphereGeometry.attributes.shadow_ray_epsilon_falloff.links heading=4-%}
</p>
</p>
</details>
<details open>
Expand Down
Loading