> ## Documentation Index
> Fetch the complete documentation index at: https://hyperframes.heygen.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Particle Image Reveal

> A seeded deterministic particle field converges and settles while a slotted image reveals beneath it, the trail thinning until the image holds clean.

export const InstallCommand = ({command}) => {
  const [copied, setCopied] = React.useState(false);
  const copy = async () => {
    try {
      if (navigator.clipboard && window.isSecureContext) {
        await navigator.clipboard.writeText(command);
      } else {
        const previous = document.activeElement;
        const scratch = document.createElement("textarea");
        scratch.value = command;
        scratch.setAttribute("readonly", "");
        scratch.style.position = "fixed";
        scratch.style.opacity = "0";
        document.body.appendChild(scratch);
        scratch.select();
        document.execCommand("copy");
        document.body.removeChild(scratch);
        previous?.focus?.();
      }
      setCopied(true);
      setTimeout(() => setCopied(false), 2000);
    } catch {}
  };
  return <div className="hf-install-command not-prose my-4 flex items-stretch overflow-hidden rounded-xl border border-zinc-200 bg-zinc-50 dark:border-zinc-800 dark:bg-zinc-900">
      <code className="flex-1 overflow-x-auto whitespace-nowrap border-r border-zinc-200 px-4 py-3 font-mono text-sm text-zinc-800 dark:border-zinc-800 dark:text-zinc-100">
        {command}
      </code>
      <button type="button" onClick={copy} data-copied={copied ? "true" : "false"} aria-label={`Copy ${command} to the clipboard`} className="hf-install-copy">
        <svg className="hf-install-copy-clipboard" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 18 18" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round" aria-hidden="true">
          <path d="M14.25 5.25H7.25C6.14543 5.25 5.25 6.14543 5.25 7.25V14.25C5.25 15.3546 6.14543 16.25 7.25 16.25H14.25C15.3546 16.25 16.25 15.3546 16.25 14.25V7.25C16.25 6.14543 15.3546 5.25 14.25 5.25Z" />
          <path d="M2.80103 11.998L1.77203 5.07397C1.61003 3.98097 2.36403 2.96397 3.45603 2.80197L10.38 1.77297C11.313 1.63397 12.19 2.16297 12.528 3.00097" />
        </svg>
        <svg className="hf-install-copy-check" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 18 18" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" aria-hidden="true">
          <path d="M2.75 9.5L6.5 13.25L15.25 4.5" />
        </svg>
      </button>
      <span className="hf-install-copy-status" role="status" aria-live="polite">
        {copied ? "Copied" : ""}
      </span>
    </div>;
};

<iframe className="w-full aspect-video rounded-xl border-0 bg-zinc-100 dark:bg-zinc-800" title="particle-image-reveal preview" loading="lazy" srcDoc={`<!doctype html><html><head><meta charset="utf-8"><style>html,body{margin:0;height:100%;overflow:hidden;background:transparent}hyperframes-player{display:block;width:100%;height:100%}</style><script src="https://cdn.jsdelivr.net/npm/@hyperframes/player@0.7/dist/hyperframes-player.global.js"><\/script></head><body><script>fetch("/public/catalog/components/particle-image-reveal.json").then(function(r){return r.json()}).then(function(d){var p=document.createElement("hyperframes-player");p.setAttribute("srcdoc",d.html);p.setAttribute("controls","");p.setAttribute("autoplay","");p.setAttribute("loop","");p.setAttribute("muted","");p.setAttribute("poster","https://static.heygen.ai/hyperframes-oss/docs/images/catalog/components/particle-image-reveal.png");document.body.appendChild(p)});<\/script></body></html>`} />

## Install

<InstallCommand command="npx hyperframes add particle-image-reveal" />

That writes one file: `compositions/components/particle-image-reveal.html`.

## Paste it into your composition

Open `compositions/components/particle-image-reveal.html` and copy what is inside into your own composition.

A component has no size or duration of its own. It takes both from the composition
you paste it into.

## Variables

Every one of these has a default, so the piece works untouched. Set the ones you
want to change on the element:

| Variable    | Default | Accepts                   | What it does                                                                                    |
| ----------- | ------- | ------------------------- | ----------------------------------------------------------------------------------------------- |
| `density`   | `med`   | `low`, `med`, `high`      | Particle count for the converging field.                                                        |
| `direction` | `ltr`   | `ltr`, `center`           | ltr sweeps the reveal left to right; center opens an iris from the middle outward.              |
| `accent`    | `green` | `green`, `blue`, `violet` | Particle and monogram color: green rides --brand, blue rides --accent, violet rides --accent-2. |
| `exit`      | `none`  | `none`, `fade`, `up`      | Optional departure. Default none: the revealed image holds until the frame cuts.                |

Set them with `data-variable-values` on the element that mounts it. These are the
defaults, so this behaves exactly like the preview above until you change one:

```html wrap theme={null}
<div
  data-composition-id="particle-image-reveal"
  data-composition-src="compositions/components/particle-image-reveal.html"
  data-variable-values='{"density":"med","direction":"ltr","accent":"green","exit":"none"}'
></div>
```

## Source

<Accordion title={`particle-image-reveal.html`}>
  ```html theme={null}
  <!doctype html>
  <!--
    particle-image-reveal: HyperFrames video primitive (intros & reveals)

    A seeded deterministic particle field materializes a supplied image: accent
    particles converge and settle across the frame while the image reveals
    beneath them (left-to-right wipe or center iris, matching the particle
    sweep), the trail thinning until the last particle lands and the image
    holds clean.

    The image is a SLOT. Callers supply content by placing an inert template
    anywhere in the HOST page (templates never render, and the runtime wipes
    the host clip's own children on mount, so the slot lives at document
    level):

      <template data-slot="particle-image-reveal-image"> ... </template>

    Slot content may be an <img>, a muted <video>, or arbitrary HTML; direct
    img/video children are stretched to cover the stage. When no slot exists,
    the primitive renders a token monogram: a surface tile with one display
    glyph, drawn entirely from contract tokens.

    Variables (declared in data-composition-variables below):
      - density ("low" | "med" | "high", default "med"): particle count.
      - direction ("ltr" | "center", default "ltr"): ltr sweeps the reveal
        left to right; center opens an iris from the middle outward.
      - accent ("green" | "blue" | "violet", default "green"): green rides
        --brand, blue rides --accent, violet rides --accent-2.
      - exit ("none" | "fade" | "up", default "none"): frame roots own
        transitions; the default holds the final frame to the last pixel.

    Envelope, fixed IN and OUT with elastic HOLD only (never timeScale):
      IN_BASE  = 2.80s  particles converge, image reveals, trail thins to zero
      HOLD     = max(0, D - IN - OUT); truly still: any fractional transform
                 drift would re-raster the slot/canvas layer at seek-history-
                 dependent subpixel offsets and break byte-identical frames
      OUT_BASE = 0.45s  only when exit != none
      If D < IN_BASE + OUT_BASE, IN and OUT compress together.

    Determinism (canvas 2D law): one per-particle attribute table is computed
    exactly once during synchronous timeline construction from fixed LCG seed
    0x50a71c1e. Every painted frame is a pure function of (that table, the
    timeline's current time): the timeline's onUpdate clears the canvas and
    redraws every particle from scratch. No Math.random, no wall clock, no
    incremental state, no requestAnimationFrame. Eventful seeks
    (suppressEvents=false, the engine's render path) repaint identically in
    any order and either direction; by the end of IN every particle's alpha
    is exactly zero, so the HOLD canvas is one clear rect.

    Mount contract: the runtime clones only this template. #root fills the
    host box (no data-width/data-height, container-type: size, cqmin units),
    is styled via #root only, and registers one paused timeline under the
    LITERAL "particle-image-reveal" key. All DOM state is set with explicit
    endpoints (gsap.set + fromTo) so any seek order lands identical frames.
  -->
  <html
    lang="en"
    data-composition-id="particle-image-reveal"
    data-composition-duration="4"
    data-composition-variables='[
      { "id": "density", "type": "enum", "role": "style", "label": "Density", "description": "Particle count for the converging field.", "default": "med", "options": [{ "value": "low", "label": "Low" }, { "value": "med", "label": "Medium" }, { "value": "high", "label": "High" }] },
      { "id": "direction", "type": "enum", "role": "timing", "label": "Direction", "description": "ltr sweeps the reveal left to right; center opens an iris from the middle outward.", "default": "ltr", "options": [{ "value": "ltr", "label": "Left to right" }, { "value": "center", "label": "Center out" }] },
      { "id": "accent", "type": "enum", "role": "style", "label": "Accent", "description": "Particle and monogram color: green rides --brand, blue rides --accent, violet rides --accent-2.", "default": "green", "options": [{ "value": "green", "label": "Green" }, { "value": "blue", "label": "Blue" }, { "value": "violet", "label": "Violet" }] },
      { "id": "exit", "type": "enum", "role": "timing", "label": "Exit", "description": "Optional departure. Default none: the revealed image holds until the frame cuts.", "default": "none", "options": [{ "value": "none", "label": "None" }, { "value": "fade", "label": "Fade" }, { "value": "up", "label": "Up" }] }
    ]'
  >
    <head>
      <meta charset="UTF-8" />
      <title>Particle Image Reveal</title>
    </head>
    <body>
      <template>
        <div id="root" data-composition-id="particle-image-reveal" data-duration="4" data-fps="30">
          <style>
            *,
            *::before,
            *::after {
              box-sizing: border-box;
            }

            #root {
              position: absolute;
              inset: 0;
              overflow: hidden;
              container-type: size;
              isolation: isolate;
              color: var(--fg, #f8fafc);
              font-family: var(--font-display, "Inter", system-ui, sans-serif);
              pointer-events: none;
            }

            .pir-clip {
              position: absolute;
              inset: 0;
              overflow: hidden;
              background: var(--bg, transparent);
            }

            .pir-stage {
              position: absolute;
              inset: 0;
              will-change: transform, opacity;
            }

            .pir-image {
              position: absolute;
              inset: 0;
              display: grid;
              place-items: center;
              overflow: hidden;
              will-change: clip-path, opacity;
            }

            .pir-image > img,
            .pir-image > video {
              position: absolute;
              inset: 0;
              width: 100%;
              height: 100%;
              object-fit: cover;
            }

            .pir-monogram {
              display: grid;
              place-items: center;
              width: 52cqmin;
              height: 52cqmin;
              border: 0.18cqmin solid
                color-mix(in srgb, var(--pir-accent) 52%, var(--border, #475569));
              border-radius: var(--radius, 3cqmin);
              background: color-mix(in srgb, var(--surface, #14171c) 90%, var(--pir-accent));
              box-shadow: 0 3cqh 9cqh color-mix(in srgb, var(--bg, #000000) 40%, transparent);
            }

            .pir-monogram-glyph {
              color: var(--pir-accent);
              font-size: 26cqmin;
              font-weight: 600;
              line-height: 1;
              letter-spacing: 0.02em;
            }

            .pir-canvas {
              position: absolute;
              inset: 0;
              width: 100%;
              height: 100%;
            }
          </style>

          <div
            id="particle-image-reveal-clip"
            class="pir-clip clip"
            data-start="0"
            data-duration="4"
            data-track-index="0"
          >
            <div class="pir-stage">
              <div class="pir-image">
                <div class="pir-monogram">
                  <span class="pir-monogram-glyph" aria-hidden="true">H</span>
                </div>
              </div>
              <canvas class="pir-canvas" aria-hidden="true"></canvas>
            </div>
          </div>

          <script src="https://cdn.jsdelivr.net/npm/gsap@3.14.2/dist/gsap.min.js"></script>
          <script>
            (function () {
              "use strict";

              var root = document.getElementById("root");
              var stage = root.querySelector(".pir-stage");
              var imageLayer = root.querySelector(".pir-image");
              var canvas = root.querySelector(".pir-canvas");
              var vars =
                window.__hyperframes && window.__hyperframes.getVariables
                  ? window.__hyperframes.getVariables()
                  : {};

              var densityCounts = { low: 320, med: 640, high: 1100 };
              var density = Object.prototype.hasOwnProperty.call(densityCounts, vars.density)
                ? vars.density
                : "med";
              var direction = vars.direction === "center" ? "center" : "ltr";
              // Each enum choice routes to a DIFFERENT contract token so the
              // variable stays meaningful under a theme.
              var accentColors = {
                green: "var(--brand, #71f5a7)",
                blue: "var(--accent, #61a8ff)",
                violet: "var(--accent-2, #c5a3ff)",
              };
              var accent = Object.prototype.hasOwnProperty.call(accentColors, vars.accent)
                ? vars.accent
                : "green";
              var exit = vars.exit === "fade" || vars.exit === "up" ? vars.exit : "none";

              root.style.setProperty("--pir-accent", accentColors[accent]);

              // SLOT. Caller templates live at HOST DOCUMENT level (the mount
              // wipes host-clip children, and templates never render). The
              // scoped document proxy filters queries to this composition's
              // subtree, so the lookup deliberately goes through ownerDocument.
              var hostDoc = root.ownerDocument;
              var slotTemplate = null;
              try {
                slotTemplate = hostDoc.querySelector(
                  'template[data-slot="particle-image-reveal-image"]',
                );
              } catch (error) {
                slotTemplate = null;
              }
              if (slotTemplate) {
                imageLayer.querySelector(".pir-monogram").remove();
                imageLayer.appendChild(hostDoc.importNode(slotTemplate.content, true));
              }

              // Envelope: fixed IN/OUT, elastic HOLD, never time-scaled.
              var IN_BASE = 2.8;
              var OUT_BASE = exit === "none" ? 0 : 0.45;
              var duration = Math.max(0.001, parseFloat(root.dataset.duration || "4"));
              var totalBase = Math.max(0.001, IN_BASE + OUT_BASE);
              var scale = duration < totalBase ? duration / totalBase : 1;
              var IN = IN_BASE * scale;
              var OUT = OUT_BASE * scale;
              var HOLD = Math.max(0, duration - (IN + OUT));
              var OUT_START = IN + HOLD;

              // Canvas raster basis is fixed once at mount. Elastic root: the
              // host box decides the resolution; the same host always yields
              // the same raster, so painted frames stay byte-stable.
              var dpr = Math.min(2, Math.max(1, Number(window.devicePixelRatio) || 1));
              var box = root.getBoundingClientRect();
              var cssW = Math.max(1, Math.round(box.width) || 640);
              var cssH = Math.max(1, Math.round(box.height) || 360);
              canvas.width = Math.round(cssW * dpr);
              canvas.height = Math.round(cssH * dpr);
              var ctx = canvas.getContext("2d");
              var minDim = Math.min(canvas.width, canvas.height);

              // Resolve the accent token to a concrete color once at mount so
              // canvas fills never depend on style recalc during seeks.
              var probe = hostDoc.createElement("span");
              probe.style.color = accentColors[accent];
              root.appendChild(probe);
              var particleColor = getComputedStyle(probe).color || "#71f5a7";
              probe.remove();

              // The LCG and every per-particle decision live here. This IIFE
              // runs once before timeline construction, then only the table is
              // read. Particle state at any time is a pure function of
              // (table row, timeline time).
              var COUNT = densityCounts[density];
              var particles = (function () {
                var state = 0x50a71c1e;
                function next() {
                  state = (Math.imul(1664525, state) + 1013904223) >>> 0;
                  return state / 4294967296;
                }
                var rows = [];
                for (var i = 0; i < COUNT; i += 1) {
                  var tx = next();
                  var ty = next();
                  var key =
                    direction === "center"
                      ? Math.min(1, Math.hypot(tx - 0.5, ty - 0.5) / 0.7071)
                      : tx;
                  // Arrival and birth are fractions of IN. Arrivals sweep with
                  // the reveal front; every fade completes by p = 1 exactly.
                  var arrive = 0.24 + 0.66 * key + 0.04 * next();
                  var travel = 0.2 + 0.12 * next();
                  var fade = 0.05 + 0.04 * next();
                  var angle;
                  if (direction === "center") {
                    // Converge inward: start displaced radially outward.
                    angle = Math.atan2(ty - 0.5, tx - 0.5);
                    if (tx === 0.5 && ty === 0.5) angle = next() * Math.PI * 2;
                  } else {
                    // Fly in from the left, within a 90 degree cone.
                    angle = Math.PI + (next() - 0.5) * (Math.PI / 2);
                  }
                  rows.push({
                    tx: tx,
                    ty: ty,
                    arrive: Math.min(0.94, arrive),
                    birth: Math.max(0, arrive - travel),
                    fade: fade,
                    offset: (0.06 + 0.14 * next()) * minDim,
                    ox: Math.cos(angle),
                    oy: Math.sin(angle),
                    radius: (0.28 + 0.62 * next()) * (minDim / 100),
                    dim: 0.55 + 0.45 * next(),
                  });
                }
                return rows;
              })();

              function clamp01(v) {
                return v < 0 ? 0 : v > 1 ? 1 : v;
              }

              // Pure repaint: clear, then draw every particle from (row, p).
              function paint(timeSeconds) {
                ctx.clearRect(0, 0, canvas.width, canvas.height);
                var p = IN > 0 ? clamp01(timeSeconds / IN) : 1;
                // Global end clamp: the whole field is gone exactly at p = 1,
                // and the trail thins as the reveal completes.
                var endClamp = clamp01((1 - p) / 0.05);
                if (endClamp === 0) return;
                var thin = 1 - 0.4 * clamp01((p - 0.72) / 0.28);
                ctx.fillStyle = particleColor;
                for (var i = 0; i < particles.length; i += 1) {
                  var row = particles[i];
                  var u = clamp01((p - row.birth) / (row.arrive - row.birth));
                  if (u <= 0) continue;
                  var settled = clamp01((p - row.arrive) / row.fade);
                  var alpha = clamp01(u / 0.14) * (1 - settled) * endClamp * thin * row.dim * 0.92;
                  if (alpha <= 0.002) continue;
                  var e = 1 - Math.pow(1 - u, 3);
                  var x = row.tx * canvas.width + row.ox * row.offset * (1 - e);
                  var y = row.ty * canvas.height + row.oy * row.offset * (1 - e);
                  var r = row.radius * dpr * (0.6 + 0.4 * (1 - settled));
                  ctx.globalAlpha = alpha;
                  ctx.beginPath();
                  ctx.arc(x, y, r, 0, Math.PI * 2);
                  ctx.fill();
                }
                ctx.globalAlpha = 1;
              }

              // Image reveal geometry follows the particle sweep.
              var clipFrom =
                direction === "center" ? "circle(0% at 50% 50%)" : "inset(0% 100% 0% 0%)";
              var clipTo = direction === "center" ? "circle(75% at 50% 50%)" : "inset(0% 0% 0% 0%)";

              gsap.set(stage, { opacity: 1, y: "0cqh" });
              gsap.set(imageLayer, { opacity: 0, clipPath: clipFrom });

              var tl = gsap.timeline({
                paused: true,
                onUpdate: function () {
                  paint(tl.time());
                },
              });

              // Anchor tween: an inert plain-object tween spanning the full
              // authored duration. Without it the timeline would end at the
              // last DOM tween (2.69s) and seeks into the hold would clamp
              // tl.time() below IN, freezing the particle field short of its
              // authored zero. It also guarantees onUpdate fires (and the
              // canvas repaints) for every eventful seek anywhere in [0, D].
              tl.to({ p: 0 }, { p: 1, duration: duration, ease: "none" }, 0);

              // IN: the image fades up beneath the particles and reveals along
              // the same front the arrivals sweep. Both endpoints authored.
              tl.fromTo(
                imageLayer,
                { opacity: 0 },
                { opacity: 1, duration: IN * 0.42, ease: "power2.out" },
                IN * 0.18,
              );
              tl.fromTo(
                imageLayer,
                { clipPath: clipFrom },
                { clipPath: clipTo, duration: IN * 0.74, ease: "power2.inOut" },
                IN * 0.22,
              );

              // HOLD: truly still, deliberately. Fractional transform drift
              // re-rasters the slot/canvas layer at history-dependent subpixel
              // offsets and breaks byte-identical seeks (the K1 cq-transform
              // trap); the reveal supplies the life, the hold supplies calm.

              // OUT: optional departure; exit none holds until the frame cuts.
              if (exit === "up") {
                tl.to(stage, { y: "-4cqh", duration: OUT, ease: "power2.in" }, OUT_START);
                tl.to(stage, { opacity: 0, duration: OUT, ease: "power2.in" }, OUT_START);
              } else if (exit === "fade") {
                tl.to(stage, { opacity: 0, duration: OUT, ease: "power2.in" }, OUT_START);
              }

              tl.seek(0);
              paint(0);
              window.__timelines = window.__timelines || {};
              window.__timelines["particle-image-reveal"] = tl;
            })();
          </script>
        </div>
      </template>
    </body>
  </html>
  ```
</Accordion>

Tagged `motion-primitive` `intros-reveals` `particles` `reveal` `canvas` `deterministic`.

## Related topics

* [Browse the complete Catalog](/catalog)
* [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
* [Build a richer composition](/go-further)


## Related topics

- [Particle Text Dissolve](/catalog/components/particle-text-dissolve.md)
- [Ink Bleed Reveal](/catalog/components/ink-bleed-reveal.md)
- [Particle Burst](/catalog/components/caption-particle-burst.md)
