Umi Water — known limits
What the water does not do, so you do not find out the hard way. Limits of the add-ons are in their own documentation (Umi Water Pro, Umi Boat Physics).
Project and platforms
- URP only (Unity 6000.0+, URP 17.0+). HDRP and the Built-in pipeline are not supported. URP Compatibility Mode must be off (Project Settings > Graphics > Render Graph): the water's fog, motion-vector and depth passes exist only in Render Graph. The Setup Check reports it as an Error.
- XR / VR is not supported (the Setup Check shows an Info when an XR package is installed).
- Needs Depth Texture and Opaque Texture on in every URP asset (the Setup Check fixes it).
- Windows, macOS, Linux, Android (Vulkan and GLES3) and WebGL 2 run Umi Water. A weak phone (Adreno 610) runs the water at Low quality only: Medium and High are for desktop and strong phones. On Android / iOS the water is Low quality on the Mobile Quality Settings level, and a build with a single Quality level is Low on mobile platforms.
- WebGL: the browser limits the frame rate to the screen's vsync, and Chrome pauses WebGL when its window is covered.
- A build includes about 1.1 MB of textures and the water shaders whether or not the scene uses water (they live in
Resources).
Waves and the surface
- Rotate the water around Y only; no tilt and no scale (set
Sizeinstead). The Setup Check fixes both. - Gerstner waves do not know the depth of the water, so near a beach they do not fade: the waves climb it and bare the sea floor. Use lower waves or a steeply dropping floor; Umi Water Pro's
WaterShorefades and breaks the waves properly. - Core has no ripple or wake waves on the surface (foam and spray particles work); they come with Umi Water Pro.
- A surface uses one shore map, one ripple overlay and one geometry (
WaterInfinite); a second one warns and is ignored. - Several water bodies that meet (a river and a lake) should be one
WaterSurface. - Keep the mesh cell (
Size / Resolution,WaterInfiniteCell Size) at most 1/6 of the shortest wave, or the crests look faceted (the inspector warns). - After you change the quality or shader in the editor, the water can disappear for a few seconds while the shader compiles (not in a player).
What the water draws
- The water refracts the opaque scene. Transparent objects are not seen through the surface and get no underwater fog; soft particles and transparents drawn after the water do not see its depth. Draw them after the water (render queue) or make them opaque / alpha-tested.
- Point and spot lights light the water seen from above (shine, body, foam), with shadows in Forward+; not from below the surface, not in the underwater fog, and not at Low quality. Light cookies and light layers are ignored. In normal Forward URP's per-object light limit applies to every surface and patch.
- Bioluminescence (the foam's night glow) is seen from above only, not at Low quality, and does not light its surroundings.
- Reflections: reflection probes and screen-space reflection of the Pro shader. A scene without a baked reflection probe has flat reflections.
WaterMaskhides the water inside a closed mesh (a boat's cockpit); physics does not see it. The mask must stay inside the hull: along the view ray it covers everything from the nearest front face to the farthest back face, so a mask that sticks out of the hull also cuts the water next to it.- Water, underwater fog and the Pro effects are drawn only for cameras whose culling mask has the water's layer. An overlay camera (camera stack) gets no fog or caustics: remove the water's layer from its culling mask, or the water is drawn twice there.
- Orthographic cameras draw the water correctly, but the open sea's levels of detail are not scaled by the field of view, so with an orthographic or a very narrow view the far rings are in the wrong place.
- Motion vectors (TAA / STP / motion blur) cover the surface's geometry, not the detail normal, current or foam.
Physics
- Physics reads the water only through
WaterSurface.TrySampleAny(height, normal, velocity); it never reads the mesh or the shader. A query returnsfalsewhere there is no water. Position inputs must not be NaN or infinite. - Water forces run in
FixedUpdateonly: they are not applied inside your ownPhysics.Simulatecalls. Buoyancybuilds voxels from the collider: a mesh collider without Read/Write is approximated by its bounds (the inspector warns and enables Read/Write with one click); a non-convex mesh collider spreads the voxels over its bounding box. Scaled flat colliders (rafts, planks) are accurate.- A kinematic Rigidbody does not float, and a body with only a trigger collider gets no buoyancy and no collisions: the Setup Check says so.
- A body's wave making (
WaterInteractor) is a vertical cylinder; a long thin object (an oar) is a short column. - The wave clock is
WaterTime, shared by shader and physics. Use it, neverTime.time, for anything that must match the waves.
Quality and cost
- Quality follows the Quality Settings level in effect; physics is the same at every level.
- Low quality leaves out refraction offset, SSR, caustics, bioluminescence, point-light shine and light shafts, and halves the mesh density.
- The costs we measured and the budget they stay in are in the FAQ ("It is slow") and on the store page; they are for our test scenes, not a guarantee for yours.