Halftone lines shader

docs/registry/halftone-lines-example.tsx

@@ -0,0 +1,7 @@
+'use client';
+
+import { HalftoneLines, HalftoneLinesProps } from '@paper-design/shaders-react';
+
+export function HalftoneLinesExample(props: HalftoneLinesProps) {
+  return <HalftoneLines style={{ position: 'fixed', width: '100%', height: '100%' }} {...props} />;
+}

docs/src/app/(shaders)/halftone-lines/layout.tsx

@@ -0,0 +1,9 @@
+import { Metadata } from 'next';
+
+export const metadata: Metadata = {
+  title: 'Halftone Lines Filter • Paper',
+};
+
+export default function Layout({ children }: { children: React.ReactNode }) {
+  return <>{children}</>;
+}

docs/src/app/(shaders)/halftone-lines/page.tsx

@@ -0,0 +1,133 @@
+'use client';
+
+import { HalftoneLines, halftoneLinesPresets } from '@paper-design/shaders-react';
+import { useControls, button, folder } from 'leva';
+import { setParamsSafe, useResetLevaParams } from '@/helpers/use-reset-leva-params';
+import { usePresetHighlight } from '@/helpers/use-preset-highlight';
+import { cleanUpLevaParams } from '@/helpers/clean-up-leva-params';
+import { HalftoneLinesGrid, HalftoneLinesGrids, halftoneLinesMeta, ShaderFit } from '@paper-design/shaders';
+import { levaImageButton } from '@/helpers/leva-image-button';
+import { useState, useEffect, useCallback } from 'react';
+import { toHsla } from '@/helpers/color-utils';
+import { ShaderDetails } from '@/components/shader-details';
+import { halftoneLinesDef } from '@/shader-defs/halftone-lines-def';
+import { ShaderContainer } from '@/components/shader-container';
+import { useUrlParams } from '@/helpers/use-url-params';
+
+const { worldWidth, worldHeight, ...defaults } = halftoneLinesPresets[0].params;
+
+const imageFiles = [
+  '001.webp',
+  '002.webp',
+  '003.webp',
+  '004.webp',
+  '005.webp',
+  '006.webp',
+  '007.webp',
+  '008.webp',
+  '009.webp',
+  '0010.webp',
+  '0011.webp',
+  '0012.webp',
+  '0013.webp',
+  '0014.webp',
+  '0015.webp',
+  '0016.webp',
+  '0017.webp',
+  '0018.webp',
+] as const;
+
+const HalftoneLinesWithControls = () => {
+  const [imageIdx, setImageIdx] = useState(-1);
+  const [image, setImage] = useState<HTMLImageElement | string>('/images/image-filters/0018.webp');
+  const [status, setStatus] = useState('Click to load an image');
+
+  useEffect(() => {
+    if (imageIdx >= 0) {
+      const name = imageFiles[imageIdx];
+      setStatus(`Displaying image: ${name}`);
+      const img = new Image();
+      img.src = `/images/image-filters/${name}`;
+      img.onload = () => setImage(img);
+    }
+  }, [imageIdx]);
+
+  const handleClick = useCallback(() => {
+    setImageIdx((prev) => (prev + 1) % imageFiles.length);
+  }, []);
+
+  const setImageWithoutStatus = useCallback((img?: HTMLImageElement) => {
+    setImage(img ?? '');
+    setImageIdx(-1);
+    setStatus(``);
+  }, []);
+
+  const [params, setParams] = useControls(() => {
+    const presets = Object.fromEntries(
+      halftoneLinesPresets.map(({ name, params: { worldWidth, worldHeight, ...preset } }) => [
+        name,
+        button(() => setParamsSafe(params, setParams, preset)),
+      ])
+    );
+    return {
+      colorBack: { value: toHsla(defaults.colorBack), order: 100 },
+      colorFront: { value: toHsla(defaults.colorFront), order: 101 },
+      originalColors: { value: defaults.originalColors, order: 102 },
+
+      contrast: { value: defaults.contrast, min: 0.01, max: 1, order: 200 },
+      inverted: { value: defaults.inverted, order: 201 },
+      smoothness: { value: defaults.smoothness, min: 0, max: halftoneLinesMeta.maxBlurRadius, order: 202 },
+      stripeWidth: { value: defaults.stripeWidth, min: 0, max: 1, order: 203 },
+      thinLines: { value: defaults.thinLines, order: 204 },
+      allowOverflow: { value: defaults.allowOverflow, order: 205 },
+
+      grid: {
+        value: defaults.grid,
+        options: Object.keys(HalftoneLinesGrids) as HalftoneLinesGrid[],
+        order: 250,
+      },
+      size: { value: defaults.size, min: 0, max: 1, order: 251 },
+      gridOffsetX: { value: defaults.gridOffsetX, min: -1, max: 1, order: 252 },
+      gridOffsetY: { value: defaults.gridOffsetY, min: -1, max: 1, order: 253 },
+      gridRotation: { value: defaults.gridRotation, min: 0, max: 360, order: 254 },
+      gridAngleDistortion: { value: defaults.gridAngleDistortion, min: 0, max: 1, order: 255 },
+      gridNoiseDistortion: { value: defaults.gridNoiseDistortion, min: 0, max: 1, order: 256 },
+
+      grainMixer: { value: defaults.grainMixer, min: 0, max: 1, order: 350 },
+      grainMixerSize: { value: defaults.grainMixerSize, min: 0, max: 1, order: 351 },
+      grainOverlay: { value: defaults.grainOverlay, min: 0, max: 1, order: 352 },
+      grainOverlaySize: { value: defaults.grainOverlaySize, min: 0, max: 1, order: 353 },
+
+      scale: { value: defaults.scale, min: 0.1, max: 10, order: 400 },
+      fit: { value: defaults.fit, options: ['contain', 'cover'] as ShaderFit[], order: 450 },
+      Image: folder(
+        {
+          'Upload image': levaImageButton(setImageWithoutStatus),
+        },
+        { order: 0 }
+      ),
+      Presets: folder(presets, { order: -1 }),
+    };
+  });
+
+  // Reset to defaults on mount, so that Leva doesn't show values from other
+  // shaders when navigating (if two shaders have a color1 param for example)
+  useResetLevaParams(params, setParams, defaults);
+  useUrlParams(params, setParams, halftoneLinesDef);
+  usePresetHighlight(halftoneLinesPresets, params);
+  cleanUpLevaParams(params);
+
+  return (
+    <>
+      <ShaderContainer shaderDef={halftoneLinesDef} currentParams={params}>
+        <HalftoneLines onClick={handleClick} {...params} image={image} />
+      </ShaderContainer>
+      <div onClick={handleClick} className="mx-auto mt-16 mb-48 w-fit text-base text-current/70 select-none">
+        Click to change the sample image
+      </div>
+      <ShaderDetails shaderDef={halftoneLinesDef} currentParams={params} />
+    </>
+  );
+};
+
+export default HalftoneLinesWithControls;

