andras/sdf-2d
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
sdf-2d/docs/globals.html
András Schmelczer 020446bd66
Merge branch 'main' of https://github.com/schmelczerandras/sdf-2d 
Signed-off-by: András Schmelczer <andras@schmelczer.dev>
2022-01-29 21:14:21 +01:00

1468 lines
No EOL
89 KiB
HTML
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<<<<<<< HEAD
<title>SDF-2D - v0.7.5</title>
<meta name="description" content="Documentation for SDF-2D - v0.7.5">
=======
<title>SDF-2D - v0.7.6</title>
<meta name="description" content="Documentation for SDF-2D - v0.7.6">
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<link rel="icon" href="favicon.ico" />
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<<<<<<< HEAD
<a href="index.html" class="title">SDF-2D - v0.7.5</a>
=======
<a href="index.html" class="title">SDF-2D - v0.7.6</a>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<<<<<<< HEAD
<h1>SDF-2D - v0.7.5</h1>
=======
<h1>SDF-2D - v0.7.6</h1>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<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">
<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">
<li class="tsd-kind-class"><a href="classes/circlebase.html" class="tsd-kind-icon">Circle<wbr>Base</a></li>
<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/dropletbase.html" class="tsd-kind-icon">Droplet<wbr>Base</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/hexagonbase.html" class="tsd-kind-icon">Hexagon<wbr>Base</a></li>
<li class="tsd-kind-class"><a href="classes/invertedtunnelbase.html" class="tsd-kind-icon">Inverted<wbr>Tunnel<wbr>Base</a></li>
<li class="tsd-kind-class"><a href="classes/metacirclebase.html" class="tsd-kind-icon">Meta<wbr>Circle<wbr>Base</a></li>
<li class="tsd-kind-class"><a href="classes/polygonbase.html" class="tsd-kind-icon">Polygon<wbr>Base</a></li>
<li class="tsd-kind-class"><a href="classes/rotatedrectanglebase.html" class="tsd-kind-icon">Rotated<wbr>Rectangle<wbr>Base</a></li>
</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 ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<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>
</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>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable"><a href="globals.html#_id" class="tsd-kind-icon">_id</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Color Functions</h3>
<ul class="tsd-index-list">
<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#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>
</ul>
<h3>Drawable Functions</h3>
<ul class="tsd-index-list">
<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#hexagonfactory" class="tsd-kind-icon">Hexagon<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>
</ul>
<h3>Other 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>
<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 ">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<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>
</section>
</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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/graphics-library/texture/texture-options.ts#L27">graphics/graphics-library/texture/texture-options.ts:27</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</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>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable">
<a name="_id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagLet">Let</span> _id</h3>
<div class="tsd-signature tsd-kind-icon">_id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/21eb0a3/src/drawables/shapes/meta-circle-factory.ts#L16">drawables/shapes/meta-circle-factory.ts:16</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Color Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="hex" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> hex</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">hex<span class="tsd-signature-symbol">(</span>hex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec3</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/helper/colors/hex.ts#L14">helper/colors/hex.ts:14</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return a color given in a hexadecimal form as a vec3.</p>
</div>
<p>A hexadecimal color with (#ff0000) or without (ff0000)
a leading hash mark.</p>
<p>source: <a href="https://stackoverflow.com/questions/5623838/rgb-to-hex-and-hex-to-rgb">https://stackoverflow.com/questions/5623838/rgb-to-hex-and-hex-to-rgb</a></p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>hex: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec3</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="hsl" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> hsl</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">hsl<span class="tsd-signature-symbol">(</span>hue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, saturation<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, lightness<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><span class="tsd-signature-type">vec3</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/helper/colors/hsl.ts#L15">helper/colors/hsl.ts:15</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return a color contained in a vec3.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>hue: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 360</p>
</div>
</div>
</li>
<li>
<h5>saturation: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 100</p>
</div>
</div>
</li>
<li>
<h5>lightness: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 100</p>
<p>source: <a href="https://stackoverflow.com/questions/2353211/hsl-to-rgb-color-conversion">https://stackoverflow.com/questions/2353211/hsl-to-rgb-color-conversion</a></p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec3</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="rgb" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> rgb</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">rgb<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, b<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><span class="tsd-signature-type">vec3</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/helper/colors/rgb.ts#L12">helper/colors/rgb.ts:12</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return a color contained in a vec3.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>r: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 1</p>
</div>
</div>
</li>
<li>
<h5>g: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 1</p>
</div>
</div>
</li>
<li>
<h5>b: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 1</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec3</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="rgb255" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> rgb255</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">rgb255<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, b<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><span class="tsd-signature-type">vec3</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/helper/colors/rgb255.ts#L12">helper/colors/rgb255.ts:12</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return a color contained in a vec3.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>r: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 255</p>
</div>
</div>
</li>
<li>
<h5>g: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 255</p>
</div>
</div>
</li>
<li>
<h5>b: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 255</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec3</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="rgba" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> rgba</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">rgba<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, b<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, a<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><span class="tsd-signature-type">vec4</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/helper/colors/rgba.ts#L13">helper/colors/rgba.ts:13</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return a color with transparency contained in a vec4.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>r: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 1</p>
</div>
</div>
</li>
<li>
<h5>g: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 1</p>
</div>
</div>
</li>
<li>
<h5>b: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 1</p>
</div>
</div>
</li>
<li>
<h5>a: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 1</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec4</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="rgba255" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> rgba255</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">rgba255<span class="tsd-signature-symbol">(</span>r<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, g<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, b<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, a<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><span class="tsd-signature-type">vec4</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/helper/colors/rgba255.ts#L13">helper/colors/rgba255.ts:13</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return a color with transparency contained in a vec4.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>r: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 255</p>
</div>
</div>
</li>
<li>
<h5>g: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 255</p>
</div>
</div>
</li>
<li>
<h5>b: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 255</p>
</div>
</div>
</li>
<li>
<h5>a: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Should be between 0 and 255</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec4</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Drawable Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="circlefactory" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Circle<wbr>Factory</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">Circle<wbr>Factory<span class="tsd-signature-symbol">(</span>color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><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><span class="tsd-signature-symbol">typeof </span><a href="classes/circlebase.html" class="tsd-signature-type">CircleBase</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/drawables/shapes/circle-factory.ts#L18">drawables/shapes/circle-factory.ts:18</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>color: <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">typeof </span><a href="classes/circlebase.html" class="tsd-signature-type">CircleBase</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="dropletfactory" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Droplet<wbr>Factory</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">Droplet<wbr>Factory<span class="tsd-signature-symbol">(</span>color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><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><span class="tsd-signature-symbol">typeof </span><a href="classes/dropletbase.html" class="tsd-signature-type">DropletBase</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/drawables/shapes/droplet-factory.ts#L25">drawables/shapes/droplet-factory.ts:25</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>color: <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">typeof </span><a href="classes/dropletbase.html" class="tsd-signature-type">DropletBase</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="hexagonfactory" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Hexagon<wbr>Factory</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">Hexagon<wbr>Factory<span class="tsd-signature-symbol">(</span>color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><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><span class="tsd-signature-symbol">typeof </span><a href="classes/hexagonbase.html" class="tsd-signature-type">HexagonBase</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/21eb0a3/src/drawables/shapes/hexagon-factory.ts#L18">drawables/shapes/hexagon-factory.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>color: <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">typeof </span><a href="classes/hexagonbase.html" class="tsd-signature-type">HexagonBase</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="invertedtunnelfactory" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Inverted<wbr>Tunnel<wbr>Factory</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">Inverted<wbr>Tunnel<wbr>Factory<span class="tsd-signature-symbol">(</span>color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><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><span class="tsd-signature-symbol">typeof </span><a href="classes/invertedtunnelbase.html" class="tsd-signature-type">InvertedTunnelBase</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/drawables/shapes/inverted-tunnel-factory.ts#L27">drawables/shapes/inverted-tunnel-factory.ts:27</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Providing a noise texture is required for this drawable.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>color: <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">typeof </span><a href="classes/invertedtunnelbase.html" class="tsd-signature-type">InvertedTunnelBase</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="metacirclefactory" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Meta<wbr>Circle<wbr>Factory</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">Meta<wbr>Circle<wbr>Factory<span class="tsd-signature-symbol">(</span>color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, k<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><span class="tsd-signature-symbol">typeof </span><a href="classes/metacirclebase.html" class="tsd-signature-type">MetaCircleBase</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/src/drawables/shapes/meta-circle-factory.ts#L19">drawables/shapes/meta-circle-factory.ts:19</a></li>
=======
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/21eb0a3/src/drawables/shapes/meta-circle-factory.ts#L21">drawables/shapes/meta-circle-factory.ts:21</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>color: <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> k: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 32</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">typeof </span><a href="classes/metacirclebase.html" class="tsd-signature-type">MetaCircleBase</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="noisypolygonfactory" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Noisy<wbr>Polygon<wbr>Factory</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">Noisy<wbr>Polygon<wbr>Factory<span class="tsd-signature-symbol">(</span>vertexCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><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><span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">PolygonBase</span><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/noisypolygonbase.html" class="tsd-signature-type">NoisyPolygonBase</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/src/drawables/shapes/noisy-polygon-factory.ts#L14">drawables/shapes/noisy-polygon-factory.ts:14</a></li>
=======
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/21eb0a3/src/drawables/shapes/noisy-polygon-factory.ts#L14">drawables/shapes/noisy-polygon-factory.ts:14</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>vertexCount: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>color: <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">typeof </span><span class="tsd-signature-type">PolygonBase</span><span class="tsd-signature-symbol"> &amp; </span><a href="interfaces/noisypolygonbase.html" class="tsd-signature-type">NoisyPolygonBase</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="polygonfactory" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Polygon<wbr>Factory</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">Polygon<wbr>Factory<span class="tsd-signature-symbol">(</span>vertexCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><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><span class="tsd-signature-symbol">typeof </span><a href="classes/polygonbase.html" class="tsd-signature-type">PolygonBase</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/drawables/shapes/polygon-factory.ts#L20">drawables/shapes/polygon-factory.ts:20</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>vertexCount: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>color: <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">typeof </span><a href="classes/polygonbase.html" class="tsd-signature-type">PolygonBase</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function">
<a name="rotatedrectanglefactory" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> Rotated<wbr>Rectangle<wbr>Factory</h3>
<ul class="tsd-signatures tsd-kind-function">
<li class="tsd-signature tsd-kind-icon">Rotated<wbr>Rectangle<wbr>Factory<span class="tsd-signature-symbol">(</span>color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><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><span class="tsd-signature-symbol">typeof </span><a href="classes/rotatedrectanglebase.html" class="tsd-signature-type">RotatedRectangleBase</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/drawables/shapes/rotated-rectangle-factory.ts#L18">drawables/shapes/rotated-rectangle-factory.ts:18</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>color: <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">typeof </span><a href="classes/rotatedrectanglebase.html" class="tsd-signature-type">RotatedRectangleBase</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Other Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function">
<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><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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/src/compile.ts#L30">compile.ts:30</a></li>
=======
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/21eb0a3/src/compile.ts#L30">compile.ts:30</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Compiles a new renderer instance. There can multiple renderers on a single page.</p>
<blockquote>
<p>Asynchronous behaviour is required for parallel shader compiling.
Trying to draw before the returned promise resolves, results in no action taken.
Settings can be set before promise resolution and they will be applied later.</p>
</blockquote>
</div>
<p>The descriptors of every to-be-drawn objects are required before creating the renderer,
allowing the compiler to only create the shaders that will actually be used.</p>
<p>Example usage:</p>
<pre><code class="language-js"> <span class="hljs-keyword">import</span> { compile, hsl, CircleFactory, CircleLight } <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">30</span>, <span class="hljs-number">66</span>, <span class="hljs-number">50</span>));
<span class="hljs-keyword">const</span> renderer = <span class="hljs-keyword">await</span> compile(canvas, [Circle.descriptor, CircleLight.descriptor]);
</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><span class="tsd-flag ts-flagDefault value">Default value</span> settingsOverrides: <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>
</ul>
<h4 class="tsd-returns-title">Returns <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></h4>
</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">ReadonlyVec2</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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/src/graphics/rendering/renderer/noise-renderer.ts#L21">graphics/rendering/renderer/noise-renderer.ts:21</a></li>
=======
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/21eb0a3/src/graphics/rendering/renderer/noise-renderer.ts#L21">graphics/rendering/renderer/noise-renderer.ts:21</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create a renderer, draw a 2D 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">ReadonlyVec2</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 15</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 1</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 it&#39;s 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 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>, settings<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"> &amp; </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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/src/run-animation.ts#L46">run-animation.ts:46</a></li>
=======
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/21eb0a3/src/run-animation.ts#L46">run-animation.ts:46</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</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> settings: <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"> &amp; </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>
</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>
<section class="tsd-panel tsd-member tsd-kind-object-literal">
<a name="defaultruntimesettings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> default<wbr>Runtime<wbr>Settings</h3>
<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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/rendering/settings/default-runtime-settings.ts#L7">graphics/rendering/settings/default-runtime-settings.ts:7</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Contains the default values used for <a href="interfaces/runtimesettings.html">RuntimeSettings</a>.</p>
</div>
</div>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultruntimesettings.ambientlight" class="tsd-anchor"></a>
<h3>ambient<wbr>Light</h3>
<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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/src/graphics/rendering/settings/default-runtime-settings.ts#L16">graphics/rendering/settings/default-runtime-settings.ts:16</a></li>
=======
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/21eb0a3/src/graphics/rendering/settings/default-runtime-settings.ts#L16">graphics/rendering/settings/default-runtime-settings.ts:16</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultruntimesettings.colorpalette" class="tsd-anchor"></a>
<h3>color<wbr>Palette</h3>
<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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/rendering/settings/default-runtime-settings.ts#L14">graphics/rendering/settings/default-runtime-settings.ts:14</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/rendering/settings/default-runtime-settings.ts#L12">graphics/rendering/settings/default-runtime-settings.ts:12</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultruntimesettings.enablehighdpirendering" class="tsd-anchor"></a>
<h3>enable<wbr>High<wbr>Dpi<wbr>Rendering</h3>
<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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/rendering/settings/default-runtime-settings.ts#L8">graphics/rendering/settings/default-runtime-settings.ts:8</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultruntimesettings.isworldinverted" class="tsd-anchor"></a>
<h3>is<wbr>World<wbr>Inverted</h3>
<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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/rendering/settings/default-runtime-settings.ts#L10">graphics/rendering/settings/default-runtime-settings.ts:10</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultruntimesettings.lightcutoffdistance" class="tsd-anchor"></a>
<h3>light<wbr>Cutoff<wbr>Distance</h3>
<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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/rendering/settings/default-runtime-settings.ts#L11">graphics/rendering/settings/default-runtime-settings.ts:11</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/rendering/settings/default-runtime-settings.ts#L13">graphics/rendering/settings/default-runtime-settings.ts:13</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultruntimesettings.motionblur" class="tsd-anchor"></a>
<h3>motion<wbr>Blur</h3>
<div class="tsd-signature tsd-kind-icon">motion<wbr>Blur<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0.3</span></div>
<aside class="tsd-sources">
<ul>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/src/graphics/rendering/settings/default-runtime-settings.ts#L15">graphics/rendering/settings/default-runtime-settings.ts:15</a></li>
=======
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/21eb0a3/src/graphics/rendering/settings/default-runtime-settings.ts#L15">graphics/rendering/settings/default-runtime-settings.ts:15</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/src/graphics/rendering/settings/default-runtime-settings.ts#L17">graphics/rendering/settings/default-runtime-settings.ts:17</a></li>
=======
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/21eb0a3/src/graphics/rendering/settings/default-runtime-settings.ts#L17">graphics/rendering/settings/default-runtime-settings.ts:17</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/rendering/settings/default-runtime-settings.ts#L9">graphics/rendering/settings/default-runtime-settings.ts:9</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
</section>
</section>
<section class="tsd-panel tsd-member tsd-kind-object-literal">
<a name="defaultstartupsettings" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> default<wbr>Startup<wbr>Settings</h3>
<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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/rendering/settings/default-startup-settings.ts#L7">graphics/rendering/settings/default-startup-settings.ts:7</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Contains the default values used for <a href="interfaces/startupsettings.html">StartupSettings</a>.</p>
</div>
</div>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultstartupsettings.backgroundcolor" class="tsd-anchor"></a>
<h3>background<wbr>Color</h3>
<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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/rendering/settings/default-startup-settings.ts#L11">graphics/rendering/settings/default-startup-settings.ts:11</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultstartupsettings.enablecontextlostsimulator" class="tsd-anchor"></a>
<h3>enable<wbr>Context<wbr>Lost<wbr>Simulator</h3>
<div class="tsd-signature tsd-kind-icon">enable<wbr>Context<wbr>Lost<wbr>Simulator<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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/src/graphics/rendering/settings/default-startup-settings.ts#L14">graphics/rendering/settings/default-startup-settings.ts:14</a></li>
=======
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/21eb0a3/src/graphics/rendering/settings/default-startup-settings.ts#L14">graphics/rendering/settings/default-startup-settings.ts:14</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultstartupsettings.enablestopwatch" class="tsd-anchor"></a>
<h3>enable<wbr>Stopwatch</h3>
<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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/src/graphics/rendering/settings/default-startup-settings.ts#L13">graphics/rendering/settings/default-startup-settings.ts:13</a></li>
=======
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/21eb0a3/src/graphics/rendering/settings/default-startup-settings.ts#L13">graphics/rendering/settings/default-startup-settings.ts:13</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultstartupsettings.ignorewebgl2" class="tsd-anchor"></a>
<h3>ignore<wbr>WebGL2</h3>
<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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/rendering/settings/default-startup-settings.ts#L10">graphics/rendering/settings/default-startup-settings.ts:10</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/rendering/settings/default-startup-settings.ts#L12">graphics/rendering/settings/default-startup-settings.ts:12</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultstartupsettings.palettesize" class="tsd-anchor"></a>
<h3>palette<wbr>Size</h3>
<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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/rendering/settings/default-startup-settings.ts#L9">graphics/rendering/settings/default-startup-settings.ts:9</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
<a name="defaultstartupsettings.shadowtracecount" class="tsd-anchor"></a>
<h3>shadow<wbr>Trace<wbr>Count</h3>
<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>
<<<<<<< HEAD
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/12570ab/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/21eb0a3/src/graphics/rendering/settings/default-startup-settings.ts#L8">graphics/rendering/settings/default-startup-settings.ts:8</a></li>
>>>>>>> 2454f2f37d581c69f5d0c844a028712ddbc0a1cc
</ul>
</aside>
</section>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<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">
<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/circlebase.html" class="tsd-kind-icon">Circle<wbr>Base</a>
</li>
<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>
<li class=" tsd-kind-class">
<a href="classes/dropletbase.html" class="tsd-kind-icon">Droplet<wbr>Base</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/fpsqualityautoscaler.html" class="tsd-kind-icon">Fps<wbr>Quality<wbr>Autoscaler</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/hexagonbase.html" class="tsd-kind-icon">Hexagon<wbr>Base</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/invertedtunnelbase.html" class="tsd-kind-icon">Inverted<wbr>Tunnel<wbr>Base</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/metacirclebase.html" class="tsd-kind-icon">Meta<wbr>Circle<wbr>Base</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/polygonbase.html" class="tsd-kind-icon">Polygon<wbr>Base</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/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/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>
<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-variable">
<a href="globals.html#_id" class="tsd-kind-icon">_id</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#hexagonfactory" class="tsd-kind-icon">Hexagon<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-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>
<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>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink