Installation
Choose your framework. The registry installs the component and its runtime dependency.
Installation unavailable
The preview is public, but its installable release is still being prepared.
The registry command writes the component to src/lib/components/ui/FluidDisplacement.svelte and installs its dependencies.
The registry command writes the component to src/components/ui/FluidDisplacement.tsx and installs its dependencies.
The registry command writes the component to src/components/ui/FluidDisplacement.vue and installs its dependencies.
Basic usage
The shader fills its parent. Your layout decides whether that parent is a card, hero, or viewport.
Component API
Types below match the selected Svelte component.
Additional classes for the parent-sized root element.
- Type
string
Image distorted by the fluid motion.
- Type
string- Range / values
Image URL or data URL
Controls how the source image is placed inside the canvas.
- Type
"cover" | "fit" | "stretch"- Default
"cover"- Range / values
cover, fit, stretch
Maximum distance the flowing field pulls the image.
- Type
number- Default
0.055- Range / values
0–0.15
Detail level of the fluid motion along the shorter edge.
- Type
number- Default
256- Range / values
32–256
Detail level of the flowing displacement field.
- Type
number- Default
512- Range / values
128–1024
How quickly the displaced image settles back into its original position.
- Type
number- Default
8- Range / values
0.1–8
How quickly the underlying fluid motion loses momentum.
- Type
number- Default
0.8- Range / values
0–8
Amount of pressure retained between simulation steps.
- Type
number- Default
0.8- Range / values
0–1
Number of pressure passes used to preserve fluid volume. Higher values improve accuracy and cost more to render.
- Type
number- Default
10- Range / values
1–40
Strength of the small rolling eddies in the fluid.
- Type
number- Default
0- Range / values
0–50
Width of the fluid affected by pointer movement.
- Type
number- Default
0.45- Range / values
0.01–1
Momentum added to the fluid by pointer movement.
- Type
number- Default
9000- Range / values
0–10000
Stops the render loop while keeping the current frame visible.
- Type
boolean- Default
false
Enables pointer displacement. Disabling stops new impulses while existing distortion continues to relax.
- Type
boolean- Default
true- Range / values
true, false
Caps render resolution independently from the element size.
- Type
number- Default
2- Range / values
1–3
Scales GPU resolution without changing layout dimensions.
- Type
number- Default
1- Range / values
0.25–1
Runs after the shader is mounted successfully, including a WebGL fallback.
- Type
(backend: ShaderBackend) => void- Range / values
webgpu, webgl
Runs when automatic initialization changes the requested WebGPU backend to WebGL.
- Type
(backend: ShaderBackend, reason: string) => void- Range / values
webgl
Reports source-loading or renderer failures so the host application can decide how to recover.
- Type
(error: Error) => void
Exposes the imperative component lifecycle methods.
- Type
Component public instance- Range / values
pause, resume, reset, resize, destroy
Types below match the selected React component.
Additional classes for the parent-sized root element.
- Type
string
Image distorted by the fluid motion.
- Type
string- Range / values
Image URL or data URL
Controls how the source image is placed inside the canvas.
- Type
"cover" | "fit" | "stretch"- Default
"cover"- Range / values
cover, fit, stretch
Maximum distance the flowing field pulls the image.
- Type
number- Default
0.055- Range / values
0–0.15
Detail level of the fluid motion along the shorter edge.
- Type
number- Default
256- Range / values
32–256
Detail level of the flowing displacement field.
- Type
number- Default
512- Range / values
128–1024
How quickly the displaced image settles back into its original position.
- Type
number- Default
8- Range / values
0.1–8
How quickly the underlying fluid motion loses momentum.
- Type
number- Default
0.8- Range / values
0–8
Amount of pressure retained between simulation steps.
- Type
number- Default
0.8- Range / values
0–1
Number of pressure passes used to preserve fluid volume. Higher values improve accuracy and cost more to render.
- Type
number- Default
10- Range / values
1–40
Strength of the small rolling eddies in the fluid.
- Type
number- Default
0- Range / values
0–50
Width of the fluid affected by pointer movement.
- Type
number- Default
0.45- Range / values
0.01–1
Momentum added to the fluid by pointer movement.
- Type
number- Default
9000- Range / values
0–10000
Stops the render loop while keeping the current frame visible.
- Type
boolean- Default
false
Enables pointer displacement. Disabling stops new impulses while existing distortion continues to relax.
- Type
boolean- Default
true- Range / values
true, false
Caps render resolution independently from the element size.
- Type
number- Default
2- Range / values
1–3
Scales GPU resolution without changing layout dimensions.
- Type
number- Default
1- Range / values
0.25–1
Runs after the shader is mounted successfully, including a WebGL fallback.
- Type
(backend: ShaderBackend) => void- Range / values
webgpu, webgl
Runs when automatic initialization changes the requested WebGPU backend to WebGL.
- Type
(backend: ShaderBackend, reason: string) => void- Range / values
webgl
Reports source-loading or renderer failures so the host application can decide how to recover.
- Type
(error: Error) => void
Exposes the imperative component lifecycle methods.
- Type
FluidDisplacementHandle- Range / values
pause, resume, reset, resize, destroy
Types below match the selected Vue component.
Additional classes for the parent-sized root element.
- Type
string
Image distorted by the fluid motion.
- Type
string- Range / values
Image URL or data URL
Controls how the source image is placed inside the canvas.
- Type
"cover" | "fit" | "stretch"- Default
"cover"- Range / values
cover, fit, stretch
Maximum distance the flowing field pulls the image.
- Type
number- Default
0.055- Range / values
0–0.15
Detail level of the fluid motion along the shorter edge.
- Type
number- Default
256- Range / values
32–256
Detail level of the flowing displacement field.
- Type
number- Default
512- Range / values
128–1024
How quickly the displaced image settles back into its original position.
- Type
number- Default
8- Range / values
0.1–8
How quickly the underlying fluid motion loses momentum.
- Type
number- Default
0.8- Range / values
0–8
Amount of pressure retained between simulation steps.
- Type
number- Default
0.8- Range / values
0–1
Number of pressure passes used to preserve fluid volume. Higher values improve accuracy and cost more to render.
- Type
number- Default
10- Range / values
1–40
Strength of the small rolling eddies in the fluid.
- Type
number- Default
0- Range / values
0–50
Width of the fluid affected by pointer movement.
- Type
number- Default
0.45- Range / values
0.01–1
Momentum added to the fluid by pointer movement.
- Type
number- Default
9000- Range / values
0–10000
Stops the render loop while keeping the current frame visible.
- Type
boolean- Default
false
Enables pointer displacement. Disabling stops new impulses while existing distortion continues to relax.
- Type
boolean- Default
true- Range / values
true, false
Caps render resolution independently from the element size.
- Type
number- Default
2- Range / values
1–3
Scales GPU resolution without changing layout dimensions.
- Type
number- Default
1- Range / values
0.25–1
Runs after the shader is mounted successfully, including a WebGL fallback.
- Type
(backend: ShaderBackend) => void- Range / values
webgpu, webgl
Runs when automatic initialization changes the requested WebGPU backend to WebGL.
- Type
(backend: ShaderBackend, reason: string) => void- Range / values
webgl
Reports source-loading or renderer failures so the host application can decide how to recover.
- Type
(error: Error) => void
Exposes the imperative component lifecycle methods.
- Type
Component public instance- Range / values
pause, resume, reset, resize, destroy