Generate docs
This commit is contained in:
parent
06dfd593cd
commit
c30c66340f
28 changed files with 2288 additions and 2019 deletions
|
|
@ -3,8 +3,8 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>CircleLight | SDF-2D - v0.5.3</title>
|
||||
<meta name="description" content="Documentation for SDF-2D - v0.5.3">
|
||||
<title>CircleLight | SDF-2D - v0.6.0</title>
|
||||
<meta name="description" content="Documentation for SDF-2D - v0.6.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.5.3</a>
|
||||
<a href="../index.html" class="title">SDF-2D - v0.6.0</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/fbd85a6/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/06dfd59/src/drawables/lights/circle-light.ts#L18">drawables/lights/circle-light.ts:18</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -156,9 +156,9 @@
|
|||
<h3>center</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">center<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#center">center</a></p>
|
||||
<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/fbd85a6/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/06dfd59/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -167,9 +167,9 @@
|
|||
<h3>color</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec3</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#color">color</a></p>
|
||||
<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/fbd85a6/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/06dfd59/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -178,9 +178,9 @@
|
|||
<h3>intensity</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">intensity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#intensity">intensity</a></p>
|
||||
<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/fbd85a6/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/06dfd59/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -189,9 +189,9 @@
|
|||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> lightness<wbr>Ratio</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">lightness<wbr>Ratio<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#lightnessratio">lightnessRatio</a></p>
|
||||
<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/fbd85a6/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/06dfd59/src/drawables/lights/light-drawable.ts#L6">drawables/lights/light-drawable.ts:6</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -207,10 +207,10 @@
|
|||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from LightDrawable.getObjectToSerialize</p>
|
||||
<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/fbd85a6/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/06dfd59/src/drawables/lights/light-drawable.ts#L20">drawables/lights/light-drawable.ts:20</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -235,10 +235,10 @@
|
|||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#mindistance">minDistance</a></p>
|
||||
<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/fbd85a6/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/06dfd59/src/drawables/lights/light-drawable.ts#L16">drawables/lights/light-drawable.ts:16</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -260,9 +260,9 @@
|
|||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#setlightnessratio">setLightnessRatio</a></p>
|
||||
<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/fbd85a6/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/06dfd59/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/fbd85a6/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/06dfd59/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/fbd85a6/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/06dfd59/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/fbd85a6/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/06dfd59/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"> = "CIRCLE_LIGHT_COUNT"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/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/06dfd59/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/fbd85a6/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/06dfd59/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"> = "circleLightCenters"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/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/06dfd59/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"> = "circleLightColors"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/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/06dfd59/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"> = "circleLightIntensities"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/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/06dfd59/src/drawables/lights/circle-light.ts#L13">drawables/lights/circle-light.ts:13</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -371,15 +371,6 @@
|
|||
</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="circlebase.html" class="tsd-kind-icon">Circle<wbr>Base</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
|
|
@ -416,99 +407,6 @@
|
|||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="drawable.html" class="tsd-kind-icon">Drawable</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="dropletbase.html" class="tsd-kind-icon">Droplet<wbr>Base</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="flashlight.html" class="tsd-kind-icon">Flashlight</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="invertedtunnelbase.html" class="tsd-kind-icon">Inverted<wbr>Tunnel<wbr>Base</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="metacirclebase.html" class="tsd-kind-icon">Meta<wbr>Circle<wbr>Base</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="polygonbase.html" class="tsd-kind-icon">Polygon<wbr>Base</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="rotatedrectanglebase.html" class="tsd-kind-icon">Rotated<wbr>Rectangle<wbr>Base</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/noisypolygonbase.html" class="tsd-kind-icon">Noisy<wbr>Polygon<wbr>Base</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-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#circlefactory" class="tsd-kind-icon">Circle<wbr>Factory</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#dropletfactory" class="tsd-kind-icon">Droplet<wbr>Factory</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#invertedtunnelfactory" class="tsd-kind-icon">Inverted<wbr>Tunnel<wbr>Factory</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#metacirclefactory" class="tsd-kind-icon">Meta<wbr>Circle<wbr>Factory</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#noisypolygonfactory" class="tsd-kind-icon">Noisy<wbr>Polygon<wbr>Factory</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#polygonfactory" class="tsd-kind-icon">Polygon<wbr>Factory</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#rotatedrectanglefactory" class="tsd-kind-icon">Rotated<wbr>Rectangle<wbr>Factory</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#hex" class="tsd-kind-icon">hex</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#hsl" class="tsd-kind-icon">hsl</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-function">
|
||||
<a href="../globals.html#rgb" class="tsd-kind-icon">rgb</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#rgb255" class="tsd-kind-icon">rgb255</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#rgba" class="tsd-kind-icon">rgba</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function">
|
||||
<a href="../globals.html#rgba255" class="tsd-kind-icon">rgba255</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>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue