Finish documentation
This commit is contained in:
schmelczerandras
parent
49473bf905
commit
31fcfd3d6b
86 changed files with 1383 additions and 8485 deletions
|
|
@ -3,8 +3,8 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Flashlight | SDF-2D - v0.3.1</title>
|
||||
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
|
||||
<title>Flashlight | SDF-2D - v0.3.2</title>
|
||||
<meta name="description" content="Documentation for SDF-2D - v0.3.2">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
|
|
@ -22,7 +22,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.1</a>
|
||||
<a href="../index.html" class="title">SDF-2D - v0.3.2</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -62,11 +62,15 @@
|
|||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="lightdrawable.html" class="tsd-signature-type">LightDrawable</a>
|
||||
<span class="tsd-signature-type">LightDrawable</span>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Flashlight</span>
|
||||
|
|
@ -124,9 +128,9 @@
|
|||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Overrides <a href="lightdrawable.html">LightDrawable</a>.<a href="lightdrawable.html#constructor">constructor</a></p>
|
||||
<p>Overrides LightDrawable.__constructor</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L21">drawables/lights/flashlight.ts:21</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L24">drawables/lights/flashlight.ts:24</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -158,7 +162,7 @@
|
|||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#center">center</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L7">drawables/lights/light-drawable.ts:7</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -169,7 +173,7 @@
|
|||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#color">color</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L7">drawables/lights/light-drawable.ts:7</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -179,7 +183,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">direction<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/48490b3/src/drawables/lights/flashlight.ts#L27">drawables/lights/flashlight.ts:27</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L30">drawables/lights/flashlight.ts:30</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -190,7 +194,7 @@
|
|||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#intensity">intensity</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L7">drawables/lights/light-drawable.ts:7</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -201,7 +205,7 @@
|
|||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#lightnessratio">lightnessRatio</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L5">drawables/lights/light-drawable.ts:5</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L6">drawables/lights/light-drawable.ts:6</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -217,9 +221,9 @@
|
|||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Overrides <a href="lightdrawable.html">LightDrawable</a>.<a href="lightdrawable.html#getobjecttoserialize">getObjectToSerialize</a></p>
|
||||
<p>Overrides LightDrawable.getObjectToSerialize</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L32">drawables/lights/flashlight.ts:32</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L35">drawables/lights/flashlight.ts:35</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -247,7 +251,7 @@
|
|||
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.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/48490b3/src/drawables/lights/light-drawable.ts#L15">drawables/lights/light-drawable.ts:15</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L16">drawables/lights/light-drawable.ts:16</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -271,7 +275,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/48490b3/src/drawables/drawable.ts#L11">drawables/drawable.ts:11</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable.ts#L36">drawables/drawable.ts:36</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -301,7 +305,7 @@
|
|||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#setlightnessratio">setLightnessRatio</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L11">drawables/lights/light-drawable.ts:11</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L12">drawables/lights/light-drawable.ts:12</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -324,7 +328,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/48490b3/src/drawables/lights/flashlight.ts#L6">drawables/lights/flashlight.ts:6</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L9">drawables/lights/flashlight.ts:9</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
||||
|
|
@ -333,7 +337,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="flashlight.html" class="tsd-signature-type">Flashlight</a><span class="tsd-signature-symbol"> = new Flashlight(vec2.fromValues(0, 0),vec3.fromValues(0, 0, 0),0,vec2.fromValues(0, 0))</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L15">drawables/lights/flashlight.ts:15</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L18">drawables/lights/flashlight.ts:18</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -343,7 +347,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]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L14">drawables/lights/flashlight.ts:14</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L17">drawables/lights/flashlight.ts:17</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -353,7 +357,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"> = "FLASHLIGHT_COUNT"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L13">drawables/lights/flashlight.ts:13</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L16">drawables/lights/flashlight.ts:16</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -363,7 +367,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/48490b3/src/drawables/lights/flashlight.ts#L7">drawables/lights/flashlight.ts:7</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L10">drawables/lights/flashlight.ts:10</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
||||
|
|
@ -372,7 +376,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"> = "flashlightCenters"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L8">drawables/lights/flashlight.ts:8</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L11">drawables/lights/flashlight.ts:11</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -382,7 +386,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"> = "flashlightColors"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L9">drawables/lights/flashlight.ts:9</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L12">drawables/lights/flashlight.ts:12</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -392,7 +396,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">direction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "flashlightDirections"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L11">drawables/lights/flashlight.ts:11</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L14">drawables/lights/flashlight.ts:14</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -402,7 +406,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"> = "flashlightIntensities"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L10">drawables/lights/flashlight.ts:10</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L13">drawables/lights/flashlight.ts:13</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -420,6 +424,15 @@
|
|||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="circle.html" class="tsd-kind-icon">Circle</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="circlelight.html" class="tsd-kind-icon">Circle<wbr>Light</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="drawable.html" class="tsd-kind-icon">Drawable</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
|
|
@ -462,6 +475,33 @@
|
|||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="invertedtunnel.html" class="tsd-kind-icon">Inverted<wbr>Tunnel</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="tunnel.html" class="tsd-kind-icon">Tunnel</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/renderer.html" class="tsd-kind-icon">Renderer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/runtimesettings.html" class="tsd-kind-icon">Runtime<wbr>Settings</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#compile" class="tsd-kind-icon">compile</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-object-literal">
|
||||
<a href="../globals.html#defaultruntimesettings" class="tsd-kind-icon">default<wbr>Runtime<wbr>Settings</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-object-literal">
|
||||
<a href="../globals.html#defaultstartupsettings" class="tsd-kind-icon">default<wbr>Startup<wbr>Settings</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
|
|
@ -476,22 +516,19 @@
|
|||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue