Generate docs

This commit is contained in:
schmelczerandras 2020-10-19 12:17:54 +02:00
parent 06dfd593cd
commit c30c66340f
28 changed files with 2288 additions and 2019 deletions

View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PolygonBase | SDF-2D - v0.5.3</title>
<meta name="description" content="Documentation for SDF-2D - v0.5.3">
<title>PolygonBase | 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">
@ -118,19 +118,19 @@
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Polygon<wbr>Base<span class="tsd-signature-symbol">(</span>vertices<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="polygonbase.html" class="tsd-signature-type">PolygonBase</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Polygon<wbr>Base<span class="tsd-signature-symbol">(</span>vertices<span class="tsd-signature-symbol">: </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="polygonbase.html" class="tsd-signature-type">PolygonBase</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/drawables/shapes/polygon-factory.ts#L11">drawables/shapes/polygon-factory.ts:11</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/shapes/polygon-factory.ts#L11">drawables/shapes/polygon-factory.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>vertices: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol">&gt;</span></h5>
<h5>vertices: <a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="polygonbase.html" class="tsd-signature-type">PolygonBase</a></h4>
@ -143,10 +143,10 @@
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="vertices" class="tsd-anchor"></a>
<h3>vertices</h3>
<div class="tsd-signature tsd-kind-icon">vertices<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol">&gt;</span></div>
<div class="tsd-signature tsd-kind-icon">vertices<span class="tsd-signature-symbol">:</span> <a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">vec2</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/fbd85a6/src/drawables/shapes/polygon-factory.ts#L12">drawables/shapes/polygon-factory.ts:12</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/shapes/polygon-factory.ts#L12">drawables/shapes/polygon-factory.ts:12</a></li>
</ul>
</aside>
</section>
@ -158,7 +158,7 @@
<p>Inherited from EmptyDrawable.descriptor</p>
<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/empty-drawable.ts#L9">drawables/empty-drawable.ts:9</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/empty-drawable.ts#L9">drawables/empty-drawable.ts:9</a></li>
</ul>
</aside>
</section>
@ -177,7 +177,7 @@
<p>Inherited from EmptyDrawable.getObjectToSerialize</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/empty-drawable.ts#L15">drawables/empty-drawable.ts:15</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/empty-drawable.ts#L15">drawables/empty-drawable.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -205,7 +205,7 @@
<p>Inherited from EmptyDrawable.minDistance</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/empty-drawable.ts#L11">drawables/empty-drawable.ts:11</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/empty-drawable.ts#L11">drawables/empty-drawable.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -230,33 +230,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>
<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>
<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>
</ul>
<ul class="current">
<li class="current tsd-kind-class">
@ -281,81 +254,6 @@
</li>
</ul>
<ul class="after-current">
<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>