docs/src/shader-defs/halftone-lines-def.ts

@@ -0,0 +1,173 @@
+import { halftoneLinesPresets } from '@paper-design/shaders-react';
+import type { ShaderDef } from './shader-def-types';
+import { staticImageCommonParams } from './common-param-def';
+
+const defaultParams = halftoneLinesPresets[0].params;
+
+export const halftoneLinesDef: ShaderDef = {
+  name: 'Halftone lines',
+  description:
+    'Image filter pattern made of a line grid with optional stroke thickness and grid distortion; offering multiple grid types, grid distortions, and color palettes',
+  params: [
+    {
+      name: 'image',
+      type: 'HTMLImageElement | string',
+      description: 'The image to use for the effect',
+    },
+    {
+      name: 'colorBack',
+      type: 'string',
+      defaultValue: defaultParams.colorBack,
+      isColor: true,
+      description: 'Background color',
+    },
+    {
+      name: 'colorFront',
+      type: 'string',
+      defaultValue: defaultParams.colorFront,
+      isColor: true,
+      description: 'Foreground color',
+    },
+    {
+      name: 'originalColors',
+      type: 'boolean',
+      defaultValue: defaultParams.originalColors,
+      description: 'Use the sampled image’s original colors instead of colorFront',
+      options: ['true', 'false'],
+    },
+    {
+      name: 'contrast',
+      type: 'number',
+      min: 0,
+      max: 1,
+      defaultValue: defaultParams.contrast,
+      description: 'Contrast applied to the sampled image',
+    },
+    {
+      name: 'inverted',
+      type: 'boolean',
+      defaultValue: defaultParams.inverted,
+      description: 'Inverts the image luminance',
+      options: ['true', 'false'],
+    },
+    {
+      name: 'smoothness',
+      type: 'number',
+      min: 0,
+      max: 1,
+      defaultValue: defaultParams.smoothness,
+      description: 'The size of blur applied to original image, the more image is blurred the smoother is stroke shape',
+    },
+    {
+      name: 'stripeWidth',
+      type: 'number',
+      min: 0,
+      max: 1,
+      defaultValue: defaultParams.stripeWidth,
+      description: 'The max width of halftone stroke shape, relative to grid size',
+    },
+    {
+      name: 'thinLines',
+      type: 'boolean',
+      defaultValue: defaultParams.thinLines,
+      description: 'Allows thin 1px strokes (set to false for proper antialiasing)',
+      options: ['true', 'false'],
+    },
+    {
+      name: 'allowOverflow',
+      type: 'boolean',
+      defaultValue: defaultParams.allowOverflow,
+      description:
+        'Allows thin stripeWidth to take the whole grid size (set to false to make grid lines always visible)',
+      options: ['true', 'false'],
+    },
+    {
+      name: 'grid',
+      type: 'enum',
+      defaultValue: defaultParams.grid,
+      description: 'Grid type',
+      options: ['lines', 'radial', 'waves', 'noise'],
+    },
+    {
+      name: 'size',
+      type: 'number',
+      min: 0,
+      max: 1,
+      defaultValue: defaultParams.size,
+      description: 'Grid size relative to the image box',
+    },
+    {
+      name: 'gridOffsetX',
+      type: 'number',
+      min: 0,
+      max: 1,
+      defaultValue: defaultParams.gridOffsetX,
+      description: 'The horizontal offset of grid relative to the image box',
+    },
+    {
+      name: 'gridOffsetY',
+      type: 'number',
+      min: 0,
+      max: 1,
+      defaultValue: defaultParams.gridOffsetY,
+      description: 'The vertical offset of grid relative to the image box',
+    },
+    {
+      name: 'gridRotation',
+      type: 'number',
+      min: 0,
+      max: 360,
+      defaultValue: defaultParams.gridRotation,
+      description: 'The grid rotation around image center (not efficient for radial grid + zero grid offsets)',
+    },
+    {
+      name: 'gridAngleDistortion',
+      type: 'number',
+      min: 0,
+      max: 1,
+      defaultValue: defaultParams.gridAngleDistortion,
+      description: 'Changing the grid rotation on the darker image areas',
+    },
+    {
+      name: 'gridNoiseDistortion',
+      type: 'number',
+      min: 0,
+      max: 1,
+      defaultValue: defaultParams.gridNoiseDistortion,
+      description: 'Applying noise to the grid on the darker image areas',
+    },
+    {
+      name: 'grainMixer',
+      type: 'number',
+      min: 0,
+      max: 1,
+      defaultValue: defaultParams.grainMixer,
+      description: 'Strength of grain distortion applied to strokes',
+    },
+    {
+      name: 'grainMixerSize',
+      type: 'number',
+      min: 0,
+      max: 1,
+      defaultValue: defaultParams.grainMixerSize,
+      description: 'The scale applied to the grain distortion',
+    },
+    {
+      name: 'grainOverlay',
+      type: 'number',
+      min: 0,
+      max: 1,
+      defaultValue: defaultParams.grainOverlay,
+      description: 'Post-processing b/w grainy overlay',
+    },
+    {
+      name: 'grainOverlaySize',
+      type: 'number',
+      min: 0,
+      max: 1,
+      defaultValue: defaultParams.grainOverlaySize,
+      description: 'The scale applied to the grain overlay',
+    },
+    ...staticImageCommonParams,
+  ],
+};

packages/shaders-react/src/index.ts

@@ -111,6 +111,10 @@ export { HalftoneDots, halftoneDotsPresets } from './shaders/halftone-dots.js';
 export type { HalftoneDotsProps } from './shaders/halftone-dots.js';
 export type { HalftoneDotsUniforms, HalftoneDotsParams } from '@paper-design/shaders';
 
+export { HalftoneLines, halftoneLinesPresets } from './shaders/halftone-lines.js';
+export type { HalftoneLinesProps } from './shaders/halftone-lines.js';
+export type { HalftoneLinesUniforms, HalftoneLinesParams } from '@paper-design/shaders';
+
 export { isPaperShaderElement, getShaderColorFromString } from '@paper-design/shaders';
 export type { PaperShaderElement, ShaderFit, ShaderSizingParams, ShaderSizingUniforms } from '@paper-design/shaders';