Halftone Dots

Presets

Click to change the sample image

Installation

npm i @paper-design/shaders-react

Code

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

<HalftoneDots
  width={1280}
  height={720}
  image="https://paper.design/flowers.webp"
  colorBack="#f2f1e8"
  colorFront="#2b2b2b"
  originalColors={false}
  type="gooey"
  grid="hex"
  inverted={false}
  size={0.5}
  radius={1.25}
  contrast={0.4}
  grainMixer={0.2}
  grainOverlay={0.2}
  grainSize={0.5}
  fit="cover"
/>

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
colorFront	Foreground color (needs originalColors off)	`string`	Hex, RGB, or HSL color
originalColors	Use the sampled image’s original colors instead of colorFront	`boolean`	\| `true` \| `false`
type	Dot style	`enum`	\| `"classic"` \| `"gooey"` \| `"holes"` \| `"soft"`
inverted	Inverts the image luminance, doesn’t affect the color scheme (needs contrast > 0)	`boolean`	\| `true` \| `false`
grid	Dots grid type	`enum`	\| `"square"` \| `"hex"`
size	Grid size relative to the image box	`number`	0 to 1
radius	Maximum dot size (relative to the grid cell)	`number`	0 to 2
contrast	Contrast applied to the sampled image (at 0 the luminance is flat, so all the dots get equal size and the image content is lost; with originalColors on the dots still take their color from the image)	`number`	0 to 1
grainMixer	Strength of grain distortion applied to shape edges	`number`	0 to 1
grainOverlay	Post-processing b/w grain overlay	`number`	0 to 1
grainSize	The scale applied to both grain distortion and grain overlay (needs grainMixer or grainOverlay > 0)	`number`	0 to 1

Common Props

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

A halftone-dot image filter featuring customizable grids, color palettes, and dot styles