diff --git a/docs/_data/user-reference/scene-objects/geometry/RdlCurveGeometry.yml b/docs/_data/user-reference/scene-objects/geometry/RdlCurveGeometry.yml index 37e2127aa..35c4b840a 100644 --- a/docs/_data/user-reference/scene-objects/geometry/RdlCurveGeometry.yml +++ b/docs/_data/user-reference/scene-objects/geometry/RdlCurveGeometry.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/geometry/RdlInstancerGeometry.yml b/docs/_data/user-reference/scene-objects/geometry/RdlInstancerGeometry.yml index 94d22ec16..ced4a4e06 100644 --- a/docs/_data/user-reference/scene-objects/geometry/RdlInstancerGeometry.yml +++ b/docs/_data/user-reference/scene-objects/geometry/RdlInstancerGeometry.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/geometry/RdlMeshGeometry.yml b/docs/_data/user-reference/scene-objects/geometry/RdlMeshGeometry.yml index 7f563778c..6a7fef087 100644 --- a/docs/_data/user-reference/scene-objects/geometry/RdlMeshGeometry.yml +++ b/docs/_data/user-reference/scene-objects/geometry/RdlMeshGeometry.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/geometry/RdlPointGeometry.yml b/docs/_data/user-reference/scene-objects/geometry/RdlPointGeometry.yml index 3d671acdb..596951373 100644 --- a/docs/_data/user-reference/scene-objects/geometry/RdlPointGeometry.yml +++ b/docs/_data/user-reference/scene-objects/geometry/RdlPointGeometry.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/geometry/SphereGeometry.yml b/docs/_data/user-reference/scene-objects/geometry/SphereGeometry.yml index 7a72f3772..76fa265ab 100644 --- a/docs/_data/user-reference/scene-objects/geometry/SphereGeometry.yml +++ b/docs/_data/user-reference/scene-objects/geometry/SphereGeometry.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/geometry/UsdGeometry.yml b/docs/_data/user-reference/scene-objects/geometry/UsdGeometry.yml index 6f8c4be09..b87006a7b 100644 --- a/docs/_data/user-reference/scene-objects/geometry/UsdGeometry.yml +++ b/docs/_data/user-reference/scene-objects/geometry/UsdGeometry.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/geometry/UsdInstanceGeometry.yml b/docs/_data/user-reference/scene-objects/geometry/UsdInstanceGeometry.yml index 37f83b2dc..1486411b3 100644 --- a/docs/_data/user-reference/scene-objects/geometry/UsdInstanceGeometry.yml +++ b/docs/_data/user-reference/scene-objects/geometry/UsdInstanceGeometry.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/geometry/VdbGeometry.yml b/docs/_data/user-reference/scene-objects/geometry/VdbGeometry.yml index 060b14226..bccd04821 100644 --- a/docs/_data/user-reference/scene-objects/geometry/VdbGeometry.yml +++ b/docs/_data/user-reference/scene-objects/geometry/VdbGeometry.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/lights/CylinderLight.yml b/docs/_data/user-reference/scene-objects/lights/CylinderLight.yml index 8846ccc91..48fefee6e 100644 --- a/docs/_data/user-reference/scene-objects/lights/CylinderLight.yml +++ b/docs/_data/user-reference/scene-objects/lights/CylinderLight.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/lights/DiskLight.yml b/docs/_data/user-reference/scene-objects/lights/DiskLight.yml index 099a3289c..9e1d2faec 100644 --- a/docs/_data/user-reference/scene-objects/lights/DiskLight.yml +++ b/docs/_data/user-reference/scene-objects/lights/DiskLight.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/lights/DistantLight.yml b/docs/_data/user-reference/scene-objects/lights/DistantLight.yml index 0562e8d78..570cd57ac 100644 --- a/docs/_data/user-reference/scene-objects/lights/DistantLight.yml +++ b/docs/_data/user-reference/scene-objects/lights/DistantLight.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/lights/EnvLight.yml b/docs/_data/user-reference/scene-objects/lights/EnvLight.yml index 48d64823d..ce4c8ad1c 100644 --- a/docs/_data/user-reference/scene-objects/lights/EnvLight.yml +++ b/docs/_data/user-reference/scene-objects/lights/EnvLight.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/lights/MeshLight.yml b/docs/_data/user-reference/scene-objects/lights/MeshLight.yml index f8c8e237a..703a4e94b 100644 --- a/docs/_data/user-reference/scene-objects/lights/MeshLight.yml +++ b/docs/_data/user-reference/scene-objects/lights/MeshLight.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/lights/RectLight.yml b/docs/_data/user-reference/scene-objects/lights/RectLight.yml index 10c826408..172c75fbf 100644 --- a/docs/_data/user-reference/scene-objects/lights/RectLight.yml +++ b/docs/_data/user-reference/scene-objects/lights/RectLight.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/lights/SphereLight.yml b/docs/_data/user-reference/scene-objects/lights/SphereLight.yml index c490fe89d..d1f2b8edd 100644 --- a/docs/_data/user-reference/scene-objects/lights/SphereLight.yml +++ b/docs/_data/user-reference/scene-objects/lights/SphereLight.yml @@ -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]" \ No newline at end of file diff --git a/docs/_data/user-reference/scene-objects/lights/SpotLight.yml b/docs/_data/user-reference/scene-objects/lights/SpotLight.yml index 848faa94e..f8c18b39f 100644 --- a/docs/_data/user-reference/scene-objects/lights/SpotLight.yml +++ b/docs/_data/user-reference/scene-objects/lights/SpotLight.yml @@ -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]" \ No newline at end of file diff --git a/docs/assets/images/user-reference/scene-objects/geometry/sreFalloff.mp4 b/docs/assets/images/user-reference/scene-objects/geometry/sreFalloff.mp4 new file mode 100644 index 000000000..95e530f69 --- /dev/null +++ b/docs/assets/images/user-reference/scene-objects/geometry/sreFalloff.mp4 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:5c93f4a775653036660795b755a97fad84c0d6265a4854f4a2c1034bbd0bac1b +size 80742 diff --git a/docs/assets/images/user-reference/scene-objects/lights/clearRadFalloff.mp4 b/docs/assets/images/user-reference/scene-objects/lights/clearRadFalloff.mp4 new file mode 100644 index 000000000..9d7b7aa05 --- /dev/null +++ b/docs/assets/images/user-reference/scene-objects/lights/clearRadFalloff.mp4 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fa19767beb403969e2d01af3c2f7817037232c41b7644a9f1a6bf0026a901051 +size 82818 diff --git a/docs/assets/images/user-reference/scene-objects/lights/maxSDFalloff.mp4 b/docs/assets/images/user-reference/scene-objects/lights/maxSDFalloff.mp4 new file mode 100644 index 000000000..53ca2bca2 --- /dev/null +++ b/docs/assets/images/user-reference/scene-objects/lights/maxSDFalloff.mp4 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6099ab3410b9f48b2efdfd866cd8faad61b3c3ecb17281c5f11ee1f2cbba448a +size 77596 diff --git a/docs/assets/images/user-reference/scene-objects/lights/minSDFalloff.mp4 b/docs/assets/images/user-reference/scene-objects/lights/minSDFalloff.mp4 new file mode 100644 index 000000000..64102a7d2 --- /dev/null +++ b/docs/assets/images/user-reference/scene-objects/lights/minSDFalloff.mp4 @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9d24aa3b56b548ae3d52947f5e7d8d0716cce5bbccd58baa1d62aa3b3dabbbc4 +size 81172 diff --git a/docs/user-reference/how-to-guides/shadow-controls.md b/docs/user-reference/how-to-guides/shadow-controls.md deleted file mode 100644 index 4d0d7fec2..000000000 --- a/docs/user-reference/how-to-guides/shadow-controls.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Shadow Controls ---- -# Shadow Controls - -Two light attributes, `max_shadow_distance` and `clear_radius`, define constraints on how shadows can be cast from the -associated light. Both of these attributes work in tandem to define the region where shadows cast by the light can appear. - -## Max Shadow Distance -Limits shadows cast by the associated light to *max_shadow_distance* away from the shadow caster. In the example below, -the shadow's distance from the shadow caster (the plane) ranges from 5.7 to 6.4. - -
- -
- -## Clear Radius -Ignore shadows cast by the associated light until *clear_radius* distance is reached. We can think of this as the -minimum distance away from the light that shadows can appear. In the example below, the shadow cast by the plane is -between about 48 and 54 units from the light. - -
- -
- -## Combined Behavior -*clear_radius* should always be less than *max_shadow_distance*. If *clear_radius* overlaps *max_shadow_distance*, no shadows -will appear. In the example below, you will see this behavior, as *max_shadow_distance* stays the same (at 6.1) and the *clear_radius* varies. - -
- -
diff --git a/docs/user-reference/how-to-guides/shadow-ray-manipulation.md b/docs/user-reference/how-to-guides/shadow-ray-manipulation.md index f3cf30f8b..fb10cd965 100644 --- a/docs/user-reference/how-to-guides/shadow-ray-manipulation.md +++ b/docs/user-reference/how-to-guides/shadow-ray-manipulation.md @@ -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 diff --git a/docs/user-reference/scene-objects/geometry/RdlCurveGeometry.md b/docs/user-reference/scene-objects/geometry/RdlCurveGeometry.md index 446b1d9c9..3d32abfb0 100644 --- a/docs/user-reference/scene-objects/geometry/RdlCurveGeometry.md +++ b/docs/user-reference/scene-objects/geometry/RdlCurveGeometry.md @@ -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-%}

