Add documentation
This commit is contained in:
schmelczerandras
parent
7bfad8711b
commit
de5dad1e6e
18 changed files with 1344 additions and 211 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.5</title>
|
||||
<meta name="description" content="Documentation for SDF-2D - v0.3.5">
|
||||
<title>Flashlight | SDF-2D - v0.4.0</title>
|
||||
<meta name="description" content="Documentation for SDF-2D - v0.4.0">
|
||||
<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.3.5</a>
|
||||
<a href="../index.html" class="title">SDF-2D - v0.4.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -98,6 +98,7 @@
|
|||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="flashlight.html#direction" class="tsd-kind-icon">direction</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="flashlight.html#intensity" class="tsd-kind-icon">intensity</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="flashlight.html#lightnessratio" class="tsd-kind-icon">lightness<wbr>Ratio</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="flashlight.html#startcutoff" class="tsd-kind-icon">start<wbr>Cutoff</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
|
|
@ -123,14 +124,14 @@
|
|||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Flashlight<span class="tsd-signature-symbol">(</span>center<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</span>, color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec3</span>, intensity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, direction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="flashlight.html" class="tsd-signature-type">Flashlight</a></li>
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Flashlight<span class="tsd-signature-symbol">(</span>center<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</span>, color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec3</span>, intensity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, direction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</span>, startCutoff<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="flashlight.html" class="tsd-signature-type">Flashlight</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Overrides LightDrawable.__constructor</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/drawables/lights/flashlight.ts#L24">drawables/lights/flashlight.ts:24</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/drawables/lights/flashlight.ts#L25">drawables/lights/flashlight.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -147,6 +148,9 @@
|
|||
<li>
|
||||
<h5>direction: <span class="tsd-signature-type">vec2</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> startCutoff: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="flashlight.html" class="tsd-signature-type">Flashlight</a></h4>
|
||||
</li>
|
||||
|
|
@ -162,7 +166,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/158d2f4/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/7bfad87/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -173,7 +177,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/158d2f4/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/7bfad87/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -183,7 +187,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/158d2f4/src/drawables/lights/flashlight.ts#L30">drawables/lights/flashlight.ts:30</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/drawables/lights/flashlight.ts#L31">drawables/lights/flashlight.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -194,7 +198,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/158d2f4/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/7bfad87/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -205,7 +209,17 @@
|
|||
<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/158d2f4/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/7bfad87/src/drawables/lights/light-drawable.ts#L6">drawables/lights/light-drawable.ts:6</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="startcutoff" class="tsd-anchor"></a>
|
||||
<h3>start<wbr>Cutoff</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">start<wbr>Cutoff<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/7bfad87/src/drawables/lights/flashlight.ts#L32">drawables/lights/flashlight.ts:32</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -223,7 +237,7 @@
|
|||
<aside class="tsd-sources">
|
||||
<p>Overrides LightDrawable.getObjectToSerialize</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/drawables/lights/flashlight.ts#L35">drawables/lights/flashlight.ts:35</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/drawables/lights/flashlight.ts#L37">drawables/lights/flashlight.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -251,7 +265,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/158d2f4/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/7bfad87/src/drawables/lights/light-drawable.ts#L16">drawables/lights/light-drawable.ts:16</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -275,7 +289,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/158d2f4/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/7bfad87/src/drawables/lights/light-drawable.ts#L12">drawables/lights/light-drawable.ts:12</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -298,7 +312,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/158d2f4/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/7bfad87/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">
|
||||
|
|
@ -307,7 +321,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(1, 0))</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/drawables/lights/flashlight.ts#L18">drawables/lights/flashlight.ts:18</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/drawables/lights/flashlight.ts#L19">drawables/lights/flashlight.ts:19</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -317,7 +331,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/158d2f4/src/drawables/lights/flashlight.ts#L17">drawables/lights/flashlight.ts:17</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/drawables/lights/flashlight.ts#L18">drawables/lights/flashlight.ts:18</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -327,7 +341,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/158d2f4/src/drawables/lights/flashlight.ts#L16">drawables/lights/flashlight.ts:16</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/drawables/lights/flashlight.ts#L17">drawables/lights/flashlight.ts:17</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -337,7 +351,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/158d2f4/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/7bfad87/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">
|
||||
|
|
@ -346,7 +360,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/158d2f4/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/7bfad87/src/drawables/lights/flashlight.ts#L11">drawables/lights/flashlight.ts:11</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -356,7 +370,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/158d2f4/src/drawables/lights/flashlight.ts#L12">drawables/lights/flashlight.ts:12</a></li>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/drawables/lights/flashlight.ts#L12">drawables/lights/flashlight.ts:12</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -366,7 +380,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/158d2f4/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/7bfad87/src/drawables/lights/flashlight.ts#L14">drawables/lights/flashlight.ts:14</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -376,7 +390,17 @@
|
|||
<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/158d2f4/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/7bfad87/src/drawables/lights/flashlight.ts#L13">drawables/lights/flashlight.ts:13</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
||||
<a name="descriptor.propertyuniformmapping.startcutoff-1" class="tsd-anchor"></a>
|
||||
<h3>start<wbr>Cutoff</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">start<wbr>Cutoff<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "flashlightStartCutoffs"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/drawables/lights/flashlight.ts#L15">drawables/lights/flashlight.ts:15</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -394,6 +418,12 @@
|
|||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/filteringoptions.html" class="tsd-kind-icon">Filtering<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/wrapoptions.html" class="tsd-kind-icon">Wrap<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="circle.html" class="tsd-kind-icon">Circle</a>
|
||||
</li>
|
||||
|
|
@ -429,6 +459,9 @@
|
|||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
|
||||
<a href="flashlight.html#lightnessratio" class="tsd-kind-icon">lightness<wbr>Ratio</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="flashlight.html#startcutoff" class="tsd-kind-icon">start<wbr>Cutoff</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
|
||||
<a href="flashlight.html#getobjecttoserialize" class="tsd-kind-icon">get<wbr>Object<wbr>ToSerialize</a>
|
||||
</li>
|
||||
|
|
@ -466,9 +499,18 @@
|
|||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/textureoptions.html" class="tsd-kind-icon">Texture<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias">
|
||||
<a href="../globals.html#texturewithoptions" class="tsd-kind-icon">Texture<wbr>With<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#compile" class="tsd-kind-icon">compile</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#rendernoise" class="tsd-kind-icon">render<wbr>Noise</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-object-literal">
|
||||
<a href="../globals.html#defaultruntimesettings" class="tsd-kind-icon">default<wbr>Runtime<wbr>Settings</a>
|
||||
</li>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue