matrix-rain-webgpu 1.0.0-beta.0

package/dist/matrix-rain.d.ts

@@ -0,0 +1,7 @@
+import { type MatrixRainProps } from './types';
+/**
+ * WebGPU Matrix-rain background effect. Renders a `<canvas>` that fills its
+ * positioned parent. Returns `null` (and reports via `onError`/`console.warn`)
+ * when WebGPU is unavailable or init fails — it never throws into the host tree.
+ */
+export declare function MatrixRainWebGPU(props: MatrixRainProps): import("react").JSX.Element | null;

package/dist/types.d.ts

@@ -0,0 +1,95 @@
+export interface RainOptions {
+    /**
+     * Glyph cell size in CSS pixels.
+     * @default 20
+     */
+    fontSize?: number;
+    /**
+     * Probability (0..1) that a column does NOT respawn each step — higher = sparser.
+     * @default 0.95
+     */
+    density?: number;
+    /**
+     * Logical simulation rate in Hz (rows advanced per second).
+     * @default 10
+     */
+    stepRate?: number;
+    /**
+     * [min, max] trail length in cells, rolled per column.
+     * @default [8, 35]
+     */
+    tailRange?: [number, number];
+}
+export interface ParallaxOptions {
+    /**
+     * [min, max] per-column fall speed; the spread is what creates the depth illusion.
+     * @default [0.4, 1.5]
+     */
+    speedRange?: [number, number];
+    /**
+     * How strongly far (slow) columns are dimmed, 0 (flat) .. 1 (deep).
+     * @default 0.3
+     */
+    depthDim?: number;
+}
+export interface BloomOptions {
+    /**
+     * Glow strength multiplier applied to the extracted bright pass.
+     * @default 1.5
+     */
+    intensity?: number;
+    /**
+     * Brightness above which a pixel contributes to the glow (~0..2).
+     * @default 0.8
+     */
+    threshold?: number;
+    /**
+     * How hot the heads burn into the HDR target (1 = none). Values >1 push heads
+     * above the displayable range, giving the bloom real headroom to extract from.
+     * @default 1.1
+     */
+    emission?: number;
+}
+export interface CrtOptions {
+    /**
+     * Scanline darkening depth, 0 (none) .. 1 (heavy).
+     * @default 0.3
+     */
+    scanlineStrength?: number;
+    /**
+     * Chromatic-aberration offset in pixels (R/B split along x).
+     * @default 1.0
+     */
+    aberration?: number;
+}
+export interface MatrixRainProps {
+    /** Core rain look & cadence: glyph size, density, step rate, trail length. */
+    rain?: RainOptions;
+    /** Depth illusion via per-column speed spread + far-dimming. `false` disables it. */
+    parallax?: ParallaxOptions | false;
+    /** Bloom glow pass. `false` disables it. */
+    bloom?: BloomOptions | false;
+    /** CRT post-process (scanlines + aberration). `false` disables it. */
+    crt?: CrtOptions | false;
+    /**
+     * Freeze on a settled static frame. The single off-state knob: the consumer
+     * composes reduced-motion / offscreen / user-toggle into this one boolean.
+     * @default false
+     */
+    paused?: boolean;
+    /** Forwarded to the underlying `<canvas>` (which is positioned to fill its parent). */
+    className?: string;
+    /**
+     * Called once if the renderer dies (init failure or a per-frame throw). The
+     * effect then stays dead — no auto-retry. If omitted, the error is
+     * `console.error`'d instead. Never throws into the host React tree.
+     */
+    onError?: (err: Error) => void;
+}
+export type Resolved<T> = Required<T> & {
+    enabled: boolean;
+};
+export type RainConfig = Required<RainOptions>;
+export type BloomConfig = Resolved<BloomOptions>;
+export type CrtConfig = Resolved<CrtOptions>;
+export type ParallaxConfig = Required<ParallaxOptions>;

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "matrix-rain-webgpu",
+  "version": "1.0.0-beta.0",
+  "description": "WebGPU/TypeGPU Matrix-rain background effect for React.",
+  "keywords": [
+    "background-effect",
+    "matrix-rain",
+    "react",
+    "shader",
+    "typegpu",
+    "webgpu"
+  ],
+  "homepage": "https://chicio.github.io/matrix-rain-webgpu/",
+  "bugs": "https://github.com/chicio/matrix-rain-webgpu/issues",
+  "license": "MIT",
+  "author": "Fabrizio Duroni",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/chicio/matrix-rain-webgpu.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "check": "oxlint && oxfmt --check",
+    "fix": "oxlint --fix && oxfmt",
+    "types": "tsc -b",
+    "build": "vite build && tsc -p tsconfig.build.json",
+    "prepublishOnly": "npm run build",
+    "release": "release-it"
+  },
+  "devDependencies": {
+    "@release-it/conventional-changelog": "^11.0.1",
+    "@typegpu/noise": "^0.11.0",
+    "@typegpu/react": "^0.11.0",
+    "@types/node": "^24.12.3",
+    "@types/react": "^19.2.14",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^6.0.1",
+    "@webgpu/types": "^0.1.70",
+    "eslint-plugin-typegpu": "^0.11.1",
+    "oxfmt": "^0.49.0",
+    "oxlint": "^1.64.0",
+    "react": "^19.2.6",
+    "react-dom": "^19.2.6",
+    "release-it": "^20.2.0",
+    "typegpu": "^0.11.6",
+    "typescript": "npm:tsover@6.0.1",
+    "unplugin-typegpu": "^0.11.4",
+    "vite": "^8.0.12"
+  },
+  "peerDependencies": {
+    "@typegpu/noise": "^0.11.0",
+    "@typegpu/react": "^0.11.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "typegpu": "^0.11.0"
+  },
+  "overrides": {
+    "typescript": "npm:tsover@6.0.1"
+  },
+  "pnpm": {
+    "overrides": {
+      "typescript": "npm:tsover@6.0.1"
+    }
+  }
+}