+

shadow_ray_epsilon_falloff

+

+ Float +
+ default: 0.0 +

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.

+ {%-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-%} +

diff --git a/docs/user-reference/scene-objects/geometry/RdlInstancerGeometry.md b/docs/user-reference/scene-objects/geometry/RdlInstancerGeometry.md index 906b3b839..d138cde5d 100644 --- a/docs/user-reference/scene-objects/geometry/RdlInstancerGeometry.md +++ b/docs/user-reference/scene-objects/geometry/RdlInstancerGeometry.md @@ -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-%}

+

shadow_ray_epsilon_falloff

+

+ Float +
+ default: 0.0 +

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.

+ {%-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-%} +

diff --git a/docs/user-reference/scene-objects/geometry/RdlMeshGeometry.md b/docs/user-reference/scene-objects/geometry/RdlMeshGeometry.md index 15b68406e..0b56c6fb9 100644 --- a/docs/user-reference/scene-objects/geometry/RdlMeshGeometry.md +++ b/docs/user-reference/scene-objects/geometry/RdlMeshGeometry.md @@ -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-%}

+

shadow_ray_epsilon_falloff

+

+ Float +
+ default: 0.0 +

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.

+ {%-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-%} +

diff --git a/docs/user-reference/scene-objects/geometry/RdlPointGeometry.md b/docs/user-reference/scene-objects/geometry/RdlPointGeometry.md index 6dc22c27c..ae1ecfa9b 100644 --- a/docs/user-reference/scene-objects/geometry/RdlPointGeometry.md +++ b/docs/user-reference/scene-objects/geometry/RdlPointGeometry.md @@ -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-%}

