Captures scene height / water depth, and renders it into the simulation.
Caches the operation to avoid rendering it every frame. This should be used for static geometry, dynamic objects should be tagged with the DepthLodInput component.
Related: Shorelines & Shallows
Properties¶
Type |
Specifies the setup for this probe. |
Real Time |
Update in real-time in accordance to refresh mode. |
Baked |
Baked in the editor. |
Placement |
Where the Depth Probe is placed. The default performs the best. |
Fixed |
The component is in a fixed position. |
Transform |
The component follows the transform. |
Viewpoint |
The component follows the viewpoint. |
Refresh Mode |
Controls how the probe is refreshed in the Player. Call Populate() if scripting. When Placement is not set to Fixed, EveryFrame is still applicable, but the others are not (update only happens on position change). |
On Start |
Populates the DepthProbe in Start. |
Every Frame |
Populates the DepthProbe every frame. |
Via Scripting |
Requires manual updating via DepthProbe.Populate. |
Capture¶
Layers |
The layers to render into the probe. |
Resolution |
The resolution of the probe. Lower will be more efficient. |
Capture Range |
The far and near plane of the depth probe camera respectively, relative to the transform. Depth is captured top-down and orthographically. The gizmo will visualize this range as the bottom box. |
Fill Holes Capture Height |
Fills holes left by the maximum of the capture range. Setting the maximum capture range lower than the highest point of geometry can be useful for eliminating depth artifacts from overhangs, but the side effect is there will be a hole in the depth data where geometry is clipped by the near plane. This will only capture where the holes are to fill them in. This height is relative to the maximum capture range. Set to zero to skip. |
Enable Back-Face Inclusion |
Increase coverage by testing mesh back faces within the Fill Holes area. Uses the back-faces to include meshes where the front-face is within the Fill Holes area and the back-face is within the capture area. An example would be an upright cylinder not over a hole but was not captured due to the top being clipped by the near plane. |
Quality Settings Override |
Overrides global quality settings. |
Saved Texture |
Baked probe. Can only bake in edit mode. |
Signed Distance Field¶
Generate |
Generate a signed distance field for the shoreline. |
Additional Jump Flood Rounds |
How many additional Jump Flood rounds to use. The standard number of rounds is log2(resolution). Additional rounds can reduce inaccuracies. |