Image Dithering

Presets

Click to change the sample image

Installation

npm i @paper-design/shaders-react

Code

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

<ImageDithering
  width={1280}
  height={720}
  image="https://paper.design/flowers.webp"
  colorBack="#000c38"
  colorFront="#94ffaf"
  colorHighlight="#eaff94"
  originalColors={false}
  type="8x8"
  size={2}
  colorSteps={2}
  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	The main foreground color	`string`	Hex, RGB, or HSL color
colorHighlight	The secondary foreground color (set it same as colorFront to get a classic 2-color dithering)	`string`	Hex, RGB, or HSL color
originalColors	Use the original colors of the image	`boolean`	\| `true` \| `false`
type	Dithering type	`enum`	\| `"random"` \| `"2x2"` \| `"4x4"` \| `"8x8"`
size	Pixel size of dithering grid	`number`	0.5 to 20
colorSteps	Number of colors to use (applies to both color modes)	`number`	1 to 7 (integer)

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"`
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

A dithering image filter with support for 4 dithering modes and multiple color palettes (2-color, 3-color, and multicolor options, using either predefined colors or ones sampled directly from the original image).