Generate docs

This commit is contained in:
schmelczerandras 2020-10-14 15:19:12 +02:00
parent 5e936b9654
commit c110f110d2
20 changed files with 212 additions and 212 deletions

View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SDF-2D - v0.5.0</title>
<meta name="description" content="Documentation for SDF-2D - v0.5.0">
<title>SDF-2D - v0.5.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.5.2">
<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.5.0</a>
<a href="index.html" class="title">SDF-2D - v0.5.2</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -53,7 +53,7 @@
<a href="globals.html">Globals</a>
</li>
</ul>
<h1>SDF-2D - v0.5.0</h1>
<h1>SDF-2D - v0.5.2</h1>
</div>
</div>
</header>
@ -149,7 +149,7 @@
<div class="tsd-signature tsd-kind-icon">Texture<wbr>With<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>overrides<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/textureoptions.html" class="tsd-signature-type">TextureOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TexImageSource</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/graphics/graphics-library/texture/texture-options.ts#L27">graphics/graphics-library/texture/texture-options.ts:27</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/graphics-library/texture/texture-options.ts#L27">graphics/graphics-library/texture/texture-options.ts:27</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@ -177,7 +177,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/helper/colors/hex.ts#L14">helper/colors/hex.ts:14</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/helper/colors/hex.ts#L14">helper/colors/hex.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -208,7 +208,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/helper/colors/hsl.ts#L15">helper/colors/hsl.ts:15</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/helper/colors/hsl.ts#L15">helper/colors/hsl.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -258,7 +258,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/helper/colors/rgb.ts#L12">helper/colors/rgb.ts:12</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/helper/colors/rgb.ts#L12">helper/colors/rgb.ts:12</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -307,7 +307,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/helper/colors/rgb255.ts#L12">helper/colors/rgb255.ts:12</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/helper/colors/rgb255.ts#L12">helper/colors/rgb255.ts:12</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -356,7 +356,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/helper/colors/rgba.ts#L13">helper/colors/rgba.ts:13</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/helper/colors/rgba.ts#L13">helper/colors/rgba.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -413,7 +413,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/helper/colors/rgba255.ts#L13">helper/colors/rgba255.ts:13</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/helper/colors/rgba255.ts#L13">helper/colors/rgba255.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -473,7 +473,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/drawables/shapes/circle-factory.ts#L18">drawables/shapes/circle-factory.ts:18</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/drawables/shapes/circle-factory.ts#L18">drawables/shapes/circle-factory.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -498,7 +498,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/drawables/shapes/droplet-factory.ts#L25">drawables/shapes/droplet-factory.ts:25</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/drawables/shapes/droplet-factory.ts#L25">drawables/shapes/droplet-factory.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -523,7 +523,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/drawables/shapes/inverted-tunnel-factory.ts#L27">drawables/shapes/inverted-tunnel-factory.ts:27</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/drawables/shapes/inverted-tunnel-factory.ts#L27">drawables/shapes/inverted-tunnel-factory.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -551,7 +551,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/drawables/shapes/meta-circle-factory.ts#L18">drawables/shapes/meta-circle-factory.ts:18</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/drawables/shapes/meta-circle-factory.ts#L18">drawables/shapes/meta-circle-factory.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -576,7 +576,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/drawables/shapes/noisy-polygon-factory.ts#L12">drawables/shapes/noisy-polygon-factory.ts:12</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/drawables/shapes/noisy-polygon-factory.ts#L12">drawables/shapes/noisy-polygon-factory.ts:12</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -604,7 +604,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/drawables/shapes/polygon-factory.ts#L19">drawables/shapes/polygon-factory.ts:19</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/drawables/shapes/polygon-factory.ts#L19">drawables/shapes/polygon-factory.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -632,7 +632,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/drawables/shapes/rotated-rectangle-factory.ts#L18">drawables/shapes/rotated-rectangle-factory.ts:18</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/drawables/shapes/rotated-rectangle-factory.ts#L18">drawables/shapes/rotated-rectangle-factory.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -660,7 +660,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/main.ts#L55">main.ts:55</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/main.ts#L55">main.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -717,7 +717,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/graphics/rendering/renderer/noise-renderer.ts#L20">graphics/rendering/renderer/noise-renderer.ts:20</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/renderer/noise-renderer.ts#L20">graphics/rendering/renderer/noise-renderer.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -775,7 +775,7 @@
<div class="tsd-signature tsd-kind-icon">default<wbr>Runtime<wbr>Settings<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/77340a1/src/graphics/rendering/settings/default-runtime-settings.ts#L7">graphics/rendering/settings/default-runtime-settings.ts:7</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/settings/default-runtime-settings.ts#L7">graphics/rendering/settings/default-runtime-settings.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -789,7 +789,7 @@
<div class="tsd-signature tsd-kind-icon">ambient<wbr>Light<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> = vec3.fromValues(0.25, 0.15, 0.25)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/graphics/rendering/settings/default-runtime-settings.ts#L13">graphics/rendering/settings/default-runtime-settings.ts:13</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/settings/default-runtime-settings.ts#L13">graphics/rendering/settings/default-runtime-settings.ts:13</a></li>
</ul>
</aside>
</section>
@ -799,7 +799,7 @@
<div class="tsd-signature tsd-kind-icon">color<wbr>Palette<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/graphics/rendering/settings/default-runtime-settings.ts#L12">graphics/rendering/settings/default-runtime-settings.ts:12</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/settings/default-runtime-settings.ts#L12">graphics/rendering/settings/default-runtime-settings.ts:12</a></li>
</ul>
</aside>
</section>
@ -809,7 +809,7 @@
<div class="tsd-signature tsd-kind-icon">enable<wbr>High<wbr>Dpi<wbr>Rendering<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/graphics/rendering/settings/default-runtime-settings.ts#L8">graphics/rendering/settings/default-runtime-settings.ts:8</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/settings/default-runtime-settings.ts#L8">graphics/rendering/settings/default-runtime-settings.ts:8</a></li>
</ul>
</aside>
</section>
@ -819,7 +819,7 @@
<div class="tsd-signature tsd-kind-icon">is<wbr>World<wbr>Inverted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/graphics/rendering/settings/default-runtime-settings.ts#L10">graphics/rendering/settings/default-runtime-settings.ts:10</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/settings/default-runtime-settings.ts#L10">graphics/rendering/settings/default-runtime-settings.ts:10</a></li>
</ul>
</aside>
</section>
@ -829,7 +829,7 @@
<div class="tsd-signature tsd-kind-icon">light<wbr>Cutoff<wbr>Distance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 400</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/graphics/rendering/settings/default-runtime-settings.ts#L11">graphics/rendering/settings/default-runtime-settings.ts:11</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/settings/default-runtime-settings.ts#L11">graphics/rendering/settings/default-runtime-settings.ts:11</a></li>
</ul>
</aside>
</section>
@ -839,7 +839,7 @@
<div class="tsd-signature tsd-kind-icon">textures<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/graphics/rendering/settings/default-runtime-settings.ts#L14">graphics/rendering/settings/default-runtime-settings.ts:14</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/settings/default-runtime-settings.ts#L14">graphics/rendering/settings/default-runtime-settings.ts:14</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@ -854,7 +854,7 @@
<div class="tsd-signature tsd-kind-icon">tile<wbr>Multiplier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 8</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/graphics/rendering/settings/default-runtime-settings.ts#L9">graphics/rendering/settings/default-runtime-settings.ts:9</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/settings/default-runtime-settings.ts#L9">graphics/rendering/settings/default-runtime-settings.ts:9</a></li>
</ul>
</aside>
</section>
@ -865,7 +865,7 @@
<div class="tsd-signature tsd-kind-icon">default<wbr>Startup<wbr>Settings<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/77340a1/src/graphics/rendering/settings/default-startup-settings.ts#L7">graphics/rendering/settings/default-startup-settings.ts:7</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/settings/default-startup-settings.ts#L7">graphics/rendering/settings/default-startup-settings.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -879,7 +879,7 @@
<div class="tsd-signature tsd-kind-icon">background<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol"> = vec4.fromValues(1, 1, 1, 1)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/graphics/rendering/settings/default-startup-settings.ts#L11">graphics/rendering/settings/default-startup-settings.ts:11</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/settings/default-startup-settings.ts#L11">graphics/rendering/settings/default-startup-settings.ts:11</a></li>
</ul>
</aside>
</section>
@ -889,7 +889,7 @@
<div class="tsd-signature tsd-kind-icon">enable<wbr>Stopwatch<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/graphics/rendering/settings/default-startup-settings.ts#L12">graphics/rendering/settings/default-startup-settings.ts:12</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/settings/default-startup-settings.ts#L12">graphics/rendering/settings/default-startup-settings.ts:12</a></li>
</ul>
</aside>
</section>
@ -899,7 +899,7 @@
<div class="tsd-signature tsd-kind-icon">ignore<wbr>WebGL2<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/graphics/rendering/settings/default-startup-settings.ts#L10">graphics/rendering/settings/default-startup-settings.ts:10</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/settings/default-startup-settings.ts#L10">graphics/rendering/settings/default-startup-settings.ts:10</a></li>
</ul>
</aside>
</section>
@ -909,7 +909,7 @@
<div class="tsd-signature tsd-kind-icon">palette<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 256</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/graphics/rendering/settings/default-startup-settings.ts#L9">graphics/rendering/settings/default-startup-settings.ts:9</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/settings/default-startup-settings.ts#L9">graphics/rendering/settings/default-startup-settings.ts:9</a></li>
</ul>
</aside>
</section>
@ -919,7 +919,7 @@
<div class="tsd-signature tsd-kind-icon">shadow<wbr>Trace<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 16</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/77340a1/src/graphics/rendering/settings/default-startup-settings.ts#L8">graphics/rendering/settings/default-startup-settings.ts:8</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/5e936b9/src/graphics/rendering/settings/default-startup-settings.ts#L8">graphics/rendering/settings/default-startup-settings.ts:8</a></li>
</ul>
</aside>
</section>