Lens Distortion

Presets

Click to change the sample image

Installation

npm i @paper-design/shaders-react

Code

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

<LensDistortion
  width={1280}
  height={720}
  image="https://paper.design/flowers.webp"
  spread={0.6}
  bias={1}
  angle={0}
  perspective={0.1}
  count={35}
  dispersion={1}
  dispersionShift={0}
  dispersionColor={0.6}
  focusCenter={0.8}
  focusEdges={1}
  swirl={0.35}
  noise={0}
  noiseFrequency={0.25}
  noiseOffset={0}
  lensBulge={0}
  lensCircle={0}
  grainMixer={0}
  grainOverlay={0}
  imageX={0}
  imageY={0}
  fit="contain"
/>

Shader Props

Name	Description	Type	Values
image	The image to use for the effect	`HTMLImageElement \| string`	Image object or URL
spread	Strength of the color split - how far the color layers are pushed apart. This is the master dial for the chromatic aberration; at 0 there is no split and all the other color controls do nothing	`number`	0 to 1
bias	Bias of the color spread: warps how the colors distribute along it. 0 spaces them evenly; toward +/-1 they bunch toward one end of the fan and spread out at the other (no effect with spread = 0)	`number`	-1 to 1
angle	Angle of the color spread in degrees (no effect with spread = 0 or perspective = 1)	`number`	0 to 360
perspective	Perspective of the spread: shapes its direction from a straight line to a radial burst. At 0 all layers spread along the straight line set by angle; at 1 they radiate outward from the centre (no effect with spread = 0)	`number`	0 to 1
count	Number of colored layers making the spread - more layers blend into a blur, fewer stay as separate ghosted copies (no effect with spread = 0)	`number`	2 to 50 (integer)
dispersion	Overall amount of color dispersion: at 1 each layer takes its own color from the spectrum, giving the chromatic aberration look; at 0 every layer keeps the original image color, so the spread reads as a plain blur (no effect with spread = 0)	`number`	0 to 1
dispersionShift	Balances the dispersion between a soft circular zone at the centre of the image and the rest of it: 0 applies it evenly over the whole image, -1 keeps it in the centre only, 1 keeps it at the edges only (no effect with spread = 0 or dispersion = 0)	`number`	-1 to 1
dispersionColor	Rotates the colors around the hue wheel, 0 to 1 for a full turn (no effect with spread = 0 or dispersion = 0)	`number`	0 to 1
focusCenter	Reduces the spread distance in a circular zone at the centre of the image. 0 keeps the full layers spread in the middle, higher values move the layers closer building an illusion of focus (no effect with spread = 0)	`number`	0 to 1
focusEdges	Reduces the spread distance along the image edges. 0 keeps the full layers spread at the edges, 1 restores the original image at the edges regardless of the chosen spread distance (no effect with spread = 0)	`number`	0 to 1
swirl	Bends the spread around the centre of the image, so the layers trail along circles like a vortex. Each layer is rotated around the centre by an angle growing along the spread, and the effect fades out beyond the inscribed circle (no effect with spread = 0)	`number`	-1 to 1
noise	Noise distortion over the spread direction within the spread distance (no effect with spread = 0)	`number`	0 to 1
noiseFrequency	Noise frequency (scale), higher value gives more detailed distortion (no effect with spread = 0 or noise = 0)	`number`	0 to 1
noiseOffset	Shifts the noise pattern diagonally, can be used as a seed to get a different scatter (no effect with spread = 0 or noise = 0)	`number`	0 to 30
lensBulge	Lens warp of the image geometry, applied before the color spread. 0 is flat, positive bulges out like a fisheye, negative pinches in like a pincushion. Strong positive values fade out the corners of the image	`number`	-1 to 1
lensCircle	Squeezes pixels outside the circle inward. 0 is off, 1 gives the image exact circular shape with any lensBulge value. Near the rim it also turns the spread radial and damps it, keeping the circular edge clean	`number`	0 to 1
grainMixer	Scatters the spread with grain noise, breaking up the edges of the colored layers (no effect with spread = 0)	`number`	0 to 1
grainOverlay	Post-processing b/w grain overlay	`number`	0 to 1
imageX	Pans the image horizontally behind the effect, without moving the effect itself. 0 is centred	`number`	-1 to 1
imageY	Pans the image vertically behind the effect, without moving the effect itself. 0 is centred	`number`	-1 to 1

Common Props

Name	Description	Type	Values
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"`
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

Lens Distortion image filter separates an image into shifting color layers (recreating the chromatic aberration of a lens) and warps the image geometry itself, curving it outward or inward like barrel and pincushion distortion.