| <!doctype html> |
| <html class="default no-js"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <title>FFILibrary | tvmjs</title> |
| <meta name="description" content="Documentation for tvmjs"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <link rel="stylesheet" href="../assets/css/main.css"> |
| </head> |
| <body> |
| <header> |
| <div class="tsd-page-toolbar"> |
| <div class="container"> |
| <div class="table-wrap"> |
| <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> |
| <div class="field"> |
| <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> |
| <input id="tsd-search-field" type="text" /> |
| </div> |
| <ul class="results"> |
| <li class="state loading">Preparing search index...</li> |
| <li class="state failure">The search index is not available</li> |
| </ul> |
| <a href="../index.html" class="title">tvmjs</a> |
| </div> |
| <div class="table-cell" id="tsd-widgets"> |
| <div id="tsd-filter"> |
| <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> |
| <div class="tsd-filter-group"> |
| <div class="tsd-select" id="tsd-filter-visibility"> |
| <span class="tsd-select-label">All</span> |
| <ul class="tsd-select-list"> |
| <li data-value="public">Public</li> |
| <li data-value="protected">Public/Protected</li> |
| <li data-value="private" class="selected">All</li> |
| </ul> |
| </div> |
| <input type="checkbox" id="tsd-filter-inherited" checked /> |
| <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> |
| <input type="checkbox" id="tsd-filter-externals" checked /> |
| <label class="tsd-widget" for="tsd-filter-externals">Externals</label> |
| </div> |
| </div> |
| <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="tsd-page-title"> |
| <div class="container"> |
| <ul class="tsd-breadcrumb"> |
| <li> |
| <a href="../index.html">Globals</a> |
| </li> |
| <li> |
| <a href="ffilibrary.html">FFILibrary</a> |
| </li> |
| </ul> |
| <h1>Class FFILibrary</h1> |
| </div> |
| </div> |
| </header> |
| <div class="container container-main"> |
| <div class="row"> |
| <div class="col-8 col-content"> |
| <section class="tsd-panel tsd-comment"> |
| <div class="tsd-comment tsd-typography"> |
| <dl class="tsd-comment-tags"> |
| <dt>internal</dt> |
| <dd><p>FFI Library wrapper, maintains most runtime states.</p> |
| </dd> |
| </dl> |
| </div> |
| </section> |
| <section class="tsd-panel tsd-hierarchy"> |
| <h3>Hierarchy</h3> |
| <ul class="tsd-hierarchy"> |
| <li> |
| <span class="target">FFILibrary</span> |
| </li> |
| </ul> |
| </section> |
| <section class="tsd-panel"> |
| <h3>Implements</h3> |
| <ul class="tsd-hierarchy"> |
| <li><a href="../interfaces/disposable.html" class="tsd-signature-type">Disposable</a></li> |
| </ul> |
| </section> |
| <section class="tsd-panel-group tsd-index-group"> |
| <h2>Index</h2> |
| <section class="tsd-panel tsd-index-panel"> |
| <div class="tsd-index-content"> |
| <section class="tsd-index-section "> |
| <h3>Constructors</h3> |
| <ul class="tsd-index-list"> |
| <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="ffilibrary.html#constructor" class="tsd-kind-icon">constructor</a></li> |
| </ul> |
| </section> |
| <section class="tsd-index-section "> |
| <h3>Properties</h3> |
| <ul class="tsd-index-list"> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="ffilibrary.html#exports" class="tsd-kind-icon">exports</a></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="ffilibrary.html#memory" class="tsd-kind-icon">memory</a></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="ffilibrary.html#wasm32" class="tsd-kind-icon">wasm32</a></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><a href="ffilibrary.html#webgpucontext" class="tsd-kind-icon">webGPUContext</a></li> |
| </ul> |
| </section> |
| <section class="tsd-index-section "> |
| <h3>Methods</h3> |
| <ul class="tsd-index-list"> |
| <li class="tsd-kind-method tsd-parent-kind-class"><a href="ffilibrary.html#checkcall" class="tsd-kind-icon">check<wbr>Call</a></li> |
| <li class="tsd-kind-method tsd-parent-kind-class"><a href="ffilibrary.html#dispose" class="tsd-kind-icon">dispose</a></li> |
| <li class="tsd-kind-method tsd-parent-kind-class"><a href="ffilibrary.html#getoralloccallstack" class="tsd-kind-icon">get<wbr>OrAlloc<wbr>Call<wbr>Stack</a></li> |
| <li class="tsd-kind-method tsd-parent-kind-class"><a href="ffilibrary.html#recyclecallstack" class="tsd-kind-icon">recycle<wbr>Call<wbr>Stack</a></li> |
| <li class="tsd-kind-method tsd-parent-kind-class"><a href="ffilibrary.html#sizeofptr" class="tsd-kind-icon">sizeof<wbr>Ptr</a></li> |
| </ul> |
| </section> |
| </div> |
| </section> |
| </section> |
| <section class="tsd-panel-group tsd-member-group "> |
| <h2>Constructors</h2> |
| <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> |
| <a name="constructor" class="tsd-anchor"></a> |
| <h3>constructor</h3> |
| <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">new FFILibrary<span class="tsd-signature-symbol">(</span>wasmInstance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Instance</span>, imports<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ffilibrary.html" class="tsd-signature-type">FFILibrary</a></li> |
| </ul> |
| <ul class="tsd-descriptions"> |
| <li class="tsd-description"> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/apache/tvm/blob/d4c055c13/web/src/runtime.ts#L49">runtime.ts:49</a></li> |
| </ul> |
| </aside> |
| <h4 class="tsd-parameters-title">Parameters</h4> |
| <ul class="tsd-parameters"> |
| <li> |
| <h5>wasmInstance: <span class="tsd-signature-type">Instance</span></h5> |
| </li> |
| <li> |
| <h5>imports: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5> |
| </li> |
| </ul> |
| <h4 class="tsd-returns-title">Returns <a href="ffilibrary.html" class="tsd-signature-type">FFILibrary</a></h4> |
| </li> |
| </ul> |
| </section> |
| </section> |
| <section class="tsd-panel-group tsd-member-group "> |
| <h2>Properties</h2> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="exports" class="tsd-anchor"></a> |
| <h3>exports</h3> |
| <div class="tsd-signature tsd-kind-icon">exports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">></span></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/apache/tvm/blob/d4c055c13/web/src/runtime.ts#L46">runtime.ts:46</a></li> |
| </ul> |
| </aside> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="memory" class="tsd-anchor"></a> |
| <h3>memory</h3> |
| <div class="tsd-signature tsd-kind-icon">memory<span class="tsd-signature-symbol">:</span> <a href="memory.html" class="tsd-signature-type">Memory</a></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/apache/tvm/blob/d4c055c13/web/src/runtime.ts#L45">runtime.ts:45</a></li> |
| </ul> |
| </aside> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="wasm32" class="tsd-anchor"></a> |
| <h3>wasm32</h3> |
| <div class="tsd-signature tsd-kind-icon">wasm32<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/apache/tvm/blob/d4c055c13/web/src/runtime.ts#L44">runtime.ts:44</a></li> |
| </ul> |
| </aside> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> |
| <a name="webgpucontext" class="tsd-anchor"></a> |
| <h3><span class="tsd-flag ts-flagOptional">Optional</span> webGPUContext</h3> |
| <div class="tsd-signature tsd-kind-icon">webGPUContext<span class="tsd-signature-symbol">:</span> <a href="webgpucontext.html" class="tsd-signature-type">WebGPUContext</a></div> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/apache/tvm/blob/d4c055c13/web/src/runtime.ts#L47">runtime.ts:47</a></li> |
| </ul> |
| </aside> |
| </section> |
| </section> |
| <section class="tsd-panel-group tsd-member-group "> |
| <h2>Methods</h2> |
| <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> |
| <a name="checkcall" class="tsd-anchor"></a> |
| <h3>check<wbr>Call</h3> |
| <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">check<wbr>Call<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> |
| </ul> |
| <ul class="tsd-descriptions"> |
| <li class="tsd-description"> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/apache/tvm/blob/d4c055c13/web/src/runtime.ts#L76">runtime.ts:76</a></li> |
| </ul> |
| </aside> |
| <h4 class="tsd-parameters-title">Parameters</h4> |
| <ul class="tsd-parameters"> |
| <li> |
| <h5>code: <span class="tsd-signature-type">number</span></h5> |
| </li> |
| </ul> |
| <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| </li> |
| </ul> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> |
| <a name="dispose" class="tsd-anchor"></a> |
| <h3>dispose</h3> |
| <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> |
| </ul> |
| <ul class="tsd-descriptions"> |
| <li class="tsd-description"> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/apache/tvm/blob/d4c055c13/web/src/runtime.ts#L66">runtime.ts:66</a></li> |
| </ul> |
| </aside> |
| <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| </li> |
| </ul> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> |
| <a name="getoralloccallstack" class="tsd-anchor"></a> |
| <h3>get<wbr>OrAlloc<wbr>Call<wbr>Stack</h3> |
| <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">get<wbr>OrAlloc<wbr>Call<wbr>Stack<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="cachedcallstack.html" class="tsd-signature-type">CachedCallStack</a></li> |
| </ul> |
| <ul class="tsd-descriptions"> |
| <li class="tsd-description"> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/apache/tvm/blob/d4c055c13/web/src/runtime.ts#L84">runtime.ts:84</a></li> |
| </ul> |
| </aside> |
| <h4 class="tsd-returns-title">Returns <a href="cachedcallstack.html" class="tsd-signature-type">CachedCallStack</a></h4> |
| </li> |
| </ul> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> |
| <a name="recyclecallstack" class="tsd-anchor"></a> |
| <h3>recycle<wbr>Call<wbr>Stack</h3> |
| <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">recycle<wbr>Call<wbr>Stack<span class="tsd-signature-symbol">(</span>callstack<span class="tsd-signature-symbol">: </span><a href="cachedcallstack.html" class="tsd-signature-type">CachedCallStack</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> |
| </ul> |
| <ul class="tsd-descriptions"> |
| <li class="tsd-description"> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/apache/tvm/blob/d4c055c13/web/src/runtime.ts#L95">runtime.ts:95</a></li> |
| </ul> |
| </aside> |
| <h4 class="tsd-parameters-title">Parameters</h4> |
| <ul class="tsd-parameters"> |
| <li> |
| <h5>callstack: <a href="cachedcallstack.html" class="tsd-signature-type">CachedCallStack</a></h5> |
| </li> |
| </ul> |
| <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| </li> |
| </ul> |
| </section> |
| <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> |
| <a name="sizeofptr" class="tsd-anchor"></a> |
| <h3>sizeof<wbr>Ptr</h3> |
| <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> |
| <li class="tsd-signature tsd-kind-icon">sizeof<wbr>Ptr<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> |
| </ul> |
| <ul class="tsd-descriptions"> |
| <li class="tsd-description"> |
| <aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/apache/tvm/blob/d4c055c13/web/src/runtime.ts#L72">runtime.ts:72</a></li> |
| </ul> |
| </aside> |
| <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> |
| </li> |
| </ul> |
| </section> |
| </section> |
| </div> |
| <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> |
| <nav class="tsd-navigation primary"> |
| <ul> |
| <li class="globals "> |
| <a href="../index.html"><em>Globals</em></a> |
| </li> |
| </ul> |
| </nav> |
| <nav class="tsd-navigation secondary menu-sticky"> |
| <ul class="before-current"> |
| </ul> |
| <ul class="current"> |
| <li class="current tsd-kind-class"> |
| <a href="ffilibrary.html" class="tsd-kind-icon">FFILibrary</a> |
| <ul> |
| <li class=" tsd-kind-constructor tsd-parent-kind-class"> |
| <a href="ffilibrary.html#constructor" class="tsd-kind-icon">constructor</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="ffilibrary.html#exports" class="tsd-kind-icon">exports</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="ffilibrary.html#memory" class="tsd-kind-icon">memory</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="ffilibrary.html#wasm32" class="tsd-kind-icon">wasm32</a> |
| </li> |
| <li class=" tsd-kind-property tsd-parent-kind-class"> |
| <a href="ffilibrary.html#webgpucontext" class="tsd-kind-icon">webGPUContext</a> |
| </li> |
| <li class=" tsd-kind-method tsd-parent-kind-class"> |
| <a href="ffilibrary.html#checkcall" class="tsd-kind-icon">check<wbr>Call</a> |
| </li> |
| <li class=" tsd-kind-method tsd-parent-kind-class"> |
| <a href="ffilibrary.html#dispose" class="tsd-kind-icon">dispose</a> |
| </li> |
| <li class=" tsd-kind-method tsd-parent-kind-class"> |
| <a href="ffilibrary.html#getoralloccallstack" class="tsd-kind-icon">get<wbr>OrAlloc<wbr>Call<wbr>Stack</a> |
| </li> |
| <li class=" tsd-kind-method tsd-parent-kind-class"> |
| <a href="ffilibrary.html#recyclecallstack" class="tsd-kind-icon">recycle<wbr>Call<wbr>Stack</a> |
| </li> |
| <li class=" tsd-kind-method tsd-parent-kind-class"> |
| <a href="ffilibrary.html#sizeofptr" class="tsd-kind-icon">sizeof<wbr>Ptr</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <ul class="after-current"> |
| </ul> |
| </nav> |
| </div> |
| </div> |
| </div> |
| <footer class="with-border-bottom"> |
| <div class="container"> |
| <h2>Legend</h2> |
| <div class="tsd-legend-group"> |
| <ul class="tsd-legend"> |
| <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> |
| <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> |
| <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> |
| </ul> |
| <ul class="tsd-legend"> |
| <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> |
| </ul> |
| </div> |
| </div> |
| </footer> |
| <div class="container tsd-generator"> |
| <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> |
| </div> |
| <div class="overlay"></div> |
| <script src="../assets/js/main.js"></script> |
| </body> |
| </html> |
