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

188
docs/interfaces/__global.array.html Normal file
View file

@ -0,0 +1,188 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Array | 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" />
</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>
<a href="../index.html" class="title">SDF-2D - v0.6.0</a>
</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>
<li>
<a href="../modules/__global.html">__global</a>
</li>
<li>
<a href="__global.array.html">Array</a>
</li>
</ul>
<h1>Interface Array&lt;T&gt;</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Array</span>
</li>
</ul>
</section>
<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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="__global.array.html#x" class="tsd-kind-icon">x</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="__global.array.html#y" class="tsd-kind-icon">y</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="x" class="tsd-anchor"></a>
<h3>x</h3>
<div class="tsd-signature tsd-kind-icon">x<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/main.ts#L13">main.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="y" class="tsd-anchor"></a>
<h3>y</h3>
<div class="tsd-signature tsd-kind-icon">y<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/main.ts#L14">main.ts:14</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-namespace">
<a href="../modules/__global.html">__global</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-namespace tsd-has-type-parameter">
<a href="__global.array.html" class="tsd-kind-icon">Array</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="__global.array.html#x" class="tsd-kind-icon">x</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="__global.array.html#y" class="tsd-kind-icon">y</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="__global.float32array.html" class="tsd-kind-icon">Float32<wbr>Array</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>

180
docs/interfaces/__global.float32array.html Normal file
View file

@ -0,0 +1,180 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Float32Array | 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" />
</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>
<a href="../index.html" class="title">SDF-2D - v0.6.0</a>
</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>
<li>
<a href="../modules/__global.html">__global</a>
</li>
<li>
<a href="__global.float32array.html">Float32Array</a>
</li>
</ul>
<h1>Interface Float32Array</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Float32Array</span>
</li>
</ul>
</section>
<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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="__global.float32array.html#x" class="tsd-kind-icon">x</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="__global.float32array.html#y" class="tsd-kind-icon">y</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="x" class="tsd-anchor"></a>
<h3>x</h3>
<div class="tsd-signature tsd-kind-icon">x<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/main.ts#L18">main.ts:18</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="y" class="tsd-anchor"></a>
<h3>y</h3>
<div class="tsd-signature tsd-kind-icon">y<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/main.ts#L19">main.ts:19</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current 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-interface tsd-parent-kind-namespace tsd-has-type-parameter">
<a href="__global.array.html" class="tsd-kind-icon">Array</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-namespace">
<a href="__global.float32array.html" class="tsd-kind-icon">Float32<wbr>Array</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="__global.float32array.html#x" class="tsd-kind-icon">x</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="__global.float32array.html#y" class="tsd-kind-icon">y</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</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>

122
docs/interfaces/drawabledescriptor.html
View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DrawableDescriptor | SDF-2D - v0.5.3</title>
<meta name="description" content="Documentation for SDF-2D - v0.5.3">
<title>DrawableDescriptor | 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">
@ -108,7 +108,7 @@
<div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="../classes/drawable.html" class="tsd-signature-type">Drawable</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/drawables/drawable-descriptor.ts#L73">drawables/drawable-descriptor.ts:73</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/drawable-descriptor.ts#L73">drawables/drawable-descriptor.ts:73</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -124,7 +124,7 @@
<div class="tsd-signature tsd-kind-icon">object<wbr>Count<wbr>Scaler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/drawables/drawable-descriptor.ts#L57">drawables/drawable-descriptor.ts:57</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/drawable-descriptor.ts#L57">drawables/drawable-descriptor.ts:57</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -141,7 +141,7 @@
<div class="tsd-signature tsd-kind-icon">property<wbr>Uniform<wbr>Mapping<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/drawables/drawable-descriptor.ts#L17">drawables/drawable-descriptor.ts:17</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/drawable-descriptor.ts#L17">drawables/drawable-descriptor.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -165,7 +165,7 @@
<div class="tsd-signature tsd-kind-icon">sdf<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>distanceFunctionName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>isInverted<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol">; </span>shader<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/drawables/drawable-descriptor.ts#L28">drawables/drawable-descriptor.ts:28</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/drawable-descriptor.ts#L28">drawables/drawable-descriptor.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -177,10 +177,10 @@
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="shadercombinationsteps" class="tsd-anchor"></a>
<h3>shader<wbr>Combination<wbr>Steps</h3>
<div class="tsd-signature tsd-kind-icon">shader<wbr>Combination<wbr>Steps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></div>
<div class="tsd-signature tsd-kind-icon">shader<wbr>Combination<wbr>Steps<span class="tsd-signature-symbol">:</span> <a href="__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/drawables/drawable-descriptor.ts#L67">drawables/drawable-descriptor.ts:67</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/drawable-descriptor.ts#L67">drawables/drawable-descriptor.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -198,7 +198,7 @@
<div class="tsd-signature tsd-kind-icon">uniform<wbr>Count<wbr>Macro<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/drawables/drawable-descriptor.ts#L23">drawables/drawable-descriptor.ts:23</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/drawable-descriptor.ts#L23">drawables/drawable-descriptor.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -220,39 +220,6 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/filteringoptions.html" class="tsd-kind-icon">Filtering<wbr>Options</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/wrapoptions.html" class="tsd-kind-icon">Wrap<wbr>Options</a>
</li>
<li class=" tsd-kind-class">
<a href="../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/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/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>
<ul class="current">
<li class="current tsd-kind-interface">
@ -280,75 +247,6 @@
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="noisypolygonbase.html" class="tsd-kind-icon">Noisy<wbr>Polygon<wbr>Base</a>
</li>
<li class=" tsd-kind-interface">
<a href="renderer.html" class="tsd-kind-icon">Renderer</a>
</li>
<li class=" tsd-kind-interface">
<a href="runtimesettings.html" class="tsd-kind-icon">Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="textureoptions.html" class="tsd-kind-icon">Texture<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#texturewithoptions" class="tsd-kind-icon">Texture<wbr>With<wbr>Options</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#circlefactory" class="tsd-kind-icon">Circle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#dropletfactory" class="tsd-kind-icon">Droplet<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#invertedtunnelfactory" class="tsd-kind-icon">Inverted<wbr>Tunnel<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#metacirclefactory" class="tsd-kind-icon">Meta<wbr>Circle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#noisypolygonfactory" class="tsd-kind-icon">Noisy<wbr>Polygon<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#polygonfactory" class="tsd-kind-icon">Polygon<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rotatedrectanglefactory" class="tsd-kind-icon">Rotated<wbr>Rectangle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#hex" class="tsd-kind-icon">hex</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#hsl" class="tsd-kind-icon">hsl</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rendernoise" class="tsd-kind-icon">render<wbr>Noise</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgb" class="tsd-kind-icon">rgb</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgb255" class="tsd-kind-icon">rgb255</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgba" class="tsd-kind-icon">rgba</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgba255" class="tsd-kind-icon">rgba255</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#defaultruntimesettings" class="tsd-kind-icon">default<wbr>Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#defaultstartupsettings" class="tsd-kind-icon">default<wbr>Startup<wbr>Settings</a>
</li>
</ul>
</nav>
</div>

