Generate documentation

This commit is contained in:
schmelczerandras 2020-10-27 11:09:45 +01:00
parent 6a78033764
commit 18f23a8d65
29 changed files with 313 additions and 283 deletions

View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ColorfulCircle | SDF-2D - v0.6.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.6.2">
<title>ColorfulCircle | SDF-2D - v0.6.3</title>
<meta name="description" content="Documentation for SDF-2D - v0.6.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.6.2</a>
<a href="../index.html" class="title">SDF-2D - v0.6.3</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -122,7 +122,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/shapes/colorful-circle.ts#L36">drawables/shapes/colorful-circle.ts:36</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L36">drawables/shapes/colorful-circle.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -150,7 +150,7 @@
<div class="tsd-signature tsd-kind-icon">center<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/8eff33e/src/drawables/shapes/colorful-circle.ts#L38">drawables/shapes/colorful-circle.ts:38</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L38">drawables/shapes/colorful-circle.ts:38</a></li>
</ul>
</aside>
</section>
@ -160,7 +160,7 @@
<div class="tsd-signature tsd-kind-icon">color<wbr>Index<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/8eff33e/src/drawables/shapes/colorful-circle.ts#L38">drawables/shapes/colorful-circle.ts:38</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L38">drawables/shapes/colorful-circle.ts:38</a></li>
</ul>
</aside>
</section>
@ -170,7 +170,7 @@
<div class="tsd-signature tsd-kind-icon">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/8eff33e/src/drawables/shapes/colorful-circle.ts#L38">drawables/shapes/colorful-circle.ts:38</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L38">drawables/shapes/colorful-circle.ts:38</a></li>
</ul>
</aside>
</section>
@ -188,7 +188,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/8eff33e/src/drawables/shapes/colorful-circle.ts#L46">drawables/shapes/colorful-circle.ts:46</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L46">drawables/shapes/colorful-circle.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -215,7 +215,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/8eff33e/src/drawables/shapes/colorful-circle.ts#L42">drawables/shapes/colorful-circle.ts:42</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L42">drawables/shapes/colorful-circle.ts:42</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -238,7 +238,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/8eff33e/src/drawables/shapes/colorful-circle.ts#L6">drawables/shapes/colorful-circle.ts:6</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L6">drawables/shapes/colorful-circle.ts:6</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -247,7 +247,7 @@
<div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="colorfulcircle.html" class="tsd-signature-type">ColorfulCircle</a><span class="tsd-signature-symbol"> = new ColorfulCircle(vec2.create(), 0, 0)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/shapes/colorful-circle.ts#L35">drawables/shapes/colorful-circle.ts:35</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L35">drawables/shapes/colorful-circle.ts:35</a></li>
</ul>
</aside>
</section>
@ -257,7 +257,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, 2, 3, 8, 16]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/shapes/colorful-circle.ts#L34">drawables/shapes/colorful-circle.ts:34</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L34">drawables/shapes/colorful-circle.ts:34</a></li>
</ul>
</aside>
</section>
@ -267,7 +267,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;COLORFUL_CIRCLE_COUNT&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/shapes/colorful-circle.ts#L33">drawables/shapes/colorful-circle.ts:33</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L33">drawables/shapes/colorful-circle.ts:33</a></li>
</ul>
</aside>
</section>
@ -277,7 +277,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/8eff33e/src/drawables/shapes/colorful-circle.ts#L28">drawables/shapes/colorful-circle.ts:28</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L28">drawables/shapes/colorful-circle.ts:28</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -286,7 +286,7 @@
<div class="tsd-signature tsd-kind-icon">center<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;colorfulCircleCenters&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/shapes/colorful-circle.ts#L29">drawables/shapes/colorful-circle.ts:29</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L29">drawables/shapes/colorful-circle.ts:29</a></li>
</ul>
</aside>
</section>
@ -296,7 +296,7 @@
<div class="tsd-signature tsd-kind-icon">color<wbr>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;colorfulCircleColorIndex&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/shapes/colorful-circle.ts#L31">drawables/shapes/colorful-circle.ts:31</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L31">drawables/shapes/colorful-circle.ts:31</a></li>
</ul>
</aside>
</section>
@ -306,7 +306,7 @@
<div class="tsd-signature tsd-kind-icon">radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;colorfulCircleRadii&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/shapes/colorful-circle.ts#L30">drawables/shapes/colorful-circle.ts:30</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L30">drawables/shapes/colorful-circle.ts:30</a></li>
</ul>
</aside>
</section>
@ -317,7 +317,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/8eff33e/src/drawables/shapes/colorful-circle.ts#L7">drawables/shapes/colorful-circle.ts:7</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L7">drawables/shapes/colorful-circle.ts:7</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -326,7 +326,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;circleMinDistance&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/shapes/colorful-circle.ts#L26">drawables/shapes/colorful-circle.ts:26</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L26">drawables/shapes/colorful-circle.ts:26</a></li>
</ul>
</aside>
</section>
@ -336,7 +336,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 colorfulCircleCenters[COLORFUL_CIRCLE_COUNT];uniform float colorfulCircleRadii[COLORFUL_CIRCLE_COUNT];uniform int colorfulCircleColorIndex[COLORFUL_CIRCLE_COUNT];float circleMinDistance(vec2 target, out vec4 color) {float minDistance &#x3D; 1000.0;for (int i &#x3D; 0; i &lt; COLORFUL_CIRCLE_COUNT; i++) {float dist &#x3D; distance(colorfulCircleCenters[i], target) - colorfulCircleRadii[i];if (dist &lt; minDistance) {color &#x3D; readFromPalette(colorfulCircleColorIndex[i]);dist &#x3D; minDistance;}}return minDistance;}&#x60;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/shapes/colorful-circle.ts#L8">drawables/shapes/colorful-circle.ts:8</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/shapes/colorful-circle.ts#L8">drawables/shapes/colorful-circle.ts:8</a></li>
</ul>
</aside>
</section>