Sand Script

'use client';
// Generated by isomer. Do not edit by hand; run `isomer add` again to update. (from packages/react/src/Sandscript.tsx)
// generated by packages/react/scripts/gen-components.mjs, do not edit
import type { CSSProperties } from 'react';
import { useIsomerCanvas, usePrefersReducedMotion, type Mount, type ImageInput, type ImageSource } from './useIsomerCanvas';
import { useLive, usePointer, type LiveSpec } from './live';
// @ts-ignore: the runtime is plain JS with no type declarations
import * as runtime from './sandscript.js';
// @ts-ignore: the baked atlas as a PNG data URL
import atlas from './sandscript.image.js';

const { DEFAULTS, mount, loadImage } = runtime as { DEFAULTS: SandscriptKnobs; mount: Mount; loadImage: (url: string) => Promise<ImageSource> };

export interface SandscriptKnobs {
  sand: string;
  damp: string;
  sunAngle: number;
  ridge: number;
  sheen: number;
  grooveDepth: number;
  grooveWidth: number;
  writeSpeed: number;
  wash: number;
  grainSize: number;
  roughness: number;
  crumble: number;
}

export interface SandscriptProps extends Partial<SandscriptKnobs> {
  className?: string;
  style?: CSSProperties;
  /** Render this one frame (seconds) and run no clock. Used by the parity tests. */
  time?: number;
  paused?: boolean;
  /** The clock stops at t = 8 and holds that frame. Draw t = 5 once when the user prefers reduced motion. Default true. */
  respectReducedMotion?: boolean;
  /** Keep each frame readable after it is shown, for canvas.toDataURL or readPixels. Read at mount. Default false. */
  preserveDrawingBuffer?: boolean;
  /** The image the shader reads. Default: the baked glyph atlas of "Wish you were here". */
  image?: ImageInput;
  /**
   * Live inputs, when there is no `time` and the user does not prefer reduced motion: A press on the canvas
   * restarts the effect. Default true.
   */
  live?: boolean;
}

/** Where each live input comes from: the spec's `live` block. */
const LIVE: LiveSpec<SandscriptKnobs> = {
  inputs: [],
  follow: { stiffness: 1200.0, dampingRatio: 1.0 },
  event: { trigger: 'press' },
  settleAt: 8.0,
};

export const sandscriptDefaults: Readonly<SandscriptKnobs> = DEFAULTS;

export function Sandscript({ className, style, time, paused, respectReducedMotion, preserveDrawingBuffer, image, live, ...props }: SandscriptProps) {
  const knobs = { ...DEFAULTS };
  for (const k of Object.keys(DEFAULTS) as (keyof SandscriptKnobs)[]) {
    const v = props[k];
    if (v !== undefined) (knobs as Record<string, unknown>)[k] = v;
  }
  // A fixed time is test mode, and reduced motion draws the poster: either way the live inputs stay off (no
  // sensors, no pointer, no events) and the knobs render as given.
  const reduced = usePrefersReducedMotion() && respectReducedMotion !== false;
  const inputs = useLive(LIVE, mount, knobs, time === undefined && live !== false && !reduced);
  const ref = useIsomerCanvas({ mount: inputs.mount, knobs, time, paused, respectReducedMotion, preserveDrawingBuffer, posterTime: 5.0, settleAt: inputs.enabled ? undefined : 8.0, image: image ?? atlas, loadImage });
  usePointer(ref, inputs);
  return <canvas ref={ref} className={className} style={{ display: 'block', width: '100%', height: '100%', ...style }} />;
}