126
docs/interfaces/noisypolygonbase.html
View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>NoisyPolygonBase | SDF-2D - v0.5.3</title>
<meta name="description" content="Documentation for SDF-2D - v0.5.3">
<title>NoisyPolygonBase | 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">
@ -110,20 +110,20 @@
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-interface tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Noisy<wbr>Polygon<wbr>Base<span class="tsd-signature-symbol">(</span>vertices<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="noisypolygonbase.html" class="tsd-signature-type">NoisyPolygonBase</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Noisy<wbr>Polygon<wbr>Base<span class="tsd-signature-symbol">(</span>vertices<span class="tsd-signature-symbol">: </span><a href="__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="noisypolygonbase.html" class="tsd-signature-type">NoisyPolygonBase</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="../classes/polygonbase.html">PolygonBase</a>.<a href="../classes/polygonbase.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/drawables/shapes/polygon-factory.ts#L11">drawables/shapes/polygon-factory.ts:11</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/shapes/polygon-factory.ts#L11">drawables/shapes/polygon-factory.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>vertices: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol">&gt;</span></h5>
<h5>vertices: <a href="__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="noisypolygonbase.html" class="tsd-signature-type">NoisyPolygonBase</a></h4>
@ -139,17 +139,17 @@
<div class="tsd-signature tsd-kind-icon">random<wbr>Offset<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<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#L8">drawables/shapes/noisy-polygon-factory.ts:8</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/shapes/noisy-polygon-factory.ts#L8">drawables/shapes/noisy-polygon-factory.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="vertices" class="tsd-anchor"></a>
<h3>vertices</h3>
<div class="tsd-signature tsd-kind-icon">vertices<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol">&gt;</span></div>
<div class="tsd-signature tsd-kind-icon">vertices<span class="tsd-signature-symbol">:</span> <a href="__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/drawables/shapes/polygon-factory.ts#L12">drawables/shapes/polygon-factory.ts:12</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/shapes/polygon-factory.ts#L12">drawables/shapes/polygon-factory.ts:12</a></li>
</ul>
</aside>
</section>
@ -161,7 +161,7 @@
<p>Inherited from EmptyDrawable.descriptor</p>
<p>Overrides <a href="../classes/drawable.html">Drawable</a>.<a href="../classes/drawable.html#descriptor">descriptor</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/drawables/empty-drawable.ts#L9">drawables/empty-drawable.ts:9</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/empty-drawable.ts#L9">drawables/empty-drawable.ts:9</a></li>
</ul>
</aside>
</section>
@ -180,7 +180,7 @@
<p>Inherited from EmptyDrawable.getObjectToSerialize</p>
<p>Overrides <a href="../classes/drawable.html">Drawable</a>.<a href="../classes/drawable.html#getobjecttoserialize">getObjectToSerialize</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/drawables/empty-drawable.ts#L15">drawables/empty-drawable.ts:15</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/empty-drawable.ts#L15">drawables/empty-drawable.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -208,7 +208,7 @@
<p>Inherited from EmptyDrawable.minDistance</p>
<p>Overrides <a href="../classes/drawable.html">Drawable</a>.<a href="../classes/drawable.html#mindistance">minDistance</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/drawables/empty-drawable.ts#L11">drawables/empty-drawable.ts:11</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/drawables/empty-drawable.ts#L11">drawables/empty-drawable.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@ -233,42 +233,6 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/filteringoptions.html" class="tsd-kind-icon">Filtering<wbr>Options</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/wrapoptions.html" class="tsd-kind-icon">Wrap<wbr>Options</a>
</li>
<li class=" tsd-kind-class">
<a href="../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/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/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="drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
@ -296,72 +260,6 @@
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="renderer.html" class="tsd-kind-icon">Renderer</a>
</li>
<li class=" tsd-kind-interface">
<a href="runtimesettings.html" class="tsd-kind-icon">Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="textureoptions.html" class="tsd-kind-icon">Texture<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#texturewithoptions" class="tsd-kind-icon">Texture<wbr>With<wbr>Options</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#circlefactory" class="tsd-kind-icon">Circle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#dropletfactory" class="tsd-kind-icon">Droplet<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#invertedtunnelfactory" class="tsd-kind-icon">Inverted<wbr>Tunnel<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#metacirclefactory" class="tsd-kind-icon">Meta<wbr>Circle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#noisypolygonfactory" class="tsd-kind-icon">Noisy<wbr>Polygon<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#polygonfactory" class="tsd-kind-icon">Polygon<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rotatedrectanglefactory" class="tsd-kind-icon">Rotated<wbr>Rectangle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#hex" class="tsd-kind-icon">hex</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#hsl" class="tsd-kind-icon">hsl</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rendernoise" class="tsd-kind-icon">render<wbr>Noise</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgb" class="tsd-kind-icon">rgb</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgb255" class="tsd-kind-icon">rgb255</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgba" class="tsd-kind-icon">rgba</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgba255" class="tsd-kind-icon">rgba255</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#defaultruntimesettings" class="tsd-kind-icon">default<wbr>Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#defaultstartupsettings" class="tsd-kind-icon">default<wbr>Startup<wbr>Settings</a>
</li>
</ul>
</nav>
</div>

219
docs/interfaces/renderer.html
View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Renderer | SDF-2D - v0.5.3</title>
<meta name="description" content="Documentation for SDF-2D - v0.5.3">
<title>Renderer | 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">
@ -95,12 +95,12 @@
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="renderer.html#adddrawable" class="tsd-kind-icon">add<wbr>Drawable</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="renderer.html#autoscalequality" class="tsd-kind-icon">autoscale<wbr>Quality</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="renderer.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="renderer.html#displaytoworldcoordinates" class="tsd-kind-icon">display<wbr>ToWorld<wbr>Coordinates</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="renderer.html#renderdrawables" class="tsd-kind-icon">render<wbr>Drawables</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="renderer.html#setruntimesettings" class="tsd-kind-icon">set<wbr>Runtime<wbr>Settings</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="renderer.html#setviewarea" class="tsd-kind-icon">set<wbr>View<wbr>Area</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="renderer.html#worldtodisplaycoordinates" class="tsd-kind-icon">world<wbr>ToDisplay<wbr>Coordinates</a></li>
</ul>
</section>
</div>
@ -114,7 +114,7 @@
<div class="tsd-signature tsd-kind-icon">canvas<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/renderer/renderer.ts#L14">graphics/rendering/renderer/renderer.ts:14</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L15">graphics/rendering/renderer/renderer.ts:15</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -126,20 +126,18 @@
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="insights" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> insights</h3>
<div class="tsd-signature tsd-kind-icon">insights<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<div class="tsd-signature tsd-kind-icon">insights<span class="tsd-signature-symbol">:</span> <a href="rendererinfo.html" class="tsd-signature-type">RendererInfo</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/renderer/renderer.ts#L81">graphics/rendering/renderer/renderer.ts:81</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L95">graphics/rendering/renderer/renderer.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>experimental</dt>
<dd><p>Debug information updated on each <code>renderDrawables</code> call.
Its scheme is not yet defined. The main purpose of this is
human debugging.</p>
</dd>
</dl>
<div class="lead">
<p>Get useful information about the hardware and the SDF2D renderer.</p>
</div>
<p>Its sheme is subject to change.</p>
<p>During context lost it might be null.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
@ -148,7 +146,7 @@
<div class="tsd-signature tsd-kind-icon">view<wbr>Area<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/renderer/renderer.ts#L21">graphics/rendering/renderer/renderer.ts:21</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L22">graphics/rendering/renderer/renderer.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -171,7 +169,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/renderer.ts#L56">graphics/rendering/renderer/renderer.ts:56</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L69">graphics/rendering/renderer/renderer.ts:69</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -199,40 +197,6 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="autoscalequality" class="tsd-anchor"></a>
<h3>autoscale<wbr>Quality</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">autoscale<wbr>Quality<span class="tsd-signature-symbol">(</span>deltaTime<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">void</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/graphics/rendering/renderer/renderer.ts#L91">graphics/rendering/renderer/renderer.ts:91</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<dl class="tsd-comment-tags">
<dt>experimental</dt>
<dd><p>Scale the render scale for both the canvas and the SDF memoization based
on the current and historical FPS values.</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>deltaTime: <span class="tsd-signature-type">DOMHighResTimeStamp</span></h5>
<div class="tsd-comment tsd-typography">
<p>since the last frame, in milliseconds.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
@ -243,7 +207,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/renderer.ts#L72">graphics/rendering/renderer/renderer.ts:72</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L85">graphics/rendering/renderer/renderer.ts:85</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -267,12 +231,13 @@
<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/renderer.ts#L42">graphics/rendering/renderer/renderer.ts:42</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L44">graphics/rendering/renderer/renderer.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return the world coordinates from a pixel&#39;s position.</p>
<p>The inverse of <code>worldToDisplayCoordinates</code>, returns the world coordinates
from a pixel&#39;s position.</p>
</div>
<p>The view area coordinates are also given in world coordinates.</p>
<p>Useful for picking.</p>
@ -301,7 +266,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/renderer.ts#L64">graphics/rendering/renderer/renderer.ts:64</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L77">graphics/rendering/renderer/renderer.ts:77</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -325,7 +290,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/renderer.ts#L48">graphics/rendering/renderer/renderer.ts:48</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L61">graphics/rendering/renderer/renderer.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -355,7 +320,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/renderer.ts#L30">graphics/rendering/renderer/renderer.ts:30</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L31">graphics/rendering/renderer/renderer.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -383,6 +348,40 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="worldtodisplaycoordinates" class="tsd-anchor"></a>
<h3>world<wbr>ToDisplay<wbr>Coordinates</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">world<wbr>ToDisplay<wbr>Coordinates<span class="tsd-signature-symbol">(</span>worldCoordinates<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</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/graphics/rendering/renderer/renderer.ts#L55">graphics/rendering/renderer/renderer.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The inverse of <code>displayToWorldCoordinates</code>, returns the screen space position
of a point given in world space cooridnates.</p>
</div>
<p>While the origin for worldCoordinates resides in the bottom-left corner,
the origin of the returned display coordinates is placed in the top left.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>worldCoordinates: <span class="tsd-signature-type">vec2</span></h5>
<div class="tsd-comment tsd-typography">
<p>Coordinates used when drawing objects.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec2</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@ -395,45 +394,6 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/filteringoptions.html" class="tsd-kind-icon">Filtering<wbr>Options</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/wrapoptions.html" class="tsd-kind-icon">Wrap<wbr>Options</a>
</li>
<li class=" tsd-kind-class">
<a href="../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/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/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="drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a>
</li>
<li class=" tsd-kind-interface">
<a href="noisypolygonbase.html" class="tsd-kind-icon">Noisy<wbr>Polygon<wbr>Base</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
@ -451,9 +411,6 @@
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter">
<a href="renderer.html#adddrawable" class="tsd-kind-icon">add<wbr>Drawable</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="renderer.html#autoscalequality" class="tsd-kind-icon">autoscale<wbr>Quality</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="renderer.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
@ -469,73 +426,13 @@
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="renderer.html#setviewarea" class="tsd-kind-icon">set<wbr>View<wbr>Area</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="renderer.html#worldtodisplaycoordinates" class="tsd-kind-icon">world<wbr>ToDisplay<wbr>Coordinates</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="runtimesettings.html" class="tsd-kind-icon">Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="textureoptions.html" class="tsd-kind-icon">Texture<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#texturewithoptions" class="tsd-kind-icon">Texture<wbr>With<wbr>Options</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#circlefactory" class="tsd-kind-icon">Circle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#dropletfactory" class="tsd-kind-icon">Droplet<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#invertedtunnelfactory" class="tsd-kind-icon">Inverted<wbr>Tunnel<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#metacirclefactory" class="tsd-kind-icon">Meta<wbr>Circle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#noisypolygonfactory" class="tsd-kind-icon">Noisy<wbr>Polygon<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#polygonfactory" class="tsd-kind-icon">Polygon<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rotatedrectanglefactory" class="tsd-kind-icon">Rotated<wbr>Rectangle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#hex" class="tsd-kind-icon">hex</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#hsl" class="tsd-kind-icon">hsl</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rendernoise" class="tsd-kind-icon">render<wbr>Noise</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgb" class="tsd-kind-icon">rgb</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgb255" class="tsd-kind-icon">rgb255</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgba" class="tsd-kind-icon">rgba</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgba255" class="tsd-kind-icon">rgba255</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#defaultruntimesettings" class="tsd-kind-icon">default<wbr>Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#defaultstartupsettings" class="tsd-kind-icon">default<wbr>Startup<wbr>Settings</a>
</li>
</ul>
</nav>
</div>

300
docs/interfaces/rendererinfo.html Normal file
View file

@ -0,0 +1,300 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RendererInfo | 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" />
</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>
<a href="../index.html" class="title">SDF-2D - v0.6.0</a>
</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>
<li>
<a href="rendererinfo.html">RendererInfo</a>
</li>
</ul>
<h1>Interface RendererInfo</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">RendererInfo</span>
</li>
</ul>
</section>
<section class="tsd-panel tsd-kind-interface">
<h3 class="tsd-before-signature">Indexable</h3>
<div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></div>
</section>
<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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="rendererinfo.html#extensions" class="tsd-kind-icon">extensions</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="rendererinfo.html#floatinterpolationenabled" class="tsd-kind-icon">float<wbr>Interpolation<wbr>Enabled</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="rendererinfo.html#iswebgl2" class="tsd-kind-icon">is<wbr>WebGL2</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="rendererinfo.html#programcount" class="tsd-kind-icon">program<wbr>Count</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="rendererinfo.html#renderpasses" class="tsd-kind-icon">render<wbr>Passes</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="rendererinfo.html#renderer" class="tsd-kind-icon">renderer</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="rendererinfo.html#startuptimeinmilliseconds" class="tsd-kind-icon">startup<wbr>Time<wbr>InMilliseconds</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="rendererinfo.html#vendor" class="tsd-kind-icon">vendor</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="extensions" class="tsd-anchor"></a>
<h3>extensions</h3>
<div class="tsd-signature tsd-kind-icon">extensions<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/06dfd59/src/graphics/rendering/renderer/renderer-info.ts#L5">graphics/rendering/renderer/renderer-info.ts:5</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="floatinterpolationenabled" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> float<wbr>Interpolation<wbr>Enabled</h3>
<div class="tsd-signature tsd-kind-icon">float<wbr>Interpolation<wbr>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer-info.ts#L6">graphics/rendering/renderer/renderer-info.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="iswebgl2" class="tsd-anchor"></a>
<h3>is<wbr>WebGL2</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>WebGL2<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer-info.ts#L2">graphics/rendering/renderer/renderer-info.ts:2</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="programcount" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> program<wbr>Count</h3>
<div class="tsd-signature tsd-kind-icon">program<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer-info.ts#L7">graphics/rendering/renderer/renderer-info.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="renderpasses" class="tsd-anchor"></a>
<h3>render<wbr>Passes</h3>
<div class="tsd-signature tsd-kind-icon">render<wbr>Passes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>distance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>drawableCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>drawnDrawableCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>renderScale<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tileCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</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>lights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>drawnDrawableCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>renderScale<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer-info.ts#L8">graphics/rendering/renderer/renderer-info.ts:8</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>distance<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>drawableCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>drawnDrawableCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>renderScale<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>tileCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> drawable<wbr>Count<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> drawn<wbr>Drawable<wbr>Count<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> render<wbr>Scale<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> tile<wbr>Count<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</li>
<li class="tsd-parameter">
<h5>lights<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>drawnDrawableCount<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>renderScale<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> drawn<wbr>Drawable<wbr>Count<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> render<wbr>Scale<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="renderer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> renderer</h3>
<div class="tsd-signature tsd-kind-icon">renderer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer-info.ts#L4">graphics/rendering/renderer/renderer-info.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="startuptimeinmilliseconds" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> startup<wbr>Time<wbr>InMilliseconds</h3>
<div class="tsd-signature tsd-kind-icon">startup<wbr>Time<wbr>InMilliseconds<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer-info.ts#L20">graphics/rendering/renderer/renderer-info.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="vendor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> vendor</h3>
<div class="tsd-signature tsd-kind-icon">vendor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer-info.ts#L3">graphics/rendering/renderer/renderer-info.ts:3</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="rendererinfo.html" class="tsd-kind-icon">Renderer<wbr>Info</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="rendererinfo.html#extensions" class="tsd-kind-icon">extensions</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="rendererinfo.html#floatinterpolationenabled" class="tsd-kind-icon">float<wbr>Interpolation<wbr>Enabled</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="rendererinfo.html#iswebgl2" class="tsd-kind-icon">is<wbr>WebGL2</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="rendererinfo.html#programcount" class="tsd-kind-icon">program<wbr>Count</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="rendererinfo.html#renderpasses" class="tsd-kind-icon">render<wbr>Passes</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="rendererinfo.html#renderer" class="tsd-kind-icon">renderer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="rendererinfo.html#startuptimeinmilliseconds" class="tsd-kind-icon">startup<wbr>Time<wbr>InMilliseconds</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="rendererinfo.html#vendor" class="tsd-kind-icon">vendor</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</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>

166
docs/interfaces/runtimesettings.html
View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RuntimeSettings | SDF-2D - v0.5.3</title>
<meta name="description" content="Documentation for SDF-2D - v0.5.3">
<title>RuntimeSettings | 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">
@ -89,9 +89,11 @@
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runtimesettings.html#ambientlight" class="tsd-kind-icon">ambient<wbr>Light</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runtimesettings.html#colorpalette" class="tsd-kind-icon">color<wbr>Palette</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runtimesettings.html#distancerenderscale" class="tsd-kind-icon">distance<wbr>Render<wbr>Scale</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runtimesettings.html#enablehighdpirendering" class="tsd-kind-icon">enable<wbr>High<wbr>Dpi<wbr>Rendering</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runtimesettings.html#isworldinverted" class="tsd-kind-icon">is<wbr>World<wbr>Inverted</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runtimesettings.html#lightcutoffdistance" class="tsd-kind-icon">light<wbr>Cutoff<wbr>Distance</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runtimesettings.html#lightsrenderscale" class="tsd-kind-icon">lights<wbr>Render<wbr>Scale</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runtimesettings.html#textures" class="tsd-kind-icon">textures</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runtimesettings.html#tilemultiplier" class="tsd-kind-icon">tile<wbr>Multiplier</a></li>
</ul>
@ -107,7 +109,7 @@
<div class="tsd-signature tsd-kind-icon">ambient<wbr>Light<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec3</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/settings/runtime-settings.ts#L66">graphics/rendering/settings/runtime-settings.ts:66</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L83">graphics/rendering/settings/runtime-settings.ts:83</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -119,10 +121,10 @@
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="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">Array</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span></div>
<div class="tsd-signature tsd-kind-icon">color<wbr>Palette<span class="tsd-signature-symbol">:</span> <a href="__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</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">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/settings/runtime-settings.ts#L49">graphics/rendering/settings/runtime-settings.ts:49</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L49">graphics/rendering/settings/runtime-settings.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -134,13 +136,31 @@
<p>Can have transparency, but only if WebGL2 support is enabled.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L59">graphics/rendering/settings/runtime-settings.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The resolution of the distance field rendering will be scaled up or down with this value.</p>
</div>
<p>Because of interpolation, this can be set much lower than the <code>lightsRenderScale</code>, while
maintaining closely the same perceived quality.</p>
<p>Setting this is a great way to balance quality and performance.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="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">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/settings/runtime-settings.ts#L14">graphics/rendering/settings/runtime-settings.ts:14</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L14">graphics/rendering/settings/runtime-settings.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -155,7 +175,7 @@
<div class="tsd-signature tsd-kind-icon">is<wbr>World<wbr>Inverted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/settings/runtime-settings.ts#L33">graphics/rendering/settings/runtime-settings.ts:33</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L33">graphics/rendering/settings/runtime-settings.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -172,7 +192,7 @@
<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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/settings/runtime-settings.ts#L39">graphics/rendering/settings/runtime-settings.ts:39</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L39">graphics/rendering/settings/runtime-settings.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -182,13 +202,29 @@
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L66">graphics/rendering/settings/runtime-settings.ts:66</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The resolution of the final frame will be scaled by this value.</p>
</div>
<p>Setting this is a great way to balance quality and performance.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="textures" class="tsd-anchor"></a>
<h3>textures</h3>
<div class="tsd-signature tsd-kind-icon">textures<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/settings/runtime-settings.ts#L59">graphics/rendering/settings/runtime-settings.ts:59</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L76">graphics/rendering/settings/runtime-settings.ts:76</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -215,7 +251,7 @@
<div class="tsd-signature tsd-kind-icon">tile<wbr>Multiplier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/settings/runtime-settings.ts#L26">graphics/rendering/settings/runtime-settings.ts:26</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/runtime-settings.ts#L26">graphics/rendering/settings/runtime-settings.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -242,48 +278,6 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/filteringoptions.html" class="tsd-kind-icon">Filtering<wbr>Options</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/wrapoptions.html" class="tsd-kind-icon">Wrap<wbr>Options</a>
</li>
<li class=" tsd-kind-class">
<a href="../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/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/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="drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a>
</li>
<li class=" tsd-kind-interface">
<a href="noisypolygonbase.html" class="tsd-kind-icon">Noisy<wbr>Polygon<wbr>Base</a>
</li>
<li class=" tsd-kind-interface">
<a href="renderer.html" class="tsd-kind-icon">Renderer</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
@ -295,6 +289,9 @@
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="runtimesettings.html#colorpalette" class="tsd-kind-icon">color<wbr>Palette</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="runtimesettings.html#distancerenderscale" class="tsd-kind-icon">distance<wbr>Render<wbr>Scale</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="runtimesettings.html#enablehighdpirendering" class="tsd-kind-icon">enable<wbr>High<wbr>Dpi<wbr>Rendering</a>
</li>
@ -304,6 +301,9 @@
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="runtimesettings.html#lightcutoffdistance" class="tsd-kind-icon">light<wbr>Cutoff<wbr>Distance</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="runtimesettings.html#lightsrenderscale" class="tsd-kind-icon">lights<wbr>Render<wbr>Scale</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="runtimesettings.html#textures" class="tsd-kind-icon">textures</a>
</li>
@ -314,66 +314,6 @@
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="textureoptions.html" class="tsd-kind-icon">Texture<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#texturewithoptions" class="tsd-kind-icon">Texture<wbr>With<wbr>Options</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#circlefactory" class="tsd-kind-icon">Circle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#dropletfactory" class="tsd-kind-icon">Droplet<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#invertedtunnelfactory" class="tsd-kind-icon">Inverted<wbr>Tunnel<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#metacirclefactory" class="tsd-kind-icon">Meta<wbr>Circle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#noisypolygonfactory" class="tsd-kind-icon">Noisy<wbr>Polygon<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#polygonfactory" class="tsd-kind-icon">Polygon<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rotatedrectanglefactory" class="tsd-kind-icon">Rotated<wbr>Rectangle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#hex" class="tsd-kind-icon">hex</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#hsl" class="tsd-kind-icon">hsl</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rendernoise" class="tsd-kind-icon">render<wbr>Noise</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgb" class="tsd-kind-icon">rgb</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgb255" class="tsd-kind-icon">rgb255</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgba" class="tsd-kind-icon">rgba</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgba255" class="tsd-kind-icon">rgba255</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#defaultruntimesettings" class="tsd-kind-icon">default<wbr>Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#defaultstartupsettings" class="tsd-kind-icon">default<wbr>Startup<wbr>Settings</a>
</li>
</ul>
</nav>
</div>

139
docs/interfaces/startupsettings.html
View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>StartupSettings | SDF-2D - v0.5.3</title>
<meta name="description" content="Documentation for SDF-2D - v0.5.3">
<title>StartupSettings | 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">
@ -90,6 +90,7 @@
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="startupsettings.html#backgroundcolor" class="tsd-kind-icon">background<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="startupsettings.html#enablestopwatch" class="tsd-kind-icon">enable<wbr>Stopwatch</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="startupsettings.html#ignorewebgl2" class="tsd-kind-icon">ignore<wbr>WebGL2</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="startupsettings.html#lightpenetrationratio" class="tsd-kind-icon">light<wbr>Penetration<wbr>Ratio</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="startupsettings.html#palettesize" class="tsd-kind-icon">palette<wbr>Size</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="startupsettings.html#shadowtracecount" class="tsd-kind-icon">shadow<wbr>Trace<wbr>Count</a></li>
</ul>
@ -105,7 +106,7 @@
<div class="tsd-signature tsd-kind-icon">background<wbr>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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/settings/startup-settings.ts#L39">graphics/rendering/settings/startup-settings.ts:39</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/startup-settings.ts#L47">graphics/rendering/settings/startup-settings.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -120,7 +121,7 @@
<div class="tsd-signature tsd-kind-icon">enable<wbr>Stopwatch<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/settings/startup-settings.ts#L16">graphics/rendering/settings/startup-settings.ts:16</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/startup-settings.ts#L16">graphics/rendering/settings/startup-settings.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -137,7 +138,7 @@
<div class="tsd-signature tsd-kind-icon">ignore<wbr>WebGL2<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/settings/startup-settings.ts#L47">graphics/rendering/settings/startup-settings.ts:47</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/startup-settings.ts#L55">graphics/rendering/settings/startup-settings.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -148,13 +149,30 @@
<p>Useful for testing compatibility.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/startup-settings.ts#L33">graphics/rendering/settings/startup-settings.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The illumination is multiplied by this constant where
the distance field is negative (i.e. inside objects).</p>
</div>
<p>Should be between 0 and 1, but other values are also permitted.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/settings/startup-settings.ts#L34">graphics/rendering/settings/startup-settings.ts:34</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/startup-settings.ts#L42">graphics/rendering/settings/startup-settings.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -172,7 +190,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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/fbd85a6/src/graphics/rendering/settings/startup-settings.ts#L25">graphics/rendering/settings/startup-settings.ts:25</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/settings/startup-settings.ts#L25">graphics/rendering/settings/startup-settings.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -196,51 +214,6 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/filteringoptions.html" class="tsd-kind-icon">Filtering<wbr>Options</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/wrapoptions.html" class="tsd-kind-icon">Wrap<wbr>Options</a>
</li>
<li class=" tsd-kind-class">
<a href="../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/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/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="drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a>
</li>
<li class=" tsd-kind-interface">
<a href="noisypolygonbase.html" class="tsd-kind-icon">Noisy<wbr>Polygon<wbr>Base</a>
</li>
<li class=" tsd-kind-interface">
<a href="renderer.html" class="tsd-kind-icon">Renderer</a>
</li>
<li class=" tsd-kind-interface">
<a href="runtimesettings.html" class="tsd-kind-icon">Runtime<wbr>Settings</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
@ -255,6 +228,9 @@
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="startupsettings.html#ignorewebgl2" class="tsd-kind-icon">ignore<wbr>WebGL2</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="startupsettings.html#lightpenetrationratio" class="tsd-kind-icon">light<wbr>Penetration<wbr>Ratio</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="startupsettings.html#palettesize" class="tsd-kind-icon">palette<wbr>Size</a>
</li>
@ -265,63 +241,6 @@
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface">
<a href="textureoptions.html" class="tsd-kind-icon">Texture<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#texturewithoptions" class="tsd-kind-icon">Texture<wbr>With<wbr>Options</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#circlefactory" class="tsd-kind-icon">Circle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#dropletfactory" class="tsd-kind-icon">Droplet<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#invertedtunnelfactory" class="tsd-kind-icon">Inverted<wbr>Tunnel<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#metacirclefactory" class="tsd-kind-icon">Meta<wbr>Circle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#noisypolygonfactory" class="tsd-kind-icon">Noisy<wbr>Polygon<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#polygonfactory" class="tsd-kind-icon">Polygon<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rotatedrectanglefactory" class="tsd-kind-icon">Rotated<wbr>Rectangle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#hex" class="tsd-kind-icon">hex</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#hsl" class="tsd-kind-icon">hsl</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rendernoise" class="tsd-kind-icon">render<wbr>Noise</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgb" class="tsd-kind-icon">rgb</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgb255" class="tsd-kind-icon">rgb255</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgba" class="tsd-kind-icon">rgba</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgba255" class="tsd-kind-icon">rgba255</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#defaultruntimesettings" class="tsd-kind-icon">default<wbr>Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#defaultstartupsettings" class="tsd-kind-icon">default<wbr>Startup<wbr>Settings</a>
</li>
</ul>
</nav>
</div>

116
docs/interfaces/textureoptions.html
View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TextureOptions | SDF-2D - v0.5.3</title>
<meta name="description" content="Documentation for SDF-2D - v0.5.3">
<title>TextureOptions | 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">
@ -95,7 +95,7 @@
<div class="tsd-signature tsd-kind-icon">max<wbr>Filter<span class="tsd-signature-symbol">:</span> <a href="../enums/filteringoptions.html" class="tsd-signature-type">FilteringOptions</a></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#L24">graphics/graphics-library/texture/texture-options.ts:24</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/graphics-library/texture/texture-options.ts#L24">graphics/graphics-library/texture/texture-options.ts:24</a></li>
</ul>
</aside>
</section>
@ -105,7 +105,7 @@
<div class="tsd-signature tsd-kind-icon">min<wbr>Filter<span class="tsd-signature-symbol">:</span> <a href="../enums/filteringoptions.html" class="tsd-signature-type">FilteringOptions</a></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#L23">graphics/graphics-library/texture/texture-options.ts:23</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/graphics-library/texture/texture-options.ts#L23">graphics/graphics-library/texture/texture-options.ts:23</a></li>
</ul>
</aside>
</section>
@ -115,7 +115,7 @@
<div class="tsd-signature tsd-kind-icon">wrapS<span class="tsd-signature-symbol">:</span> <a href="../enums/wrapoptions.html" class="tsd-signature-type">WrapOptions</a></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#L21">graphics/graphics-library/texture/texture-options.ts:21</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/graphics-library/texture/texture-options.ts#L21">graphics/graphics-library/texture/texture-options.ts:21</a></li>
</ul>
</aside>
</section>
@ -125,7 +125,7 @@
<div class="tsd-signature tsd-kind-icon">wrapT<span class="tsd-signature-symbol">:</span> <a href="../enums/wrapoptions.html" class="tsd-signature-type">WrapOptions</a></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#L22">graphics/graphics-library/texture/texture-options.ts:22</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/graphics-library/texture/texture-options.ts#L22">graphics/graphics-library/texture/texture-options.ts:22</a></li>
</ul>
</aside>
</section>
@ -141,54 +141,6 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/filteringoptions.html" class="tsd-kind-icon">Filtering<wbr>Options</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/wrapoptions.html" class="tsd-kind-icon">Wrap<wbr>Options</a>
</li>
<li class=" tsd-kind-class">
<a href="../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/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/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="drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a>
</li>
<li class=" tsd-kind-interface">
<a href="noisypolygonbase.html" class="tsd-kind-icon">Noisy<wbr>Polygon<wbr>Base</a>
</li>
<li class=" tsd-kind-interface">
<a href="renderer.html" class="tsd-kind-icon">Renderer</a>
</li>
<li class=" tsd-kind-interface">
<a href="runtimesettings.html" class="tsd-kind-icon">Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
@ -210,60 +162,6 @@
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias">
<a href="../globals.html#texturewithoptions" class="tsd-kind-icon">Texture<wbr>With<wbr>Options</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#circlefactory" class="tsd-kind-icon">Circle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#dropletfactory" class="tsd-kind-icon">Droplet<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#invertedtunnelfactory" class="tsd-kind-icon">Inverted<wbr>Tunnel<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#metacirclefactory" class="tsd-kind-icon">Meta<wbr>Circle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#noisypolygonfactory" class="tsd-kind-icon">Noisy<wbr>Polygon<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#polygonfactory" class="tsd-kind-icon">Polygon<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rotatedrectanglefactory" class="tsd-kind-icon">Rotated<wbr>Rectangle<wbr>Factory</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#hex" class="tsd-kind-icon">hex</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#hsl" class="tsd-kind-icon">hsl</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rendernoise" class="tsd-kind-icon">render<wbr>Noise</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgb" class="tsd-kind-icon">rgb</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgb255" class="tsd-kind-icon">rgb255</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgba" class="tsd-kind-icon">rgba</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rgba255" class="tsd-kind-icon">rgba255</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#defaultruntimesettings" class="tsd-kind-icon">default<wbr>Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#defaultstartupsettings" class="tsd-kind-icon">default<wbr>Startup<wbr>Settings</a>
</li>
</ul>
</nav>
</div>