Add documentation

This commit is contained in:
schmelczerandras 2020-10-25 15:56:47 +01:00
parent 3fb6cc0411
commit 8eff33e181
28 changed files with 489 additions and 287 deletions

View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RuntimeSettings | SDF-2D - v0.6.0</title>
<meta name="description" content="Documentation for SDF-2D - v0.6.0">
<title>RuntimeSettings | SDF-2D - v0.6.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.6.1">
<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.0</a>
<a href="../index.html" class="title">SDF-2D - v0.6.1</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -109,7 +109,7 @@
<div class="tsd-signature tsd-kind-icon">ambient<wbr>Light<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec3</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L83">graphics/rendering/settings/runtime-settings.ts:83</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/settings/runtime-settings.ts#L83">graphics/rendering/settings/runtime-settings.ts:83</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -124,7 +124,7 @@
<div class="tsd-signature tsd-kind-icon">color<wbr>Palette<span class="tsd-signature-symbol">:</span> <a href="__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L49">graphics/rendering/settings/runtime-settings.ts:49</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/settings/runtime-settings.ts#L49">graphics/rendering/settings/runtime-settings.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -142,7 +142,7 @@
<div class="tsd-signature tsd-kind-icon">distance<wbr>Render<wbr>Scale<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/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L59">graphics/rendering/settings/runtime-settings.ts:59</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/settings/runtime-settings.ts#L59">graphics/rendering/settings/runtime-settings.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -160,7 +160,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">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L14">graphics/rendering/settings/runtime-settings.ts:14</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/settings/runtime-settings.ts#L14">graphics/rendering/settings/runtime-settings.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -175,7 +175,7 @@
<div class="tsd-signature tsd-kind-icon">is<wbr>World<wbr>Inverted<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/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L33">graphics/rendering/settings/runtime-settings.ts:33</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/settings/runtime-settings.ts#L33">graphics/rendering/settings/runtime-settings.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -192,7 +192,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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L39">graphics/rendering/settings/runtime-settings.ts:39</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/settings/runtime-settings.ts#L39">graphics/rendering/settings/runtime-settings.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -208,7 +208,7 @@
<div class="tsd-signature tsd-kind-icon">lights<wbr>Render<wbr>Scale<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/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L66">graphics/rendering/settings/runtime-settings.ts:66</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/settings/runtime-settings.ts#L66">graphics/rendering/settings/runtime-settings.ts:66</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -224,7 +224,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/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L76">graphics/rendering/settings/runtime-settings.ts:76</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/settings/runtime-settings.ts#L76">graphics/rendering/settings/runtime-settings.ts:76</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -251,7 +251,7 @@
<div class="tsd-signature tsd-kind-icon">tile<wbr>Multiplier<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/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L26">graphics/rendering/settings/runtime-settings.ts:26</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/settings/runtime-settings.ts#L26">graphics/rendering/settings/runtime-settings.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">