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

Generate docs

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

233
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.5.3</title>
<meta name="description" content="Documentation for SDF-2D - v0.5.3">
<title>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">
@ -53,7 +53,7 @@
<a href="globals.html">Globals</a>
</li>
</ul>
<h1>SDF-2D - v0.5.3</h1>
<h1>SDF-2D - v0.6.0</h1>
</div>
</div>
</header>
@ -64,6 +64,12 @@
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Namespaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-namespace"><a href="modules/__global.html" class="tsd-kind-icon">__global</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Enumerations</h3>
<ul class="tsd-index-list">
@ -85,7 +91,10 @@
</ul>
<h3>Other Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class"><a href="classes/colorfulcircle.html" class="tsd-kind-icon">Colorful<wbr>Circle</a></li>
<li class="tsd-kind-class"><a href="classes/deltatimecalculator.html" class="tsd-kind-icon">Delta<wbr>Time<wbr>Calculator</a></li>
<li class="tsd-kind-class"><a href="classes/drawable.html" class="tsd-kind-icon">Drawable</a></li>
<li class="tsd-kind-class"><a href="classes/fpsqualityautoscaler.html" class="tsd-kind-icon">Fps<wbr>Quality<wbr>Autoscaler</a></li>
</ul>
</section>
<section class="tsd-index-section ">
@ -94,6 +103,7 @@
<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/rendererinfo.html" class="tsd-kind-icon">Renderer<wbr>Info</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>
@ -129,6 +139,7 @@
<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>
<li class="tsd-kind-function"><a href="globals.html#runanimation" class="tsd-kind-icon">run<wbr>Animation</a></li>
</ul>
</section>
<section class="tsd-index-section ">
@ -149,7 +160,7 @@
<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/fbd85a6/src/graphics/graphics-library/texture/texture-options.ts#L27">graphics/graphics-library/texture/texture-options.ts:27</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/graphics-library/texture/texture-options.ts#L27">graphics/graphics-library/texture/texture-options.ts:27</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@ -177,7 +188,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/helper/colors/hex.ts#L14">helper/colors/hex.ts:14</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/helper/colors/hex.ts#L14">helper/colors/hex.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -208,7 +219,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/helper/colors/hsl.ts#L15">helper/colors/hsl.ts:15</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/helper/colors/hsl.ts#L15">helper/colors/hsl.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -258,7 +269,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/helper/colors/rgb.ts#L12">helper/colors/rgb.ts:12</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/helper/colors/rgb.ts#L12">helper/colors/rgb.ts:12</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -307,7 +318,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/helper/colors/rgb255.ts#L12">helper/colors/rgb255.ts:12</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/helper/colors/rgb255.ts#L12">helper/colors/rgb255.ts:12</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -356,7 +367,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/helper/colors/rgba.ts#L13">helper/colors/rgba.ts:13</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/helper/colors/rgba.ts#L13">helper/colors/rgba.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -413,7 +424,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/helper/colors/rgba255.ts#L13">helper/colors/rgba255.ts:13</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/helper/colors/rgba255.ts#L13">helper/colors/rgba255.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -473,7 +484,7 @@
<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/circle-factory.ts#L18">drawables/shapes/circle-factory.ts:18</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/shapes/circle-factory.ts#L18">drawables/shapes/circle-factory.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -498,7 +509,7 @@
<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/droplet-factory.ts#L25">drawables/shapes/droplet-factory.ts:25</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/shapes/droplet-factory.ts#L25">drawables/shapes/droplet-factory.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -523,7 +534,7 @@
<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/inverted-tunnel-factory.ts#L27">drawables/shapes/inverted-tunnel-factory.ts:27</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/shapes/inverted-tunnel-factory.ts#L27">drawables/shapes/inverted-tunnel-factory.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -551,7 +562,7 @@
<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/meta-circle-factory.ts#L18">drawables/shapes/meta-circle-factory.ts:18</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/shapes/meta-circle-factory.ts#L18">drawables/shapes/meta-circle-factory.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -576,7 +587,7 @@
<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/noisy-polygon-factory.ts#L13">drawables/shapes/noisy-polygon-factory.ts:13</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/shapes/noisy-polygon-factory.ts#L14">drawables/shapes/noisy-polygon-factory.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -604,7 +615,7 @@
<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#L20">drawables/shapes/polygon-factory.ts:20</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/shapes/polygon-factory.ts#L20">drawables/shapes/polygon-factory.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -632,7 +643,7 @@
<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/rotated-rectangle-factory.ts#L18">drawables/shapes/rotated-rectangle-factory.ts:18</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/shapes/rotated-rectangle-factory.ts#L18">drawables/shapes/rotated-rectangle-factory.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -654,13 +665,13 @@
<a name="compile" class="tsd-anchor"></a>
<h3>compile</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">compile<span class="tsd-signature-symbol">(</span>canvas<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLCanvasElement</span>, descriptors<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span>, settingsOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/startupsettings.html" class="tsd-signature-type">StartupSettings</a><span class="tsd-signature-symbol">&gt;</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><a href="interfaces/renderer.html" class="tsd-signature-type">Renderer</a><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">compile<span class="tsd-signature-symbol">(</span>canvas<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLCanvasElement</span>, descriptors<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><a href="interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span>, settingsOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/startupsettings.html" class="tsd-signature-type">StartupSettings</a><span class="tsd-signature-symbol">&gt;</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><a href="interfaces/renderer.html" class="tsd-signature-type">Renderer</a><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/fbd85a6/src/main.ts#L55">main.ts:55</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/compile.ts#L29">compile.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -690,7 +701,7 @@
</div>
</li>
<li>
<h5>descriptors: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span></h5>
<h5>descriptors: <a href="interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The descriptor of every single object (and light) that
ever needs to be drawn by this renderer has to be given before compiling.</p>
@ -717,7 +728,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/renderer/noise-renderer.ts#L20">graphics/rendering/renderer/noise-renderer.ts:20</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/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">
@ -766,6 +777,108 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="runanimation" class="tsd-anchor"></a>
<h3>run<wbr>Animation</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">run<wbr>Animation<span class="tsd-signature-symbol">(</span>canvas<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLCanvasElement</span>, descriptors<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><a href="interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span>, animate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>renderer<span class="tsd-signature-symbol">: </span><a href="interfaces/renderer.html" class="tsd-signature-type">Renderer</a>, currentTimeInMilliseconds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DOMHighResTimeStamp</span>, deltaTimeInMilliseconds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DOMHighResTimeStamp</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span>, startupSettingOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/startupsettings.html" class="tsd-signature-type">StartupSettings</a><span class="tsd-signature-symbol">&gt;</span>, initialRuntimeSettingOverrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/runtimesettings.html" class="tsd-signature-type">RuntimeSettings</a><span class="tsd-signature-symbol">&gt;</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">void</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/06dfd59/src/run-animation.ts#L45">run-animation.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Implements the boilerplate code required to run real-time animations
in the browser. An FPS based autoscaler is also used. This creates an additional <code>fps</code>
key in the renderers <code>insights</code> property.</p>
</div>
<p>Example usage:</p>
<pre><code class="language-html"> <span class="hljs-tag">&lt;<span class="hljs-name">canvas</span> <span class="hljs-attr">id</span>=<span class="hljs-string">&quot;main&quot;</span> <span class="hljs-attr">style</span>=<span class="hljs-string">&quot;width: 300px; height: 150px&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">canvas</span>&gt;</span></code></pre>
<blockquote>
<p>The canvas needs to have a fixed size specified by CSS.</p>
</blockquote>
<pre><code class="language-js"><span class="hljs-keyword">import</span> { CircleFactory, CircleLight, hsl, runAnimation } <span class="hljs-keyword">from</span> <span class="hljs-string">&#x27;sdf-2d&#x27;</span>;
<span class="hljs-keyword">const</span> canvas = <span class="hljs-built_in">document</span>.querySelector(<span class="hljs-string">&#x27;canvas&#x27;</span>);
<span class="hljs-keyword">const</span> Circle = CircleFactory(hsl(<span class="hljs-number">180</span>, <span class="hljs-number">100</span>, <span class="hljs-number">40</span>));
runAnimation(canvas, [Circle.descriptor, CircleLight.descriptor], <span class="hljs-function">(<span class="hljs-params">renderer, time</span>) =&gt;</span> {
renderer.addDrawable(
<span class="hljs-keyword">new</span> Circle([<span class="hljs-number">150</span> + <span class="hljs-number">50</span> * <span class="hljs-built_in">Math</span>.cos(time / <span class="hljs-number">1000</span>), <span class="hljs-number">75</span> + <span class="hljs-number">50</span> * <span class="hljs-built_in">Math</span>.sin(time / <span class="hljs-number">1000</span>)], <span class="hljs-number">25</span>)
);
renderer.addDrawable(<span class="hljs-keyword">new</span> CircleLight([<span class="hljs-number">150</span>, <span class="hljs-number">75</span>], hsl(<span class="hljs-number">270</span>, <span class="hljs-number">100</span>, <span class="hljs-number">40</span>), <span class="hljs-number">0.1</span>));
<span class="hljs-keyword">return</span> <span class="hljs-literal">true</span>;
});</code></pre>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>canvas: <span class="tsd-signature-type">HTMLCanvasElement</span></h5>
<div class="tsd-comment tsd-typography">
<p>The returned renderer will only be able to draw to this canvas.</p>
</div>
</li>
<li>
<h5>descriptors: <a href="interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography">
<p>The descriptor of every single object (and light) that
ever needs to be drawn by this renderer has to be given before compiling.</p>
</div>
</li>
<li>
<h5>animate: <span class="tsd-signature-symbol">(</span>renderer<span class="tsd-signature-symbol">: </span><a href="interfaces/renderer.html" class="tsd-signature-type">Renderer</a>, currentTimeInMilliseconds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DOMHighResTimeStamp</span>, deltaTimeInMilliseconds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DOMHighResTimeStamp</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>This function will be called before rendering each frame.
<code>renderDrawables</code> must not be called by the animate function. It should return <code>true</code>
if the animation should be continued. To break out of the animation loop, a <code>false</code> (falsy)
return value must be given.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>renderer<span class="tsd-signature-symbol">: </span><a href="interfaces/renderer.html" class="tsd-signature-type">Renderer</a>, currentTimeInMilliseconds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DOMHighResTimeStamp</span>, deltaTimeInMilliseconds<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DOMHighResTimeStamp</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>renderer: <a href="interfaces/renderer.html" class="tsd-signature-type">Renderer</a></h5>
</li>
<li>
<h5>currentTimeInMilliseconds: <span class="tsd-signature-type">DOMHighResTimeStamp</span></h5>
</li>
<li>
<h5>deltaTimeInMilliseconds: <span class="tsd-signature-type">DOMHighResTimeStamp</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> startupSettingOverrides: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/startupsettings.html" class="tsd-signature-type">StartupSettings</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography">
<p>Sensible defaults are provided, but these can be overridden.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> initialRuntimeSettingOverrides: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="interfaces/runtimesettings.html" class="tsd-signature-type">RuntimeSettings</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></h5>
<div class="tsd-comment tsd-typography">
<p>Sensible defaults are provided, but these can be overridden.</p>
</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">void</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>
@ -775,7 +888,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/fbd85a6/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/06dfd59/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">
@ -789,7 +902,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/fbd85a6/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/06dfd59/src/graphics/rendering/settings/default-runtime-settings.ts#L15">graphics/rendering/settings/default-runtime-settings.ts:15</a></li>
</ul>
</aside>
</section>
@ -799,7 +912,17 @@
<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/fbd85a6/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/06dfd59/src/graphics/rendering/settings/default-runtime-settings.ts#L14">graphics/rendering/settings/default-runtime-settings.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultruntimesettings.distancerenderscale" class="tsd-anchor"></a>
<h3>distance<wbr>Render<wbr>Scale</h3>
<div class="tsd-signature tsd-kind-icon">distance<wbr>Render<wbr>Scale<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.5</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/default-runtime-settings.ts#L12">graphics/rendering/settings/default-runtime-settings.ts:12</a></li>
</ul>
</aside>
</section>
@ -809,7 +932,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/fbd85a6/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/06dfd59/src/graphics/rendering/settings/default-runtime-settings.ts#L8">graphics/rendering/settings/default-runtime-settings.ts:8</a></li>
</ul>
</aside>
</section>
@ -819,7 +942,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/fbd85a6/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/06dfd59/src/graphics/rendering/settings/default-runtime-settings.ts#L10">graphics/rendering/settings/default-runtime-settings.ts:10</a></li>
</ul>
</aside>
</section>
@ -829,7 +952,17 @@
<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/fbd85a6/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/06dfd59/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.lightsrenderscale" class="tsd-anchor"></a>
<h3>lights<wbr>Render<wbr>Scale</h3>
<div class="tsd-signature tsd-kind-icon">lights<wbr>Render<wbr>Scale<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">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/default-runtime-settings.ts#L13">graphics/rendering/settings/default-runtime-settings.ts:13</a></li>
</ul>
</aside>
</section>
@ -839,7 +972,7 @@
<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/fbd85a6/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/06dfd59/src/graphics/rendering/settings/default-runtime-settings.ts#L16">graphics/rendering/settings/default-runtime-settings.ts:16</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@ -854,7 +987,7 @@
<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/fbd85a6/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/06dfd59/src/graphics/rendering/settings/default-runtime-settings.ts#L9">graphics/rendering/settings/default-runtime-settings.ts:9</a></li>
</ul>
</aside>
</section>
@ -865,7 +998,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/fbd85a6/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/06dfd59/src/graphics/rendering/settings/default-startup-settings.ts#L7">graphics/rendering/settings/default-startup-settings.ts:7</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -879,7 +1012,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/fbd85a6/src/graphics/rendering/settings/default-startup-settings.ts#L11">graphics/rendering/settings/default-startup-settings.ts:11</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/default-startup-settings.ts#L11">graphics/rendering/settings/default-startup-settings.ts:11</a></li>
</ul>
</aside>
</section>
@ -889,7 +1022,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/fbd85a6/src/graphics/rendering/settings/default-startup-settings.ts#L12">graphics/rendering/settings/default-startup-settings.ts:12</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/default-startup-settings.ts#L13">graphics/rendering/settings/default-startup-settings.ts:13</a></li>
</ul>
</aside>
</section>
@ -899,7 +1032,17 @@
<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/fbd85a6/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/06dfd59/src/graphics/rendering/settings/default-startup-settings.ts#L10">graphics/rendering/settings/default-startup-settings.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultstartupsettings.lightpenetrationratio" class="tsd-anchor"></a>
<h3>light<wbr>Penetration<wbr>Ratio</h3>
<div class="tsd-signature tsd-kind-icon">light<wbr>Penetration<wbr>Ratio<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.75</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/default-startup-settings.ts#L12">graphics/rendering/settings/default-startup-settings.ts:12</a></li>
</ul>
</aside>
</section>
@ -909,7 +1052,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/fbd85a6/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/06dfd59/src/graphics/rendering/settings/default-startup-settings.ts#L9">graphics/rendering/settings/default-startup-settings.ts:9</a></li>
</ul>
</aside>
</section>
@ -919,7 +1062,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/fbd85a6/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/06dfd59/src/graphics/rendering/settings/default-startup-settings.ts#L8">graphics/rendering/settings/default-startup-settings.ts:8</a></li>
</ul>
</aside>
</section>
@ -932,6 +1075,9 @@
<li class="globals current ">
<a href="globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-namespace">
<a href="modules/__global.html">__global</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
@ -948,6 +1094,12 @@
<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/colorfulcircle.html" class="tsd-kind-icon">Colorful<wbr>Circle</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/deltatimecalculator.html" class="tsd-kind-icon">Delta<wbr>Time<wbr>Calculator</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/drawable.html" class="tsd-kind-icon">Drawable</a>
</li>
@ -957,6 +1109,9 @@
<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/fpsqualityautoscaler.html" class="tsd-kind-icon">Fps<wbr>Quality<wbr>Autoscaler</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/invertedtunnelbase.html" class="tsd-kind-icon">Inverted<wbr>Tunnel<wbr>Base</a>
</li>
@ -978,6 +1133,9 @@
<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/rendererinfo.html" class="tsd-kind-icon">Renderer<wbr>Info</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/runtimesettings.html" class="tsd-kind-icon">Runtime<wbr>Settings</a>
</li>
@ -1035,6 +1193,9 @@
<li class=" tsd-kind-function">
<a href="globals.html#rgba255" class="tsd-kind-icon">rgba255</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#runanimation" class="tsd-kind-icon">run<wbr>Animation</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="globals.html#defaultruntimesettings" class="tsd-kind-icon">default<wbr>Runtime<wbr>Settings</a>
</li>