+

shadow_ray_epsilon_falloff

+

+ Float +
+ default: 0.0 +

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.

+ {%-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-%} +

diff --git a/docs/user-reference/scene-objects/geometry/SphereGeometry.md b/docs/user-reference/scene-objects/geometry/SphereGeometry.md index 5578fa25d..8f5a62fcd 100644 --- a/docs/user-reference/scene-objects/geometry/SphereGeometry.md +++ b/docs/user-reference/scene-objects/geometry/SphereGeometry.md @@ -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-%}

+

shadow_ray_epsilon_falloff

+

+ Float +
+ default: 0.0 +

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.

+ {%-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-%} +

diff --git a/docs/user-reference/scene-objects/geometry/UsdGeometry.md b/docs/user-reference/scene-objects/geometry/UsdGeometry.md index 11f59182d..4723eca6f 100644 --- a/docs/user-reference/scene-objects/geometry/UsdGeometry.md +++ b/docs/user-reference/scene-objects/geometry/UsdGeometry.md @@ -234,6 +234,16 @@ title: UsdGeometry {%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.UsdGeometry.attributes.shadow_ray_epsilon.videos data=site.data.user-reference.scene-objects.geometry.UsdGeometry-%} {%-include see-also.html links=site.data.user-reference.scene-objects.geometry.UsdGeometry.attributes.shadow_ray_epsilon.links heading=4-%}

+

shadow_ray_epsilon_falloff

+

+ Float +
+ default: 0.0 +

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.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.UsdGeometry.attributes.shadow_ray_epsilon_falloff.images data=site.data.user-reference.scene-objects.geometry.UsdGeometry-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.UsdGeometry.attributes.shadow_ray_epsilon_falloff.videos data=site.data.user-reference.scene-objects.geometry.UsdGeometry-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.geometry.UsdGeometry.attributes.shadow_ray_epsilon_falloff.links heading=4-%} +

diff --git a/docs/user-reference/scene-objects/geometry/UsdInstanceGeometry.md b/docs/user-reference/scene-objects/geometry/UsdInstanceGeometry.md index 9508d0b89..b0ed08237 100644 --- a/docs/user-reference/scene-objects/geometry/UsdInstanceGeometry.md +++ b/docs/user-reference/scene-objects/geometry/UsdInstanceGeometry.md @@ -191,6 +191,16 @@ title: UsdInstanceGeometry {%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.UsdInstanceGeometry.attributes.shadow_ray_epsilon.videos data=site.data.user-reference.scene-objects.geometry.UsdInstanceGeometry-%} {%-include see-also.html links=site.data.user-reference.scene-objects.geometry.UsdInstanceGeometry.attributes.shadow_ray_epsilon.links heading=4-%}

