Image Liquid Metal

Presets

Installation

npm i @paper-design/shaders-react

Code

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

<ImageLiquidMetal
  width={1280}
  height={720}
  image="https://shaders.paper.design/diamond.webp"
  colorBack="#000000"
  colorTint="#ffffff"
  repetition={2}
  softness={0.2}
  shiftRed={0.25}
  shiftBlue={0.3}
  distortion={0.07}
  speed={1}
  scale={0.6}
  fit="contain"
/>

Shader Props

Name	Description	Type	Values
colorBack	Background color	`string`	Hex, RGB, or HSL color
colorTint	Overlay color	`string`	Hex, RGB, or HSL color
image	The image to use for the effect	`HTMLImageElement \| string`	Image object or URL
edge	TODO	`number`	0 to 1
distortion	TODO	`number`	0 to 1
softness	TODO	`number`	0 to 1
shiftRed	R-channel dispersion	`number`	-1 to 1
shiftBlue	B-channel dispersion	`number`	-1 to 1
repetition	TODO	`number`	1 to 10

Common Props

Name	Description	Type	Values
speed	Animation speed	`number`	—
frame	Starting animation frame	`number`	—
scale	Overall zoom level of the graphics	`number`	0.01 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"`
worldWidth	Virtual width of the graphic before it's scaled to fit the canvas	`number`	—
worldHeight	Virtual height of the graphic before it's scaled to fit the canvas	`number`	—
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	`number`	—
maxPixelCount	Maximum pixel count that the shader may process	`number`	—

Description

TODO