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>CircleLight | SDF-2D - v0.6.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.6.2">
<title>CircleLight | 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">
@ -129,7 +129,7 @@
<aside class="tsd-sources">
<p>Overrides LightDrawable.__constructor</p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/lights/circle-light.ts#L18">drawables/lights/circle-light.ts:18</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/circle-light.ts#L18">drawables/lights/circle-light.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -158,7 +158,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="circlelight.html">CircleLight</a>.<a href="circlelight.html#center">center</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
</ul>
</aside>
</section>
@ -169,7 +169,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="circlelight.html">CircleLight</a>.<a href="circlelight.html#color">color</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
</ul>
</aside>
</section>
@ -180,7 +180,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="circlelight.html">CircleLight</a>.<a href="circlelight.html#intensity">intensity</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
</ul>
</aside>
</section>
@ -191,7 +191,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="circlelight.html">CircleLight</a>.<a href="circlelight.html#lightnessratio">lightnessRatio</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/lights/light-drawable.ts#L6">drawables/lights/light-drawable.ts:6</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/light-drawable.ts#L6">drawables/lights/light-drawable.ts:6</a></li>
</ul>
</aside>
</section>
@ -210,7 +210,7 @@
<p>Inherited from <a href="circlelight.html">CircleLight</a>.<a href="circlelight.html#getobjecttoserialize">getObjectToSerialize</a></p>
<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/lights/light-drawable.ts#L20">drawables/lights/light-drawable.ts:20</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/light-drawable.ts#L20">drawables/lights/light-drawable.ts:20</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -238,7 +238,7 @@
<p>Inherited from <a href="circlelight.html">CircleLight</a>.<a href="circlelight.html#mindistance">minDistance</a></p>
<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/lights/light-drawable.ts#L16">drawables/lights/light-drawable.ts:16</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/light-drawable.ts#L16">drawables/lights/light-drawable.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -262,7 +262,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="circlelight.html">CircleLight</a>.<a href="circlelight.html#setlightnessratio">setLightnessRatio</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/lights/light-drawable.ts#L12">drawables/lights/light-drawable.ts:12</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/light-drawable.ts#L12">drawables/lights/light-drawable.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -285,7 +285,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/lights/circle-light.ts#L9">drawables/lights/circle-light.ts:9</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/circle-light.ts#L9">drawables/lights/circle-light.ts:9</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -294,7 +294,7 @@
<div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="circlelight.html" class="tsd-signature-type">CircleLight</a><span class="tsd-signature-symbol"> = new CircleLight(vec2.create(), vec3.create(), 0)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/lights/circle-light.ts#L17">drawables/lights/circle-light.ts:17</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/circle-light.ts#L17">drawables/lights/circle-light.ts:17</a></li>
</ul>
</aside>
</section>
@ -304,7 +304,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, 4, 8, 16]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/lights/circle-light.ts#L16">drawables/lights/circle-light.ts:16</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/circle-light.ts#L16">drawables/lights/circle-light.ts:16</a></li>
</ul>
</aside>
</section>
@ -314,7 +314,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;CIRCLE_LIGHT_COUNT&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/lights/circle-light.ts#L15">drawables/lights/circle-light.ts:15</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/circle-light.ts#L15">drawables/lights/circle-light.ts:15</a></li>
</ul>
</aside>
</section>
@ -324,7 +324,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/lights/circle-light.ts#L10">drawables/lights/circle-light.ts:10</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/circle-light.ts#L10">drawables/lights/circle-light.ts:10</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -333,7 +333,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;circleLightCenters&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/lights/circle-light.ts#L11">drawables/lights/circle-light.ts:11</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/circle-light.ts#L11">drawables/lights/circle-light.ts:11</a></li>
</ul>
</aside>
</section>
@ -343,7 +343,7 @@
<div class="tsd-signature tsd-kind-icon">color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;circleLightColors&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/lights/circle-light.ts#L12">drawables/lights/circle-light.ts:12</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/circle-light.ts#L12">drawables/lights/circle-light.ts:12</a></li>
</ul>
</aside>
</section>
@ -353,7 +353,7 @@
<div class="tsd-signature tsd-kind-icon">intensity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;circleLightIntensities&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/drawables/lights/circle-light.ts#L13">drawables/lights/circle-light.ts:13</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/drawables/lights/circle-light.ts#L13">drawables/lights/circle-light.ts:13</a></li>
</ul>
</aside>
</section>