+

shadow_ray_epsilon_falloff

+

+ Float +
+ default: 0.0 +

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.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.UsdInstanceGeometry.attributes.shadow_ray_epsilon_falloff.images data=site.data.user-reference.scene-objects.geometry.UsdInstanceGeometry-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.UsdInstanceGeometry.attributes.shadow_ray_epsilon_falloff.videos data=site.data.user-reference.scene-objects.geometry.UsdInstanceGeometry-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.geometry.UsdInstanceGeometry.attributes.shadow_ray_epsilon_falloff.links heading=4-%} +

diff --git a/docs/user-reference/scene-objects/geometry/VdbGeometry.md b/docs/user-reference/scene-objects/geometry/VdbGeometry.md index bc4b1d9fd..c74f7dbc4 100644 --- a/docs/user-reference/scene-objects/geometry/VdbGeometry.md +++ b/docs/user-reference/scene-objects/geometry/VdbGeometry.md @@ -125,6 +125,16 @@ title: VdbGeometry {%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.VdbGeometry.attributes.shadow_ray_epsilon.videos data=site.data.user-reference.scene-objects.geometry.VdbGeometry-%} {%-include see-also.html links=site.data.user-reference.scene-objects.geometry.VdbGeometry.attributes.shadow_ray_epsilon.links heading=4-%}

+

shadow_ray_epsilon_falloff

+

+ Float +
+ default: 0.0 +

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.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.geometry.VdbGeometry.attributes.shadow_ray_epsilon_falloff.images data=site.data.user-reference.scene-objects.geometry.VdbGeometry-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.geometry.VdbGeometry.attributes.shadow_ray_epsilon_falloff.videos data=site.data.user-reference.scene-objects.geometry.VdbGeometry-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.geometry.VdbGeometry.attributes.shadow_ray_epsilon_falloff.links heading=4-%} +

diff --git a/docs/user-reference/scene-objects/lights/CylinderLight.md b/docs/user-reference/scene-objects/lights/CylinderLight.md index 427a26129..c173ba7a4 100644 --- a/docs/user-reference/scene-objects/lights/CylinderLight.md +++ b/docs/user-reference/scene-objects/lights/CylinderLight.md @@ -193,28 +193,15 @@ title: CylinderLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.clear_radius.videos data=site.data.user-reference.scene-objects.lights.CylinderLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.clear_radius.links heading=4-%}

-

clear_radius_falloff_distance

+

clear_radius_falloff

Float
default: 0.0 -

Distance over which the shadows fall off. Shadows are fully visible at a distance clear_radius + clear_radius_falloff_distance from the light, and fully invisble at a distance clear_radius from the light.

- {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.clear_radius_falloff_distance.images data=site.data.user-reference.scene-objects.lights.CylinderLight-%} - {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.clear_radius_falloff_distance.videos data=site.data.user-reference.scene-objects.lights.CylinderLight-%} - {%-include see-also.html links=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.clear_radius_falloff_distance.links heading=4-%} -

-

clear_radius_interpolation_type

-

- Int enum -
-   0 = “linear” (default)
-   1 = “exponential_up”
-   2 = “exponential_down”
-   3 = “smoothstep”
-

Interpolation type to use for the clear radius shadow falloff.

- {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.clear_radius_interpolation_type.images data=site.data.user-reference.scene-objects.lights.CylinderLight-%} - {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.clear_radius_interpolation_type.videos data=site.data.user-reference.scene-objects.lights.CylinderLight-%} - {%-include see-also.html links=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.clear_radius_interpolation_type.links heading=4-%} +

Value [0, 1] that controls the softness of the clear_radius terminator, where 0 means no falloff and 1 means full linear falloff from clear_radius to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.clear_radius_falloff.images data=site.data.user-reference.scene-objects.lights.CylinderLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.clear_radius_falloff.videos data=site.data.user-reference.scene-objects.lights.CylinderLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.clear_radius_falloff.links heading=4-%}

color

@@ -276,6 +263,16 @@ title: CylinderLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.max_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.CylinderLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.max_shadow_distance.links heading=4-%}

+

max_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the max_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from max_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.max_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.CylinderLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.max_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.CylinderLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.max_shadow_distance_falloff.links heading=4-%} +

mb

Bool @@ -296,6 +293,16 @@ title: CylinderLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.min_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.CylinderLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.min_shadow_distance.links heading=4-%}

+

min_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the min_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from min_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.min_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.CylinderLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.min_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.CylinderLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.CylinderLight.attributes.min_shadow_distance_falloff.links heading=4-%} +

normalized

