Water

Presets

Click to change the sample image

Installation

npm i @paper-design/shaders-react

Code

import { Water } from '@paper-design/shaders-react';

<Water
  width={1280}
  height={720}
  image="https://paper.design/flowers.webp"
  colorBack="#8f8f8f"
  colorHighlight="#ffffff"
  highlights={0.07}
  layering={0.5}
  edges={0.8}
  waves={0.3}
  caustic={0.1}
  size={1}
  speed={1}
  scale={0.8}
  fit="contain"
/>

Shader Props

Name	Description	Type	Values
image	The image to use for the effect	`HTMLImageElement \| string`	Image object or URL
colorBack	Background color	`string`	Hex, RGB, or HSL color
colorHighlight	Highlight color (needs highlights > 0)	`string`	Hex, RGB, or HSL color
highlights	A coloring added over the image/background, following the caustic shape (needs colorHighlight alpha > 0)	`number`	0 to 1
layering	The power of 2nd layer of caustic distortion (needs caustic or highlights > 0)	`number`	0 to 1
edges	Caustic distortion power on the image edges (needs image and caustic > 0)	`number`	0 to 1
waves	Additional distortion based in simplex noise, independent from caustic	`number`	0 to 1
caustic	Power of caustic distortion (needs image)	`number`	0 to 1
size	Pattern scale relative to the image	`number`	0.01 to 7

Common Props

Name	Description	Type	Values
speed	Controls how fast the animation runs. speed=0 stops the animation loop, and speed=1 defines frame prop as timestamp in milliseconds	`number`	—
frame	Starting point of the animation. When speed=1, this value is treated as start time in milliseconds (try large frame values to see the difference). When speed=0 frame fully defines the state of static shader	`number`	—
scale	Overall zoom level of the graphics	`number`	0.1 to 4
rotation	Overall rotation angle of the graphics	`number`	0 to 360
offsetX	Horizontal offset of the graphics center	`number`	-1 to 1
offsetY	Vertical offset of the graphics center	`number`	-1 to 1
width	CSS width style of the shader element	`number \| string`	—
height	CSS height style of the shader element	`number \| string`	—
fit	How to fit the rendered shader into the canvas dimensions	`enum`	\| `"contain"` \| `"cover"`
originX	Reference point for positioning world width in the canvas	`number`	0 to 1
originY	Reference point for positioning world height in the canvas	`number`	0 to 1
minPixelRatio	Minimum pixel ratio to use when rendering the shader (default is 2 for double resolution)	`number`	—
maxPixelCount	Maximum pixel count that the shader may process	`number`	—

Description

Water-like surface distortion with natural caustic realism. Works as an image filter or standalone animated texture.

Notes

Thanks to zozuar for the amazing recursive fractal noise algorithm.