# packages/core/src/lib/transitions/hologram.ts
This is the source snapshot used to build these API details. [View this revision on GitHub](https://github.com/benlesh/pibbl/blob/272a94aaf62e0bd6ad8726a4c607a76a9ec44ca1/packages/core/src/lib/transitions/hologram.ts#L52).

[Back to reference](/reference/hooks/use-visibility-transition/)

<pre class="api-source"><code><span id="L1"><a href="#L1" aria-label="Line 1">1</a> import { lazyTransitionKernel } from './wasm/kernel.js';</span>
<span id="L2"><a href="#L2" aria-label="Line 2">2</a> import { bytes } from './wasm/hologram-bytes.js';</span>
<span id="L3"><a href="#L3" aria-label="Line 3">3</a> const createKernel = lazyTransitionKernel(bytes);</span>
<span id="L4"><a href="#L4" aria-label="Line 4">4</a> import { opacity } from '../../filters/native.js';</span>
<span id="L5"><a href="#L5" aria-label="Line 5">5</a> import { defineTransitionEffect, type PibblTransitionEffect } from './fade.js';</span>
<span id="L6"><a href="#L6" aria-label="Line 6">6</a> import { captureTransition, clamp, finite, regionSnapshot, type TransitionRegion } from './capture.js';</span>
<span id="L7"><a href="#L7" aria-label="Line 7">7</a> </span>
<span id="L8"><a href="#L8" aria-label="Line 8">8</a> /**</span>
<span id="L9"><a href="#L9" aria-label="Line 9">9</a>  * Color, scanning, and distortion controls for a hologram visibility transition.</span>
<span id="L10"><a href="#L10" aria-label="Line 10">10</a>  *</span>
<span id="L11"><a href="#L11" aria-label="Line 11">11</a>  * @see {@link hologram}</span>
<span id="L12"><a href="#L12" aria-label="Line 12">12</a>  */</span>
<span id="L13"><a href="#L13" aria-label="Line 13">13</a> export interface PibblHologramOptions {</span>
<span id="L14"><a href="#L14" aria-label="Line 14">14</a>   /** Logical region over which the effect is evaluated. See {@link TransitionRegion}. */</span>
<span id="L15"><a href="#L15" aria-label="Line 15">15</a>   readonly region: TransitionRegion;</span>
<span id="L16"><a href="#L16" aria-label="Line 16">16</a>   /** Entry location or direction used by the transition. See {@link PibblHologramOptions}. */</span>
<span id="L17"><a href="#L17" aria-label="Line 17">17</a>   readonly entry?: Readonly&lt;{</span>
<span id="L18"><a href="#L18" aria-label="Line 18">18</a>     /**</span>
<span id="L19"><a href="#L19" aria-label="Line 19">19</a>      * Horizontal coordinate or displacement in the containing coordinate system. See</span>
<span id="L20"><a href="#L20" aria-label="Line 20">20</a>      * {@link PibblHologramOptions}.</span>
<span id="L21"><a href="#L21" aria-label="Line 21">21</a>      */</span>
<span id="L22"><a href="#L22" aria-label="Line 22">22</a>     x: number;</span>
<span id="L23"><a href="#L23" aria-label="Line 23">23</a>     /**</span>
<span id="L24"><a href="#L24" aria-label="Line 24">24</a>      * Vertical coordinate or displacement in the containing coordinate system. See</span>
<span id="L25"><a href="#L25" aria-label="Line 25">25</a>      * {@link PibblHologramOptions}.</span>
<span id="L26"><a href="#L26" aria-label="Line 26">26</a>      */</span>
<span id="L27"><a href="#L27" aria-label="Line 27">27</a>     y: number;</span>
<span id="L28"><a href="#L28" aria-label="Line 28">28</a>   }&gt;;</span>
<span id="L29"><a href="#L29" aria-label="Line 29">29</a>   /** Hue control for the transition's emitted color. See {@link PibblHologramOptions}. */</span>
<span id="L30"><a href="#L30" aria-label="Line 30">30</a>   readonly hue?: number;</span>
<span id="L31"><a href="#L31" aria-label="Line 31">31</a>   /** Brightness control for the transition effect. See {@link PibblHologramOptions}. */</span>
<span id="L32"><a href="#L32" aria-label="Line 32">32</a>   readonly brightness?: number;</span>
<span id="L33"><a href="#L33" aria-label="Line 33">33</a>   /** Fog intensity used by the hologram effect. See {@link PibblHologramOptions}. */</span>
<span id="L34"><a href="#L34" aria-label="Line 34">34</a>   readonly fog?: number;</span>
<span id="L35"><a href="#L35" aria-label="Line 35">35</a>   /** Distortion intensity used by the hologram effect. See {@link PibblHologramOptions}. */</span>
<span id="L36"><a href="#L36" aria-label="Line 36">36</a>   readonly glitch?: number;</span>
<span id="L37"><a href="#L37" aria-label="Line 37">37</a>   /**</span>
<span id="L38"><a href="#L38" aria-label="Line 38">38</a>    * Seed used for deterministic sampling or simulation initialization. See</span>
<span id="L39"><a href="#L39" aria-label="Line 39">39</a>    * {@link PibblHologramOptions}.</span>
<span id="L40"><a href="#L40" aria-label="Line 40">40</a>    */</span>
<span id="L41"><a href="#L41" aria-label="Line 41">41</a>   readonly seed?: number;</span>
<span id="L42"><a href="#L42" aria-label="Line 42">42</a> }</span>
<span id="L43"><a href="#L43" aria-label="Line 43">43</a> /**</span>
<span id="L44"><a href="#L44" aria-label="Line 44">44</a>  * A diffuse scan reconstructs the captured subject while interference settles.</span>
<span id="L45"><a href="#L45" aria-label="Line 45">45</a>  *</span>
<span id="L46"><a href="#L46" aria-label="Line 46">46</a>  * @param options - Hologram appearance and animation settings. See {@link PibblHologramOptions}.</span>
<span id="L47"><a href="#L47" aria-label="Line 47">47</a>  * @returns A hologram transition effect. See {@link PibblTransitionEffect}.</span>
<span id="L48"><a href="#L48" aria-label="Line 48">48</a>  *</span>
<span id="L49"><a href="#L49" aria-label="Line 49">49</a>  * @see {@link PibblHologramOptions}</span>
<span id="L50"><a href="#L50" aria-label="Line 50">50</a>  * @see {@link PibblTransitionEffect}</span>
<span id="L51"><a href="#L51" aria-label="Line 51">51</a>  */</span>
<span id="L52"><a href="#L52" aria-label="Line 52">52</a> export function hologram(options: PibblHologramOptions): PibblTransitionEffect {</span>
<span id="L53"><a href="#L53" aria-label="Line 53">53</a>   const r = regionSnapshot(options.region);</span>
<span id="L54"><a href="#L54" aria-label="Line 54">54</a>   const entry = { x: finite(options.entry?.x ?? r.x + r.width / 2, 'entry.x'), y: finite(options.entry?.y ?? r.y + r.height, 'entry.y') };</span>
<span id="L55"><a href="#L55" aria-label="Line 55">55</a>   const hue = finite(options.hue ?? 183, 'hue'), brightness = finite(options.brightness ?? 1, 'brightness', 0);</span>
<span id="L56"><a href="#L56" aria-label="Line 56">56</a>   const fog = finite(options.fog ?? 1, 'fog', 0), glitch = finite(options.glitch ?? 1, 'glitch', 0);</span>
<span id="L57"><a href="#L57" aria-label="Line 57">57</a>   const kernel = createKernel(finite(options.seed ?? 0, 'seed'));</span>
<span id="L58"><a href="#L58" aria-label="Line 58">58</a>   return defineTransitionEffect(q =&gt; {</span>
<span id="L59"><a href="#L59" aria-label="Line 59">59</a>     if (q === 1) return [];</span>
<span id="L60"><a href="#L60" aria-label="Line 60">60</a>     if (q === 0) return [opacity({ amount: 0 })];</span>
<span id="L61"><a href="#L61" aria-label="Line 61">61</a>     return [captureTransition(({ context: c, windows, drawSource, drawTint }) =&gt; {</span>
<span id="L62"><a href="#L62" aria-label="Line 62">62</a>       const { exports, values } = kernel();</span>
<span id="L63"><a href="#L63" aria-label="Line 63">63</a>       exports.sample!(q, brightness, fog, glitch, r.x, r.y, r.width, r.height, entry.x, entry.y);</span>
<span id="L64"><a href="#L64" aria-label="Line 64">64</a>       const y = values[0]!, power = values[1]!;</span>
<span id="L65"><a href="#L65" aria-label="Line 65">65</a>       const color = (a: number, light = 75) =&gt; `hsla(${hue},100%,${light}%,${clamp(a)})`;</span>
<span id="L66"><a href="#L66" aria-label="Line 66">66</a>       const glow = (x: number, cy: number, rx: number, ry: number, a: number) =&gt; {</span>
<span id="L67"><a href="#L67" aria-label="Line 67">67</a>         c.save(); c.translate(x, cy); c.scale(rx, ry);</span>
<span id="L68"><a href="#L68" aria-label="Line 68">68</a>         const g = c.createRadialGradient(0, 0, 0, 0, 0, 1); g.addColorStop(0, color(a, 92)); g.addColorStop(.3, color(a * .5)); g.addColorStop(1, color(0));</span>
<span id="L69"><a href="#L69" aria-label="Line 69">69</a>         c.fillStyle = g; c.fillRect(-1, -1, 2, 2); c.restore();</span>
<span id="L70"><a href="#L70" aria-label="Line 70">70</a>       };</span>
<span id="L71"><a href="#L71" aria-label="Line 71">71</a>       c.save(); c.beginPath(); c.rect(r.x, y, r.width, r.height * q); c.clip();</span>
<span id="L72"><a href="#L72" aria-label="Line 72">72</a>       drawSource(); c.globalAlpha = clamp((1 - q) * 1.8); drawTint(color(1)); c.globalAlpha = 1;</span>
<span id="L73"><a href="#L73" aria-label="Line 73">73</a>       c.globalCompositeOperation = 'source-atop';</span>
<span id="L74"><a href="#L74" aria-label="Line 74">74</a>       c.fillStyle = color(power * .18);</span>
<span id="L75"><a href="#L75" aria-label="Line 75">75</a>       const lineCount = Math.min(512, Math.ceil(r.height / 5));</span>
<span id="L76"><a href="#L76" aria-label="Line 76">76</a>       for (let i = 0; i &lt; lineCount; i++) c.fillRect(r.x, r.y + i * r.height / lineCount, r.width, 1);</span>
<span id="L77"><a href="#L77" aria-label="Line 77">77</a>       c.restore();</span>
<span id="L78"><a href="#L78" aria-label="Line 78">78</a>       // Transient strips copy only captured pixels, preserving gaps in the subject.</span>
<span id="L79"><a href="#L79" aria-label="Line 79">79</a>       c.save(); c.beginPath(); c.rect(r.x, y, r.width, r.height * q); c.clip();</span>
<span id="L80"><a href="#L80" aria-label="Line 80">80</a>       for (let i = 0; i &lt; 9; i++) {</span>
<span id="L81"><a href="#L81" aria-label="Line 81">81</a>         const offset = 2 + i * 4, pulse = values[offset]!;</span>
<span id="L82"><a href="#L82" aria-label="Line 82">82</a>         if (pulse &lt; .03) continue;</span>
<span id="L83"><a href="#L83" aria-label="Line 83">83</a>         c.save(); c.beginPath(); c.rect(r.x, values[offset + 1]!, r.width, values[offset + 2]!); c.clip();</span>
<span id="L84"><a href="#L84" aria-label="Line 84">84</a>         c.translate(values[offset + 3]!, 0); c.globalAlpha = clamp(pulse); drawTint(color(1, 92)); c.restore();</span>
<span id="L85"><a href="#L85" aria-label="Line 85">85</a>       }</span>
<span id="L86"><a href="#L86" aria-label="Line 86">86</a>       c.restore(); c.globalCompositeOperation = 'lighter';</span>
<span id="L87"><a href="#L87" aria-label="Line 87">87</a>       for (let i = 0; i &lt; 25; i++) {</span>
<span id="L88"><a href="#L88" aria-label="Line 88">88</a>         c.strokeStyle = color(values[38 + i]!); c.lineWidth = 1;</span>
<span id="L89"><a href="#L89" aria-label="Line 89">89</a>         c.beginPath(); c.moveTo(entry.x, entry.y); c.lineTo(r.x + i / 24 * r.width, y); c.stroke();</span>
<span id="L90"><a href="#L90" aria-label="Line 90">90</a>       }</span>
<span id="L91"><a href="#L91" aria-label="Line 91">91</a>       for (let i = 0; i &lt; 24; i++) {</span>
<span id="L92"><a href="#L92" aria-label="Line 92">92</a>         const offset = 63 + i * 5;</span>
<span id="L93"><a href="#L93" aria-label="Line 93">93</a>         glow(values[offset]!, values[offset + 1]!, values[offset + 2]!, values[offset + 3]!, values[offset + 4]!);</span>
<span id="L94"><a href="#L94" aria-label="Line 94">94</a>       }</span>
<span id="L95"><a href="#L95" aria-label="Line 95">95</a>       glow(r.x + r.width / 2, y, r.width * .6, 28, power * .5);</span>
<span id="L96"><a href="#L96" aria-label="Line 96">96</a>       c.save(); c.filter = `blur(${9 * windows.density}px)`; c.strokeStyle = color(power * .65, 87); c.lineWidth = 7;</span>
<span id="L97"><a href="#L97" aria-label="Line 97">97</a>       c.beginPath(); c.ellipse(r.x + r.width / 2, y, r.width * .5, 10, 0, 0, Math.PI * 2); c.stroke();</span>
<span id="L98"><a href="#L98" aria-label="Line 98">98</a>       c.filter = `blur(${3 * windows.density}px)`; c.lineWidth = 3; c.stroke(); c.restore();</span>
<span id="L99"><a href="#L99" aria-label="Line 99">99</a>     })];</span>
<span id="L100"><a href="#L100" aria-label="Line 100">100</a>   });</span>
<span id="L101"><a href="#L101" aria-label="Line 101">101</a> }</span>
<span id="L102"><a href="#L102" aria-label="Line 102">102</a> </span></code></pre>

## Documentation version

Documentation built with @pibbl/core 0.0.2, revision 272a94a. ALPHA — NOT FOR PRODUCTION USE.
