Skip to main content

Renderer fidelity · TypeScript · Open source

Know when your renderer drifts.
See exactly where.

Your renderer writes images to a folder. fidelity-kit measures each one against your references, draws the difference, and serves a viewer to browse the results.

Material Fidelity comparison site showing renderer images, visual deltas, and PSNR metrics for two scenes
01Render

Write images into a results folder

02Compare

PSNR and a delta image per renderer

03Review

Side-by-side viewer with live reload

04Publish

Static site or Docker container

Skip the custom tooling

Review differences,
not folders.

Every renderer is compared with a reference, with a PSNR score and a heatmap of where the images differ. Sort scenes by worst score to find regressions first.

  • Declare several references and choose which one to compare against.
  • Missing renders are marked, not fatal, so partial runs still work.
  • Reruns recompute only the comparisons whose images changed.
Set up a suiteExplore a live site →
# While you develop: process, watch and view
npx fidelity-kit dev results

# In CI: process and export a static site
npx fidelity-kit build results --out site/

Beyond still frames

Judge motion
and speed too.

Temporal techniques such as TAA, upscaling and denoisers cannot be judged from one frame. Temporal fidelity scores an animated sequence for ghosting, flicker and slow convergence, and benchmarks track performance next to quality.

Read about temporal fidelity →
{
  "id": "spinning-fan",
  "temporalFidelity": {
    "width": 640,
    "height": 360,
    "frames": 150,
    "warmup": 30,
    "fps": 60
  }
}

Go deeper

Use the part you need.

Start from the folder format, drive it from the CLI, or call the same code from TypeScript.

Folder contract

Suite format

Lay out scenes, outputs and renderers, and describe them in fidelity.json.

results/fidelity.json
Read more →

Command line

CLI reference

process, dev, serve and build, with every option generated from the command definitions.

npx fidelity-kit dev results
Read more →

TypeScript

API reference

Scan suites, compute comparisons and build file paths from your own code.

import { scanSuite } from "fidelity-kit/scan"
Read more →

Sharing

Publish a viewer

Export a self-contained site for any static host, or serve a processed suite from Docker.

fidelity-kit build results --out site/
Read more →

Try it on your renders

From a folder of images to a comparison site.

pnpm add -D fidelity-kit