Installation
Choose your framework. The registry installs one component file and its PixiJS 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/WatercolorImage.svelte and installs its dependencies.
The registry command writes the component to src/components/ui/WatercolorImage.tsx and installs its dependencies.
The registry command writes the component to src/components/ui/WatercolorImage.vue and installs its dependencies.
Overview
Watercolor Image uses a Sobel structure tensor to steer an eight-sector anisotropic Kuwahara filter while preserving the source color.
The filtered image is rendered over the same procedural paper grain used by Pencil Logo. It has no fluid simulation, reveal mask, or desaturation stage.
Basic usage
The shader fills its parent. Your layout decides whether that parent is a card, hero, or viewport.
- Use Watercolor radius to control the scale of the painted color regions.
- The tensor and watercolor passes are cached and rerun only when the image, filter radius, fit, size, or rendering quality changes.
- Higher filter radius, target resolution, and device pixel ratio increase the preprocessing cost.
Component API
Types below match the selected Svelte component.
Additional classes for the parent-sized root element.
- Type
string
URL or data URL processed by the watercolor passes.
- 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
Radius of the structure-tensor-guided anisotropic Kuwahara filter.
- Type
number- Default
6- Range / values
1–12
Color saturation applied after the watercolor filter.
- Type
number- Default
2- Range / values
0–2
Strength of the procedural paper grain shared with Pencil Logo.
- Type
number- Default
1- Range / values
0–2
Stops the render loop while keeping the current frame visible.
- Type
boolean- Default
false
Enables pointer-driven effects when the shader supports them.
- Type
boolean- Default
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
URL or data URL processed by the watercolor passes.
- 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
Radius of the structure-tensor-guided anisotropic Kuwahara filter.
- Type
number- Default
6- Range / values
1–12
Color saturation applied after the watercolor filter.
- Type
number- Default
2- Range / values
0–2
Strength of the procedural paper grain shared with Pencil Logo.
- Type
number- Default
1- Range / values
0–2
Stops the render loop while keeping the current frame visible.
- Type
boolean- Default
false
Enables pointer-driven effects when the shader supports them.
- Type
boolean- Default
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
WatercolorImageHandle- Range / values
pause, resume, reset, resize, destroy
Types below match the selected Vue component.
Additional classes for the parent-sized root element.
- Type
string
URL or data URL processed by the watercolor passes.
- 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
Radius of the structure-tensor-guided anisotropic Kuwahara filter.
- Type
number- Default
6- Range / values
1–12
Color saturation applied after the watercolor filter.
- Type
number- Default
2- Range / values
0–2
Strength of the procedural paper grain shared with Pencil Logo.
- Type
number- Default
1- Range / values
0–2
Stops the render loop while keeping the current frame visible.
- Type
boolean- Default
false
Enables pointer-driven effects when the shader supports them.
- Type
boolean- Default
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