andras/sdf-2d
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update documentation

Browse source
This commit is contained in:
schmelczerandras 2020-09-29 12:22:47 +02:00
parent 39bd55144f
commit bd1eb1102e
13 changed files with 193 additions and 193 deletions
Download patch file Download diff file Expand all files Collapse all files

46
docs/classes/tunnel.html
View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Tunnel | SDF-2D - v0.3.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.2">
<title>Tunnel | SDF-2D - v0.3.3</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.3">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="icon" href="../favicon.ico" />
@ -23,7 +23,7 @@
<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">SDF-2D - v0.3.2</a>
<a href="../index.html" class="title">SDF-2D - v0.3.3</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -128,7 +128,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L60">drawables/shapes/tunnel.ts:60</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L60">drawables/shapes/tunnel.ts:60</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -159,7 +159,7 @@
<div class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L63">drawables/shapes/tunnel.ts:63</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L63">drawables/shapes/tunnel.ts:63</a></li>
</ul>
</aside>
</section>
@ -169,7 +169,7 @@
<div class="tsd-signature tsd-kind-icon">from<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L65">drawables/shapes/tunnel.ts:65</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L65">drawables/shapes/tunnel.ts:65</a></li>
</ul>
</aside>
</section>
@ -179,7 +179,7 @@
<div class="tsd-signature tsd-kind-icon">to<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L64">drawables/shapes/tunnel.ts:64</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L64">drawables/shapes/tunnel.ts:64</a></li>
</ul>
</aside>
</section>
@ -189,7 +189,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L66">drawables/shapes/tunnel.ts:66</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L66">drawables/shapes/tunnel.ts:66</a></li>
</ul>
</aside>
</section>
@ -207,7 +207,7 @@
<aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#getobjecttoserialize">getObjectToSerialize</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L85">drawables/shapes/tunnel.ts:85</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L85">drawables/shapes/tunnel.ts:85</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -234,7 +234,7 @@
<aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#mindistance">minDistance</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L71">drawables/shapes/tunnel.ts:71</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L71">drawables/shapes/tunnel.ts:71</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -258,7 +258,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="drawable.html">Drawable</a>.<a href="drawable.html#serializetouniforms">serializeToUniforms</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/drawable.ts#L36">drawables/drawable.ts:36</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/drawable.ts#L36">drawables/drawable.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -287,7 +287,7 @@
<aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#descriptor">descriptor</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L11">drawables/shapes/tunnel.ts:11</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L11">drawables/shapes/tunnel.ts:11</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -296,7 +296,7 @@
<div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="tunnel.html" class="tsd-signature-type">Tunnel</a><span class="tsd-signature-symbol"> = new Tunnel(vec2.fromValues(-100000, -100000),vec2.fromValues(-100000, -100000),0,0)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L54">drawables/shapes/tunnel.ts:54</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L54">drawables/shapes/tunnel.ts:54</a></li>
</ul>
</aside>
</section>
@ -306,7 +306,7 @@
<div class="tsd-signature tsd-kind-icon">shader<wbr>Combination<wbr>Steps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [0, 1, 4, 16, 32]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L53">drawables/shapes/tunnel.ts:53</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L53">drawables/shapes/tunnel.ts:53</a></li>
</ul>
</aside>
</section>
@ -316,7 +316,7 @@
<div class="tsd-signature tsd-kind-icon">uniform<wbr>Count<wbr>Macro<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;TUNNEL_COUNT&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L52">drawables/shapes/tunnel.ts:52</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L52">drawables/shapes/tunnel.ts:52</a></li>
</ul>
</aside>
</section>
@ -326,7 +326,7 @@
<div class="tsd-signature tsd-kind-icon">property<wbr>Uniform<wbr>Mapping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L46">drawables/shapes/tunnel.ts:46</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L46">drawables/shapes/tunnel.ts:46</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -335,7 +335,7 @@
<div class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;froms&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L47">drawables/shapes/tunnel.ts:47</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L47">drawables/shapes/tunnel.ts:47</a></li>
</ul>
</aside>
</section>
@ -345,7 +345,7 @@
<div class="tsd-signature tsd-kind-icon">from<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;fromRadii&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L49">drawables/shapes/tunnel.ts:49</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L49">drawables/shapes/tunnel.ts:49</a></li>
</ul>
</aside>
</section>
@ -355,7 +355,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>From<wbr>Delta<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;toFromDeltas&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L48">drawables/shapes/tunnel.ts:48</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L48">drawables/shapes/tunnel.ts:48</a></li>
</ul>
</aside>
</section>
@ -365,7 +365,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;toRadii&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L50">drawables/shapes/tunnel.ts:50</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L50">drawables/shapes/tunnel.ts:50</a></li>
</ul>
</aside>
</section>
@ -376,7 +376,7 @@
<div class="tsd-signature tsd-kind-icon">sdf<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L12">drawables/shapes/tunnel.ts:12</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L12">drawables/shapes/tunnel.ts:12</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -385,7 +385,7 @@
<div class="tsd-signature tsd-kind-icon">distance<wbr>Function<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;tunnelMinDistance&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L44">drawables/shapes/tunnel.ts:44</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L44">drawables/shapes/tunnel.ts:44</a></li>
</ul>
</aside>
</section>
@ -395,7 +395,7 @@
<div class="tsd-signature tsd-kind-icon">shader<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x60;uniform vec2 froms[TUNNEL_COUNT];uniform vec2 toFromDeltas[TUNNEL_COUNT];uniform float fromRadii[TUNNEL_COUNT];uniform float toRadii[TUNNEL_COUNT];float tunnelMinDistance(vec2 target, out float colorIndex) {colorIndex &#x3D; 1.0;float minDistance &#x3D; 1000.0;for (int i &#x3D; 0; i &lt; TUNNEL_COUNT; i++) {vec2 targetFromDelta &#x3D; target - froms[i];float h &#x3D; clamp(dot(targetFromDelta, toFromDeltas[i])/ dot(toFromDeltas[i], toFromDeltas[i]),0.0, 1.0);float currentDistance &#x3D; -mix(fromRadii[i], toRadii[i], h) + distance(targetFromDelta, toFromDeltas[i] * h);minDistance &#x3D; min(minDistance, currentDistance);}return minDistance;}&#x60;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/0fed4f4/src/drawables/shapes/tunnel.ts#L13">drawables/shapes/tunnel.ts:13</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/39bd551/src/drawables/shapes/tunnel.ts#L13">drawables/shapes/tunnel.ts:13</a></li>
</ul>
</aside>
</section>