andras/sdf-2d
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add documentation

Browse source
This commit is contained in:
schmelczerandras 2020-10-04 10:48:44 +02:00
parent 7bfad8711b
commit de5dad1e6e
18 changed files with 1344 additions and 211 deletions
Download patch file Download diff file Expand all files Collapse all files

170
docs/globals.html
View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SDF-2D - v0.3.5</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.5">
<title>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">
@ -53,7 +53,7 @@
<a href="globals.html">Globals</a>
</li>
</ul>
<h1>SDF-2D - v0.3.5</h1>
<h1>SDF-2D - v0.4.0</h1>
</div>
</div>
</header>
@ -64,6 +64,13 @@
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Enumerations</h3>
<ul class="tsd-index-list">
<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>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Drawable Classes</h3>
<ul class="tsd-index-list">
@ -71,10 +78,14 @@
<li class="tsd-kind-class"><a href="classes/circlelight.html" class="tsd-kind-icon">Circle<wbr>Light</a></li>
<li class="tsd-kind-class"><a href="classes/droplet.html" class="tsd-kind-icon">Droplet</a></li>
<li class="tsd-kind-class"><a href="classes/flashlight.html" class="tsd-kind-icon">Flashlight</a></li>
<li class="tsd-kind-class"><a href="classes/invertedtunnel.html" class="tsd-kind-icon">Inverted<wbr>Tunnel</a></li>
<li class="tsd-kind-class"><a href="classes/metacircle.html" class="tsd-kind-icon">Meta<wbr>Circle</a></li>
<li class="tsd-kind-class"><a href="classes/rotatedrectangle.html" class="tsd-kind-icon">Rotated<wbr>Rectangle</a></li>
</ul>
<h3>Drawable
Providing a noise texture is required for this drawable. Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class"><a href="classes/invertedtunnel.html" class="tsd-kind-icon">Inverted<wbr>Tunnel</a></li>
</ul>
<h3>Other Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class"><a href="classes/drawable.html" class="tsd-kind-icon">Drawable</a></li>
@ -87,12 +98,20 @@
<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>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias"><a href="globals.html#texturewithoptions" class="tsd-kind-icon">Texture<wbr>With<wbr>Options</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<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>
</ul>
</section>
<section class="tsd-index-section ">
@ -105,6 +124,30 @@
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias">
<a name="texturewithoptions" class="tsd-anchor"></a>
<h3>Texture<wbr>With<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">Texture<wbr>With<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>overrides<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/textureoptions.html" class="tsd-signature-type">TextureOptions</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TexImageSource</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/7bfad87/src/graphics/graphics-library/texture/texture-options.ts#L19">graphics/graphics-library/texture/texture-options.ts:19</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>overrides<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/textureoptions.html" class="tsd-signature-type">TextureOptions</a><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li class="tsd-parameter">
<h5>source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TexImageSource</span></h5>
</li>
</ul>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function">
@ -117,7 +160,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/main.ts#L54">main.ts:54</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/main.ts#L54">main.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -163,6 +206,65 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="rendernoise" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> render<wbr>Noise</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">render<wbr>Noise<span class="tsd-signature-symbol">(</span>textureSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</span>, scale<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, amplitude<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, ignoreWebGL2<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLCanvasElement</span><span class="tsd-signature-symbol">&gt;</span></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/7bfad87/src/graphics/rendering/renderer/noise-renderer.ts#L20">graphics/rendering/renderer/noise-renderer.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create a renderer, draw a (1D) noise texture with it,
then destroy the used resources, while returning the generated texture
in the form of a canvas.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>textureSize: <span class="tsd-signature-type">vec2</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The resolution of the end result.</p>
</div>
</div>
</li>
<li>
<h5>scale: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A starting value can be 60</p>
</div>
</div>
</li>
<li>
<h5>amplitude: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A starting value can be 0.125</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> ignoreWebGL2: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Ignore WebGL2, even when its available.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">HTMLCanvasElement</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Object literals</h2>
@ -172,7 +274,7 @@
<div class="tsd-signature tsd-kind-icon">default<wbr>Runtime<wbr>Settings<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/graphics/rendering/settings/default-runtime-settings.ts#L7">graphics/rendering/settings/default-runtime-settings.ts:7</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/default-runtime-settings.ts#L7">graphics/rendering/settings/default-runtime-settings.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -186,7 +288,7 @@
<div class="tsd-signature tsd-kind-icon">ambient<wbr>Light<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> = vec3.fromValues(0.25, 0.15, 0.25)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/default-runtime-settings.ts#L14">graphics/rendering/settings/default-runtime-settings.ts:14</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/default-runtime-settings.ts#L14">graphics/rendering/settings/default-runtime-settings.ts:14</a></li>
</ul>
</aside>
</section>
@ -196,7 +298,7 @@
<div class="tsd-signature tsd-kind-icon">background<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol"> = vec4.fromValues(1, 1, 1, 1)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/default-runtime-settings.ts#L12">graphics/rendering/settings/default-runtime-settings.ts:12</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/default-runtime-settings.ts#L12">graphics/rendering/settings/default-runtime-settings.ts:12</a></li>
</ul>
</aside>
</section>
@ -206,7 +308,7 @@
<div class="tsd-signature tsd-kind-icon">color<wbr>Palette<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span><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/158d2f4/src/graphics/rendering/settings/default-runtime-settings.ts#L13">graphics/rendering/settings/default-runtime-settings.ts:13</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/default-runtime-settings.ts#L13">graphics/rendering/settings/default-runtime-settings.ts:13</a></li>
</ul>
</aside>
</section>
@ -216,7 +318,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">false</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/default-runtime-settings.ts#L8">graphics/rendering/settings/default-runtime-settings.ts:8</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/default-runtime-settings.ts#L8">graphics/rendering/settings/default-runtime-settings.ts:8</a></li>
</ul>
</aside>
</section>
@ -226,7 +328,7 @@
<div class="tsd-signature tsd-kind-icon">is<wbr>World<wbr>Inverted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/default-runtime-settings.ts#L10">graphics/rendering/settings/default-runtime-settings.ts:10</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/default-runtime-settings.ts#L10">graphics/rendering/settings/default-runtime-settings.ts:10</a></li>
</ul>
</aside>
</section>
@ -236,17 +338,32 @@
<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><span class="tsd-signature-symbol"> = 400</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/default-runtime-settings.ts#L11">graphics/rendering/settings/default-runtime-settings.ts:11</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/default-runtime-settings.ts#L11">graphics/rendering/settings/default-runtime-settings.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultruntimesettings.textures" class="tsd-anchor"></a>
<h3>textures</h3>
<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/7bfad87/src/graphics/rendering/settings/default-runtime-settings.ts#L15">graphics/rendering/settings/default-runtime-settings.ts:15</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultruntimesettings.tilemultiplier" class="tsd-anchor"></a>
<h3>tile<wbr>Multiplier</h3>
<div class="tsd-signature tsd-kind-icon">tile<wbr>Multiplier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 8</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/default-runtime-settings.ts#L9">graphics/rendering/settings/default-runtime-settings.ts:9</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/default-runtime-settings.ts#L9">graphics/rendering/settings/default-runtime-settings.ts:9</a></li>
</ul>
</aside>
</section>
@ -257,7 +374,7 @@
<div class="tsd-signature tsd-kind-icon">default<wbr>Startup<wbr>Settings<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/graphics/rendering/settings/default-startup-settings.ts#L6">graphics/rendering/settings/default-startup-settings.ts:6</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/default-startup-settings.ts#L6">graphics/rendering/settings/default-startup-settings.ts:6</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -271,7 +388,7 @@
<div class="tsd-signature tsd-kind-icon">enable<wbr>Stopwatch<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/default-startup-settings.ts#L10">graphics/rendering/settings/default-startup-settings.ts:10</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/default-startup-settings.ts#L10">graphics/rendering/settings/default-startup-settings.ts:10</a></li>
</ul>
</aside>
</section>
@ -281,7 +398,7 @@
<div class="tsd-signature tsd-kind-icon">ignore<wbr>WebGL2<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/default-startup-settings.ts#L9">graphics/rendering/settings/default-startup-settings.ts:9</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/default-startup-settings.ts#L9">graphics/rendering/settings/default-startup-settings.ts:9</a></li>
</ul>
</aside>
</section>
@ -291,7 +408,7 @@
<div class="tsd-signature tsd-kind-icon">palette<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 256</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/default-startup-settings.ts#L8">graphics/rendering/settings/default-startup-settings.ts:8</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/default-startup-settings.ts#L8">graphics/rendering/settings/default-startup-settings.ts:8</a></li>
</ul>
</aside>
</section>
@ -301,7 +418,7 @@
<div class="tsd-signature tsd-kind-icon">shadow<wbr>Trace<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 16</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/default-startup-settings.ts#L7">graphics/rendering/settings/default-startup-settings.ts:7</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/default-startup-settings.ts#L7">graphics/rendering/settings/default-startup-settings.ts:7</a></li>
</ul>
</aside>
</section>
@ -318,6 +435,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="classes/circle.html" class="tsd-kind-icon">Circle</a>
</li>
@ -354,9 +477,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>