Bool diff --git a/docs/user-reference/scene-objects/lights/DiskLight.md b/docs/user-reference/scene-objects/lights/DiskLight.md index a5e85ba09..8666aae00 100644 --- a/docs/user-reference/scene-objects/lights/DiskLight.md +++ b/docs/user-reference/scene-objects/lights/DiskLight.md @@ -193,28 +193,15 @@ title: DiskLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.DiskLight.attributes.clear_radius.videos data=site.data.user-reference.scene-objects.lights.DiskLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.DiskLight.attributes.clear_radius.links heading=4-%}

-

clear_radius_falloff_distance

+

clear_radius_falloff

Float
default: 0.0 -

Distance over which the shadows fall off. Shadows are fully visible at a distance clear_radius + clear_radius_falloff_distance from the light, and fully invisble at a distance clear_radius from the light.

- {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.DiskLight.attributes.clear_radius_falloff_distance.images data=site.data.user-reference.scene-objects.lights.DiskLight-%} - {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.DiskLight.attributes.clear_radius_falloff_distance.videos data=site.data.user-reference.scene-objects.lights.DiskLight-%} - {%-include see-also.html links=site.data.user-reference.scene-objects.lights.DiskLight.attributes.clear_radius_falloff_distance.links heading=4-%} -

-

clear_radius_interpolation_type

-

- Int enum -
-   0 = “linear” (default)
-   1 = “exponential_up”
-   2 = “exponential_down”
-   3 = “smoothstep”
-

Interpolation type to use for the clear radius shadow falloff.

- {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.DiskLight.attributes.clear_radius_interpolation_type.images data=site.data.user-reference.scene-objects.lights.DiskLight-%} - {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.DiskLight.attributes.clear_radius_interpolation_type.videos data=site.data.user-reference.scene-objects.lights.DiskLight-%} - {%-include see-also.html links=site.data.user-reference.scene-objects.lights.DiskLight.attributes.clear_radius_interpolation_type.links heading=4-%} +

Value [0, 1] that controls the softness of the clear_radius terminator, where 0 means no falloff and 1 means full linear falloff from clear_radius to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.DiskLight.attributes.clear_radius_falloff.images data=site.data.user-reference.scene-objects.lights.DiskLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.DiskLight.attributes.clear_radius_falloff.videos data=site.data.user-reference.scene-objects.lights.DiskLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.DiskLight.attributes.clear_radius_falloff.links heading=4-%}

color

@@ -266,6 +253,16 @@ title: DiskLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.DiskLight.attributes.max_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.DiskLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.DiskLight.attributes.max_shadow_distance.links heading=4-%}

+

max_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the max_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from max_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.DiskLight.attributes.max_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.DiskLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.DiskLight.attributes.max_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.DiskLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.DiskLight.attributes.max_shadow_distance_falloff.links heading=4-%} +

mb

Bool @@ -286,6 +283,16 @@ title: DiskLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.DiskLight.attributes.min_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.DiskLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.DiskLight.attributes.min_shadow_distance.links heading=4-%}

+

min_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the min_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from min_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.DiskLight.attributes.min_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.DiskLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.DiskLight.attributes.min_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.DiskLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.DiskLight.attributes.min_shadow_distance_falloff.links heading=4-%} +

normalized

Bool diff --git a/docs/user-reference/scene-objects/lights/DistantLight.md b/docs/user-reference/scene-objects/lights/DistantLight.md index cd5072c97..d582f7cf7 100644 --- a/docs/user-reference/scene-objects/lights/DistantLight.md +++ b/docs/user-reference/scene-objects/lights/DistantLight.md @@ -233,6 +233,16 @@ title: DistantLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.DistantLight.attributes.max_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.DistantLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.DistantLight.attributes.max_shadow_distance.links heading=4-%}

+

max_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the max_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from max_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.DistantLight.attributes.max_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.DistantLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.DistantLight.attributes.max_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.DistantLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.DistantLight.attributes.max_shadow_distance_falloff.links heading=4-%} +

mb

Bool @@ -253,6 +263,16 @@ title: DistantLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.DistantLight.attributes.min_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.DistantLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.DistantLight.attributes.min_shadow_distance.links heading=4-%}

+

min_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the min_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from min_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.DistantLight.attributes.min_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.DistantLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.DistantLight.attributes.min_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.DistantLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.DistantLight.attributes.min_shadow_distance_falloff.links heading=4-%} +

normalized

Bool diff --git a/docs/user-reference/scene-objects/lights/EnvLight.md b/docs/user-reference/scene-objects/lights/EnvLight.md index c62aaea80..34dbae63c 100644 --- a/docs/user-reference/scene-objects/lights/EnvLight.md +++ b/docs/user-reference/scene-objects/lights/EnvLight.md @@ -233,6 +233,16 @@ title: EnvLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.EnvLight.attributes.max_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.EnvLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.EnvLight.attributes.max_shadow_distance.links heading=4-%}

+

max_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the max_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from max_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.EnvLight.attributes.max_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.EnvLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.EnvLight.attributes.max_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.EnvLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.EnvLight.attributes.max_shadow_distance_falloff.links heading=4-%} +

mb

Bool @@ -253,6 +263,16 @@ title: EnvLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.EnvLight.attributes.min_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.EnvLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.EnvLight.attributes.min_shadow_distance.links heading=4-%}

+

min_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the min_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from min_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.EnvLight.attributes.min_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.EnvLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.EnvLight.attributes.min_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.EnvLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.EnvLight.attributes.min_shadow_distance_falloff.links heading=4-%} +

on

Bool diff --git a/docs/user-reference/scene-objects/lights/MeshLight.md b/docs/user-reference/scene-objects/lights/MeshLight.md index f461cd28d..c449917db 100644 --- a/docs/user-reference/scene-objects/lights/MeshLight.md +++ b/docs/user-reference/scene-objects/lights/MeshLight.md @@ -193,28 +193,15 @@ title: MeshLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.MeshLight.attributes.clear_radius.videos data=site.data.user-reference.scene-objects.lights.MeshLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.MeshLight.attributes.clear_radius.links heading=4-%}

-

clear_radius_falloff_distance

+

clear_radius_falloff

Float
default: 0.0 -

Distance over which the shadows fall off. Shadows are fully visible at a distance clear_radius + clear_radius_falloff_distance from the light, and fully invisble at a distance clear_radius from the light.

- {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.MeshLight.attributes.clear_radius_falloff_distance.images data=site.data.user-reference.scene-objects.lights.MeshLight-%} - {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.MeshLight.attributes.clear_radius_falloff_distance.videos data=site.data.user-reference.scene-objects.lights.MeshLight-%} - {%-include see-also.html links=site.data.user-reference.scene-objects.lights.MeshLight.attributes.clear_radius_falloff_distance.links heading=4-%} -

-

clear_radius_interpolation_type

-

- Int enum -
-   0 = “linear” (default)
-   1 = “exponential_up”
-   2 = “exponential_down”
-   3 = “smoothstep”
-

Interpolation type to use for the clear radius shadow falloff.

- {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.MeshLight.attributes.clear_radius_interpolation_type.images data=site.data.user-reference.scene-objects.lights.MeshLight-%} - {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.MeshLight.attributes.clear_radius_interpolation_type.videos data=site.data.user-reference.scene-objects.lights.MeshLight-%} - {%-include see-also.html links=site.data.user-reference.scene-objects.lights.MeshLight.attributes.clear_radius_interpolation_type.links heading=4-%} +

Value [0, 1] that controls the softness of the clear_radius terminator, where 0 means no falloff and 1 means full linear falloff from clear_radius to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.MeshLight.attributes.clear_radius_falloff.images data=site.data.user-reference.scene-objects.lights.MeshLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.MeshLight.attributes.clear_radius_falloff.videos data=site.data.user-reference.scene-objects.lights.MeshLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.MeshLight.attributes.clear_radius_falloff.links heading=4-%}

color

@@ -286,6 +273,16 @@ title: MeshLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.MeshLight.attributes.max_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.MeshLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.MeshLight.attributes.max_shadow_distance.links heading=4-%}

+

max_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the max_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from max_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.MeshLight.attributes.max_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.MeshLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.MeshLight.attributes.max_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.MeshLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.MeshLight.attributes.max_shadow_distance_falloff.links heading=4-%} +

mb

Bool @@ -306,6 +303,16 @@ title: MeshLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.MeshLight.attributes.min_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.MeshLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.MeshLight.attributes.min_shadow_distance.links heading=4-%}

+

min_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the min_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from min_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.MeshLight.attributes.min_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.MeshLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.MeshLight.attributes.min_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.MeshLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.MeshLight.attributes.min_shadow_distance_falloff.links heading=4-%} +

normalized

Bool diff --git a/docs/user-reference/scene-objects/lights/RectLight.md b/docs/user-reference/scene-objects/lights/RectLight.md index 3d547e52f..f03245b1b 100644 --- a/docs/user-reference/scene-objects/lights/RectLight.md +++ b/docs/user-reference/scene-objects/lights/RectLight.md @@ -193,28 +193,15 @@ title: RectLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.RectLight.attributes.clear_radius.videos data=site.data.user-reference.scene-objects.lights.RectLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.RectLight.attributes.clear_radius.links heading=4-%}

-

clear_radius_falloff_distance

+

clear_radius_falloff

Float
default: 0.0 -

Distance over which the shadows fall off. Shadows are fully visible at a distance clear_radius + clear_radius_falloff_distance from the light, and fully invisble at a distance clear_radius from the light.

- {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.RectLight.attributes.clear_radius_falloff_distance.images data=site.data.user-reference.scene-objects.lights.RectLight-%} - {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.RectLight.attributes.clear_radius_falloff_distance.videos data=site.data.user-reference.scene-objects.lights.RectLight-%} - {%-include see-also.html links=site.data.user-reference.scene-objects.lights.RectLight.attributes.clear_radius_falloff_distance.links heading=4-%} -

-

clear_radius_interpolation_type

-

- Int enum -
-   0 = “linear” (default)
-   1 = “exponential_up”
-   2 = “exponential_down”
-   3 = “smoothstep”
-

Interpolation type to use for the clear radius shadow falloff.

- {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.RectLight.attributes.clear_radius_interpolation_type.images data=site.data.user-reference.scene-objects.lights.RectLight-%} - {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.RectLight.attributes.clear_radius_interpolation_type.videos data=site.data.user-reference.scene-objects.lights.RectLight-%} - {%-include see-also.html links=site.data.user-reference.scene-objects.lights.RectLight.attributes.clear_radius_interpolation_type.links heading=4-%} +

Value [0, 1] that controls the softness of the clear_radius terminator, where 0 means no falloff and 1 means full linear falloff from clear_radius to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.RectLight.attributes.clear_radius_falloff.images data=site.data.user-reference.scene-objects.lights.RectLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.RectLight.attributes.clear_radius_falloff.videos data=site.data.user-reference.scene-objects.lights.RectLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.RectLight.attributes.clear_radius_falloff.links heading=4-%}

color

@@ -276,6 +263,16 @@ title: RectLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.RectLight.attributes.max_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.RectLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.RectLight.attributes.max_shadow_distance.links heading=4-%}

+

max_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the max_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from max_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.RectLight.attributes.max_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.RectLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.RectLight.attributes.max_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.RectLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.RectLight.attributes.max_shadow_distance_falloff.links heading=4-%} +

mb

Bool @@ -296,6 +293,16 @@ title: RectLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.RectLight.attributes.min_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.RectLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.RectLight.attributes.min_shadow_distance.links heading=4-%}

+

min_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the min_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from min_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.RectLight.attributes.min_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.RectLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.RectLight.attributes.min_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.RectLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.RectLight.attributes.min_shadow_distance_falloff.links heading=4-%} +

normalized

Bool diff --git a/docs/user-reference/scene-objects/lights/SphereLight.md b/docs/user-reference/scene-objects/lights/SphereLight.md index 233bf84db..2df1184c3 100644 --- a/docs/user-reference/scene-objects/lights/SphereLight.md +++ b/docs/user-reference/scene-objects/lights/SphereLight.md @@ -193,28 +193,15 @@ title: SphereLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SphereLight.attributes.clear_radius.videos data=site.data.user-reference.scene-objects.lights.SphereLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SphereLight.attributes.clear_radius.links heading=4-%}

-

clear_radius_falloff_distance

+

clear_radius_falloff

Float
default: 0.0 -

Distance over which the shadows fall off. Shadows are fully visible at a distance clear_radius + clear_radius_falloff_distance from the light, and fully invisble at a distance clear_radius from the light.

- {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.SphereLight.attributes.clear_radius_falloff_distance.images data=site.data.user-reference.scene-objects.lights.SphereLight-%} - {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SphereLight.attributes.clear_radius_falloff_distance.videos data=site.data.user-reference.scene-objects.lights.SphereLight-%} - {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SphereLight.attributes.clear_radius_falloff_distance.links heading=4-%} -

-

clear_radius_interpolation_type

-

- Int enum -
-   0 = “linear” (default)
-   1 = “exponential_up”
-   2 = “exponential_down”
-   3 = “smoothstep”
-

Interpolation type to use for the clear radius shadow falloff.

- {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.SphereLight.attributes.clear_radius_interpolation_type.images data=site.data.user-reference.scene-objects.lights.SphereLight-%} - {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SphereLight.attributes.clear_radius_interpolation_type.videos data=site.data.user-reference.scene-objects.lights.SphereLight-%} - {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SphereLight.attributes.clear_radius_interpolation_type.links heading=4-%} +

Value [0, 1] that controls the softness of the clear_radius terminator, where 0 means no falloff and 1 means full linear falloff from clear_radius to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.SphereLight.attributes.clear_radius_falloff.images data=site.data.user-reference.scene-objects.lights.SphereLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SphereLight.attributes.clear_radius_falloff.videos data=site.data.user-reference.scene-objects.lights.SphereLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SphereLight.attributes.clear_radius_falloff.links heading=4-%}

color

@@ -266,6 +253,16 @@ title: SphereLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SphereLight.attributes.max_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.SphereLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SphereLight.attributes.max_shadow_distance.links heading=4-%}

+

max_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the max_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from max_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.SphereLight.attributes.max_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.SphereLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SphereLight.attributes.max_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.SphereLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SphereLight.attributes.max_shadow_distance_falloff.links heading=4-%} +

mb

Bool @@ -286,6 +283,16 @@ title: SphereLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SphereLight.attributes.min_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.SphereLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SphereLight.attributes.min_shadow_distance.links heading=4-%}

+

min_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the min_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from min_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.SphereLight.attributes.min_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.SphereLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SphereLight.attributes.min_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.SphereLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SphereLight.attributes.min_shadow_distance_falloff.links heading=4-%} +

normalized

Bool diff --git a/docs/user-reference/scene-objects/lights/SpotLight.md b/docs/user-reference/scene-objects/lights/SpotLight.md index 03e14e031..c67e81d0c 100644 --- a/docs/user-reference/scene-objects/lights/SpotLight.md +++ b/docs/user-reference/scene-objects/lights/SpotLight.md @@ -277,28 +277,15 @@ title: SpotLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SpotLight.attributes.clear_radius.videos data=site.data.user-reference.scene-objects.lights.SpotLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SpotLight.attributes.clear_radius.links heading=4-%}

-

clear_radius_falloff_distance

+

clear_radius_falloff

Float
default: 0.0 -

Distance over which the shadows fall off. Shadows are fully visible at a distance clear_radius + clear_radius_falloff_distance from the light, and fully invisble at a distance clear_radius from the light.

- {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.SpotLight.attributes.clear_radius_falloff_distance.images data=site.data.user-reference.scene-objects.lights.SpotLight-%} - {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SpotLight.attributes.clear_radius_falloff_distance.videos data=site.data.user-reference.scene-objects.lights.SpotLight-%} - {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SpotLight.attributes.clear_radius_falloff_distance.links heading=4-%} -

-

clear_radius_interpolation_type

-

- Int enum -
-   0 = “linear” (default)
-   1 = “exponential_up”
-   2 = “exponential_down”
-   3 = “smoothstep”
-

Interpolation type to use for the clear radius shadow falloff.

- {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.SpotLight.attributes.clear_radius_interpolation_type.images data=site.data.user-reference.scene-objects.lights.SpotLight-%} - {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SpotLight.attributes.clear_radius_interpolation_type.videos data=site.data.user-reference.scene-objects.lights.SpotLight-%} - {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SpotLight.attributes.clear_radius_interpolation_type.links heading=4-%} +

Value [0, 1] that controls the softness of the clear_radius terminator, where 0 means no falloff and 1 means full linear falloff from clear_radius to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.SpotLight.attributes.clear_radius_falloff.images data=site.data.user-reference.scene-objects.lights.SpotLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SpotLight.attributes.clear_radius_falloff.videos data=site.data.user-reference.scene-objects.lights.SpotLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SpotLight.attributes.clear_radius_falloff.links heading=4-%}

color

@@ -350,6 +337,16 @@ title: SpotLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SpotLight.attributes.max_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.SpotLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SpotLight.attributes.max_shadow_distance.links heading=4-%}

+

max_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the max_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from max_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.SpotLight.attributes.max_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.SpotLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SpotLight.attributes.max_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.SpotLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SpotLight.attributes.max_shadow_distance_falloff.links heading=4-%} +

mb

Bool @@ -370,6 +367,16 @@ title: SpotLight {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SpotLight.attributes.min_shadow_distance.videos data=site.data.user-reference.scene-objects.lights.SpotLight-%} {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SpotLight.attributes.min_shadow_distance.links heading=4-%}

+

min_shadow_distance_falloff

+

+ Float +
+ default: 0.0 +

Value [0, 1] that controls the softness of the min_shadow_distance terminator, where 0 means no falloff and 1 means full linear falloff from min_shadow_distance to 0.

+ {%-include image-gallery.html images=site.data.user-reference.scene-objects.lights.SpotLight.attributes.min_shadow_distance_falloff.images data=site.data.user-reference.scene-objects.lights.SpotLight-%} + {%-include video-gallery.html videos=site.data.user-reference.scene-objects.lights.SpotLight.attributes.min_shadow_distance_falloff.videos data=site.data.user-reference.scene-objects.lights.SpotLight-%} + {%-include see-also.html links=site.data.user-reference.scene-objects.lights.SpotLight.attributes.min_shadow_distance_falloff.links heading=4-%} +

normalized

Bool