Halftone CMYK

Presets

Installation

npm i @paper-design/shaders-react

Code

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

<HalftoneCMYK>
  <div className="demo">
    <style>{`.demo { display: grid; align-content: center; justify-items: start; gap: 40px; height: 100%; padding: 0 8% }
    .demo p { margin: 0; font: 700 120px/1 system-ui; background: linear-gradient(90deg, #4052d6, #9b5de5); background-clip: text; color: transparent }
    .demo button { padding: 32px 64px; border: 0; border-radius: 99px; font: 48px system-ui; color: #fff; background: linear-gradient(135deg, #4052d6, #9b5de5) }
    .demo button:hover { filter: brightness(1.15) }`}</style>
    <p>Select this text</p>
    <button
      onClick={(event) => {
        const clicks = Number(event.currentTarget.dataset.clicks ?? 0) + 1;
        event.currentTarget.dataset.clicks = String(clicks);
        event.currentTarget.textContent = `Clicked ${clicks} time${clicks === 1 ? '' : 's'}`;
      }}
    >
      Hover and click me
    </button>
  </div>
</HalftoneCMYK>

Shader Props

Name	Description	Type	Values
image	The image to use for the effect	`HTMLImageElement \| string`	Image object or URL
colorBack	Background (paper) color	`string`	Hex, RGB, or HSL color
colorC	Cyan ink color (alpha controls layer transparency, not dot size)	`string`	Hex, RGB, or HSL color
colorM	Magenta ink color (alpha controls layer transparency, not dot size)	`string`	Hex, RGB, or HSL color
colorY	Yellow ink color (alpha controls layer transparency, not dot size)	`string`	Hex, RGB, or HSL color
colorK	Black ink color (alpha controls layer transparency, not dot size)	`string`	Hex, RGB, or HSL color
size	Grid size (relative to image box)	`number`	0 to 1
gridNoise	Displaces both dot positions and color sampling points (positions only with sharp type); naturally makes the background more visible	`number`	0 to 1
type	Dot type style (dots and ink differ most at low softness)	`enum`	\| `"dots"` \| `"ink"` \| `"sharp"`
softness	Dots edge softness	`number`	0 to 1
contrast	Input image contrast	`number`	0 to 2
floodC	Uniform cyan flood applied to all dots (needs colorC alpha > 0)	`number`	0 to 1
floodM	Uniform magenta flood applied to all dots (needs colorM alpha > 0)	`number`	0 to 1
floodY	Uniform yellow flood applied to all dots (needs colorY alpha > 0)	`number`	0 to 1
floodK	Uniform black flood applied to all dots (needs colorK alpha > 0)	`number`	0 to 1
gainC	Proportional cyan gain that enhances existing dots (needs colorC alpha > 0)	`number`	-1 to 1
gainM	Proportional magenta gain that enhances existing dots (needs colorM alpha > 0)	`number`	-1 to 1
gainY	Proportional yellow gain that enhances existing dots (needs colorY alpha > 0)	`number`	-1 to 1
gainK	Proportional black gain that enhances existing dots (needs colorK alpha > 0)	`number`	-1 to 1
grainSize	Size of grain texture, applied to both grain and overlay (relative to image box), needs grainMixer or grainOverlay > 0	`number`	0 to 1
grainMixer	Strength of grain disturbing dots shape	`number`	0 to 1
grainOverlay	Post-processing b/w grain overlay	`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

CMYK halftone printing effect with customizable dot patterns and ink colors for each channel