# packages/core/src/lib/pibbl.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/pibbl.ts#L22).

[Back to reference](/reference/functions/pibbl/)

<pre class="api-source"><code><span id="L1"><a href="#L1" aria-label="Line 1">1</a> import { GLOBAL_STATE } from './global-state.js';</span>
<span id="L2"><a href="#L2" aria-label="Line 2">2</a> import { mountPibbl } from './mount-pibbl.js';</span>
<span id="L3"><a href="#L3" aria-label="Line 3">3</a> import { assertCompatibleRootNode } from './element/children.js';</span>
<span id="L4"><a href="#L4" aria-label="Line 4">4</a> import { PibblController, type PibblNode } from './types.js';</span>
<span id="L5"><a href="#L5" aria-label="Line 5">5</a> import { update } from './update.js';</span>
<span id="L6"><a href="#L6" aria-label="Line 6">6</a> import type { PibblConfig } from './surface/types.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>  * Mounts or updates a canvas render component on a given HTMLCanvasElement.</span>
<span id="L10"><a href="#L10" aria-label="Line 10">10</a>  * The first mount captures the surface configuration; later calls update only</span>
<span id="L11"><a href="#L11" aria-label="Line 11">11</a>  * the root element until that controller is disposed.</span>
<span id="L12"><a href="#L12" aria-label="Line 12">12</a>  * @param canvas The canvas to render on</span>
<span id="L13"><a href="#L13" aria-label="Line 13">13</a>  * @param element The Pibbl element to render</span>
<span id="L14"><a href="#L14" aria-label="Line 14">14</a>  * @param config The mount lifetime, logical viewport, fit, and pixel density. See</span>
<span id="L15"><a href="#L15" aria-label="Line 15">15</a>  * {@link PibblConfig} .</span>
<span id="L16"><a href="#L16" aria-label="Line 16">16</a>  * @returns The stable {@link PibblController} for this canvas; dispose it to release the mount.</span>
<span id="L17"><a href="#L17" aria-label="Line 17">17</a>  *</span>
<span id="L18"><a href="#L18" aria-label="Line 18">18</a>  * @see {@link PibblNode}</span>
<span id="L19"><a href="#L19" aria-label="Line 19">19</a>  * @see {@link PibblConfig}</span>
<span id="L20"><a href="#L20" aria-label="Line 20">20</a>  * @see {@link PibblController}</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> export function pibbl(</span>
<span id="L23"><a href="#L23" aria-label="Line 23">23</a>   canvas: HTMLCanvasElement,</span>
<span id="L24"><a href="#L24" aria-label="Line 24">24</a>   element: PibblNode,</span>
<span id="L25"><a href="#L25" aria-label="Line 25">25</a>   config?: PibblConfig,</span>
<span id="L26"><a href="#L26" aria-label="Line 26">26</a> ): PibblController {</span>
<span id="L27"><a href="#L27" aria-label="Line 27">27</a>   assertCompatibleRootNode(element);</span>
<span id="L28"><a href="#L28" aria-label="Line 28">28</a>   const mountedInstance = GLOBAL_STATE.pibblInstances.get(canvas);</span>
<span id="L29"><a href="#L29" aria-label="Line 29">29</a>   if (mountedInstance) {</span>
<span id="L30"><a href="#L30" aria-label="Line 30">30</a>     update(canvas, element);</span>
<span id="L31"><a href="#L31" aria-label="Line 31">31</a>     return mountedInstance.controller;</span>
<span id="L32"><a href="#L32" aria-label="Line 32">32</a>   }</span>
<span id="L33"><a href="#L33" aria-label="Line 33">33</a> </span>
<span id="L34"><a href="#L34" aria-label="Line 34">34</a>   const controller = mountPibbl(canvas, element, config);</span>
<span id="L35"><a href="#L35" aria-label="Line 35">35</a>   if (GLOBAL_STATE.pibblInstances.has(canvas)) {</span>
<span id="L36"><a href="#L36" aria-label="Line 36">36</a>     update(canvas, element);</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>   return controller;</span>
<span id="L39"><a href="#L39" aria-label="Line 39">39</a> }</span>
<span id="L40"><a href="#L40" aria-label="Line 40">40</a> </span></code></pre>

## Documentation version

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