Dithering

Presets

Installation

npm i @paper-design/shaders-react

Code

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

<Dithering
  width={1280}
  height={720}
  colorBack="#000000"
  colorFront="#00b3ff"
  shape="sphere"
  type="4x4"
  size={2}
  speed={1}
  scale={0.6}
/>

Shader Props

Name	Description	Type	Values
colorBack	Background color	`string`	Hex, RGB, or HSL color
colorFront	The foreground (ink) color	`string`	Hex, RGB, or HSL color
shape	Shape pattern type	`enum`	\| `"simplex"` \| `"warp"` \| `"dots"` \| `"wave"` \| `"ripple"` \| `"swirl"` \| `"sphere"`
type	Dithering type	`enum`	\| `"random"` \| `"2x2"` \| `"4x4"` \| `"8x8"`
size	Pixel size of dithering grid	`number`	1 to 20

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

Animated 2-color dithering over with multiple pattern sources (noise, warp, dots, waves, ripple, swirl, sphere). Great for retro, print-like, or stylized UI textures.