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

Finish documentation

Browse source
This commit is contained in:
schmelczerandras 2020-09-28 16:26:55 +02:00
parent 49473bf905
commit 31fcfd3d6b
86 changed files with 1383 additions and 8485 deletions
Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -22,6 +22,7 @@ A graphics library to enable the real-time rendering of 2D signed distance field
- Has built-in quality autoscaling - Has built-in quality autoscaling
- Requires no boilerplate code - Requires no boilerplate code
- Automatic detection of WebGL and its extensions is provided - Automatic detection of WebGL and its extensions is provided
- Parallel, non-blocking shader compiling
- Context lost is handled with automatic restoration - Context lost is handled with automatic restoration
- Can be used without thinking of the GPU _(although for stunning results it, should be kept in mind)_ - Can be used without thinking of the GPU _(although for stunning results it, should be kept in mind)_
@ -31,8 +32,6 @@ A graphics library to enable the real-time rendering of 2D signed distance field
## Install ## Install
> The package is available on NPM, at [npmjs.com/package/sdf-2d](https://www.npmjs.com/package/sdf-2d)
```sh ```sh
npm install sdf-2d --save-dev npm install sdf-2d --save-dev
``` ```

49
docs-source/README.md
View file

@ -1,49 +0,0 @@
# ![SDF-2D logo](media/logo-colored.svg) Documentation
Background and more in depth information about the rendring techniques can be found in [this technical report](media/sdf-2d.pdf).
## Links
- [Repository](https://github.com/schmelczerandras/sdf-2d)
- [Demo](https://sdf2d.schmelczer.dev/)
- [Minimal example](https://github.com/schmelczerandras/sdf-2d-minimal-example)
- [More complex example](https://github.com/schmelczerandras/sdf-2d-minimal-example)
## Important to know
### Coordinates
Anywhere, where positions need to specified, the `y` values grow upwards, so are the `x` values. That means, when specifying the view area, the origin is at the bottom left corner of the display.
### Tile-based rendering
For optimising the evaluation of the distance field, the display is divided up into a grid of tiles. The shader for each tile is compiled to support a fix maximum number of objects on it. When using the built-in drawables, it is possible that after a certain number of on-screen objects, new ones won't be visible.
Mitigating this issue is quite easy. Instead of the following code:
```js
this.renderer = await compile(canvas, [Circle.descriptor, CircleLight.descriptor]);
```
Modify it to something similar:
```js
this.renderer = await compile(canvas, [
{
...Circle.descriptor,
shaderCombinationSteps: [0, 1, 2, 24, 64],
},
{
...CircleLight.descriptor,
shaderCombinationSteps: [0, 1, 2, 4],
},
]);
```
The usage of too large numbers is not advised for compatibility and performance reasons alike.
> Steps are very useful for tile-based rendering, because it is possible for one tile (at a given moment) to be empty or contain just a few objects, while others have a large cluster of objects. The compiled shaders only take into account the necesseary number of objects on each tiles.
## Usage
To start using cutting-edge 2D graphics, first you have get a renderer instance. This is possible by calling the [compile function](globals.html#compile).

1
docs/_config.yml
View file

@ -1 +0,0 @@
theme: jekyll-theme-minimal

2
docs/assets/js/search.json
View file

File diff suppressed because one or more lines are too long

89
docs/classes/circle.html
View file

@ -3,8 +3,8 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Circle | SDF-2D - v0.3.1</title> <title>Circle | SDF-2D - v0.3.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1"> <meta name="description" content="Documentation for SDF-2D - v0.3.2">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/css/main.css">
</head> </head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li> <li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li> <li class="state failure">The search index is not available</li>
</ul> </ul>
<a href="../index.html" class="title">SDF-2D - v0.3.1</a> <a href="../index.html" class="title">SDF-2D - v0.3.2</a>
</div> </div>
<div class="table-cell" id="tsd-widgets"> <div class="table-cell" id="tsd-widgets">
<div id="tsd-filter"> <div id="tsd-filter">
@ -62,6 +62,10 @@
<div class="container container-main"> <div class="container container-main">
<div class="row"> <div class="row">
<div class="col-8 col-content"> <div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-hierarchy"> <section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3> <h3>Hierarchy</h3>
<ul class="tsd-hierarchy"> <ul class="tsd-hierarchy">
@ -121,7 +125,7 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L32">drawables/shapes/circle.ts:32</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L35">drawables/shapes/circle.ts:35</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -146,7 +150,7 @@
<div class="tsd-signature tsd-kind-icon">center<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div> <div class="tsd-signature tsd-kind-icon">center<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L34">drawables/shapes/circle.ts:34</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L37">drawables/shapes/circle.ts:37</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -156,7 +160,7 @@
<div class="tsd-signature tsd-kind-icon">radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <div class="tsd-signature tsd-kind-icon">radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L34">drawables/shapes/circle.ts:34</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L37">drawables/shapes/circle.ts:37</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -174,7 +178,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#getobjecttoserialize">getObjectToSerialize</a></p> <p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#getobjecttoserialize">getObjectToSerialize</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L42">drawables/shapes/circle.ts:42</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L45">drawables/shapes/circle.ts:45</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -201,7 +205,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#mindistance">minDistance</a></p> <p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#mindistance">minDistance</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L38">drawables/shapes/circle.ts:38</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L41">drawables/shapes/circle.ts:41</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -225,7 +229,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="drawable.html">Drawable</a>.<a href="drawable.html#serializetouniforms">serializeToUniforms</a></p> <p>Inherited from <a href="drawable.html">Drawable</a>.<a href="drawable.html#serializetouniforms">serializeToUniforms</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable.ts#L11">drawables/drawable.ts:11</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable.ts#L36">drawables/drawable.ts:36</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -254,7 +258,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#descriptor">descriptor</a></p> <p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#descriptor">descriptor</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L6">drawables/shapes/circle.ts:6</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L9">drawables/shapes/circle.ts:9</a></li>
</ul> </ul>
</aside> </aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -263,7 +267,7 @@
<div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="circle.html" class="tsd-signature-type">Circle</a><span class="tsd-signature-symbol"> = new Circle(vec2.fromValues(0, 0), 0)</span></div> <div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="circle.html" class="tsd-signature-type">Circle</a><span class="tsd-signature-symbol"> = new Circle(vec2.fromValues(0, 0), 0)</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L31">drawables/shapes/circle.ts:31</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L34">drawables/shapes/circle.ts:34</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -273,7 +277,7 @@
<div class="tsd-signature tsd-kind-icon">shader<wbr>Combination<wbr>Steps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [0, 1, 2, 3, 8, 16]</span></div> <div class="tsd-signature tsd-kind-icon">shader<wbr>Combination<wbr>Steps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [0, 1, 2, 3, 8, 16]</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L30">drawables/shapes/circle.ts:30</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L33">drawables/shapes/circle.ts:33</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -283,7 +287,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><span class="tsd-signature-symbol"> = &quot;CIRCLE_COUNT&quot;</span></div> <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><span class="tsd-signature-symbol"> = &quot;CIRCLE_COUNT&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L29">drawables/shapes/circle.ts:29</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L32">drawables/shapes/circle.ts:32</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -293,7 +297,7 @@
<div class="tsd-signature tsd-kind-icon">property<wbr>Uniform<wbr>Mapping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <div class="tsd-signature tsd-kind-icon">property<wbr>Uniform<wbr>Mapping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L25">drawables/shapes/circle.ts:25</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L28">drawables/shapes/circle.ts:28</a></li>
</ul> </ul>
</aside> </aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -302,7 +306,7 @@
<div class="tsd-signature tsd-kind-icon">center<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;circleCenters&quot;</span></div> <div class="tsd-signature tsd-kind-icon">center<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;circleCenters&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L26">drawables/shapes/circle.ts:26</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L29">drawables/shapes/circle.ts:29</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -312,7 +316,7 @@
<div class="tsd-signature tsd-kind-icon">radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;circleRadii&quot;</span></div> <div class="tsd-signature tsd-kind-icon">radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;circleRadii&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L27">drawables/shapes/circle.ts:27</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L30">drawables/shapes/circle.ts:30</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -323,7 +327,7 @@
<div class="tsd-signature tsd-kind-icon">sdf<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <div class="tsd-signature tsd-kind-icon">sdf<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L7">drawables/shapes/circle.ts:7</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L10">drawables/shapes/circle.ts:10</a></li>
</ul> </ul>
</aside> </aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -332,7 +336,7 @@
<div class="tsd-signature tsd-kind-icon">distance<wbr>Function<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;circleMinDistance&quot;</span></div> <div class="tsd-signature tsd-kind-icon">distance<wbr>Function<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;circleMinDistance&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L23">drawables/shapes/circle.ts:23</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L26">drawables/shapes/circle.ts:26</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -342,7 +346,7 @@
<div class="tsd-signature tsd-kind-icon">shader<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x60;uniform vec2 circleCenters[CIRCLE_COUNT];uniform float circleRadii[CIRCLE_COUNT];float circleMinDistance(vec2 target, out float colorIndex) {colorIndex &#x3D; 2.0;float minDistance &#x3D; 1000.0;for (int i &#x3D; 0; i &lt; CIRCLE_COUNT; i++) {float dist &#x3D; distance(circleCenters[i], target) - circleRadii[i];minDistance &#x3D; min(minDistance, dist);}return minDistance;}&#x60;</span></div> <div class="tsd-signature tsd-kind-icon">shader<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x60;uniform vec2 circleCenters[CIRCLE_COUNT];uniform float circleRadii[CIRCLE_COUNT];float circleMinDistance(vec2 target, out float colorIndex) {colorIndex &#x3D; 2.0;float minDistance &#x3D; 1000.0;for (int i &#x3D; 0; i &lt; CIRCLE_COUNT; i++) {float dist &#x3D; distance(circleCenters[i], target) - circleRadii[i];minDistance &#x3D; min(minDistance, dist);}return minDistance;}&#x60;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/circle.ts#L8">drawables/shapes/circle.ts:8</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/circle.ts#L11">drawables/shapes/circle.ts:11</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -390,6 +394,42 @@
</li> </li>
</ul> </ul>
<ul class="after-current"> <ul class="after-current">
<li class=" tsd-kind-class">
<a href="circlelight.html" class="tsd-kind-icon">Circle<wbr>Light</a>
</li>
<li class=" tsd-kind-class">
<a href="drawable.html" class="tsd-kind-icon">Drawable</a>
</li>
<li class=" tsd-kind-class">
<a href="flashlight.html" class="tsd-kind-icon">Flashlight</a>
</li>
<li class=" tsd-kind-class">
<a href="invertedtunnel.html" class="tsd-kind-icon">Inverted<wbr>Tunnel</a>
</li>
<li class=" tsd-kind-class">
<a href="tunnel.html" class="tsd-kind-icon">Tunnel</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/renderer.html" class="tsd-kind-icon">Renderer</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/runtimesettings.html" class="tsd-kind-icon">Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</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> </ul>
</nav> </nav>
</div> </div>
@ -404,22 +444,19 @@
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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"> <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-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> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <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> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <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> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul> </ul>
</div> </div>
</div> </div>

97
docs/classes/circlelight.html
View file

@ -3,8 +3,8 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>CircleLight | SDF-2D - v0.3.1</title> <title>CircleLight | SDF-2D - v0.3.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1"> <meta name="description" content="Documentation for SDF-2D - v0.3.2">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/css/main.css">
</head> </head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li> <li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li> <li class="state failure">The search index is not available</li>
</ul> </ul>
<a href="../index.html" class="title">SDF-2D - v0.3.1</a> <a href="../index.html" class="title">SDF-2D - v0.3.2</a>
</div> </div>
<div class="table-cell" id="tsd-widgets"> <div class="table-cell" id="tsd-widgets">
<div id="tsd-filter"> <div id="tsd-filter">
@ -62,11 +62,15 @@
<div class="container container-main"> <div class="container container-main">
<div class="row"> <div class="row">
<div class="col-8 col-content"> <div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-hierarchy"> <section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3> <h3>Hierarchy</h3>
<ul class="tsd-hierarchy"> <ul class="tsd-hierarchy">
<li> <li>
<a href="lightdrawable.html" class="tsd-signature-type">LightDrawable</a> <span class="tsd-signature-type">LightDrawable</span>
<ul class="tsd-hierarchy"> <ul class="tsd-hierarchy">
<li> <li>
<span class="target">CircleLight</span> <span class="target">CircleLight</span>
@ -123,9 +127,9 @@
<ul class="tsd-descriptions"> <ul class="tsd-descriptions">
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Overrides <a href="lightdrawable.html">LightDrawable</a>.<a href="lightdrawable.html#constructor">constructor</a></p> <p>Overrides LightDrawable.__constructor</p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/circle-light.ts#L15">drawables/lights/circle-light.ts:15</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/circle-light.ts#L18">drawables/lights/circle-light.ts:18</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -154,7 +158,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#center">center</a></p> <p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#center">center</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L7">drawables/lights/light-drawable.ts:7</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -165,7 +169,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#color">color</a></p> <p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#color">color</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L7">drawables/lights/light-drawable.ts:7</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -176,7 +180,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#intensity">intensity</a></p> <p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#intensity">intensity</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L7">drawables/lights/light-drawable.ts:7</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -187,7 +191,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#lightnessratio">lightnessRatio</a></p> <p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#lightnessratio">lightnessRatio</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L5">drawables/lights/light-drawable.ts:5</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L6">drawables/lights/light-drawable.ts:6</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -203,10 +207,10 @@
<ul class="tsd-descriptions"> <ul class="tsd-descriptions">
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="lightdrawable.html">LightDrawable</a>.<a href="lightdrawable.html#getobjecttoserialize">getObjectToSerialize</a></p> <p>Inherited from LightDrawable.getObjectToSerialize</p>
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#getobjecttoserialize">getObjectToSerialize</a></p> <p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#getobjecttoserialize">getObjectToSerialize</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L19">drawables/lights/light-drawable.ts:19</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L20">drawables/lights/light-drawable.ts:20</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -234,7 +238,7 @@
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#mindistance">minDistance</a></p> <p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#mindistance">minDistance</a></p>
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#mindistance">minDistance</a></p> <p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#mindistance">minDistance</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L15">drawables/lights/light-drawable.ts:15</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L16">drawables/lights/light-drawable.ts:16</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -258,7 +262,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="drawable.html">Drawable</a>.<a href="drawable.html#serializetouniforms">serializeToUniforms</a></p> <p>Inherited from <a href="drawable.html">Drawable</a>.<a href="drawable.html#serializetouniforms">serializeToUniforms</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable.ts#L11">drawables/drawable.ts:11</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable.ts#L36">drawables/drawable.ts:36</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -288,7 +292,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#setlightnessratio">setLightnessRatio</a></p> <p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#setlightnessratio">setLightnessRatio</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L11">drawables/lights/light-drawable.ts:11</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L12">drawables/lights/light-drawable.ts:12</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -311,7 +315,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#descriptor">descriptor</a></p> <p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#descriptor">descriptor</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/circle-light.ts#L6">drawables/lights/circle-light.ts:6</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/circle-light.ts#L9">drawables/lights/circle-light.ts:9</a></li>
</ul> </ul>
</aside> </aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -320,7 +324,7 @@
<div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="circlelight.html" class="tsd-signature-type">CircleLight</a><span class="tsd-signature-symbol"> = new CircleLight(vec2.fromValues(0, 0), vec3.fromValues(0, 0, 0), 0)</span></div> <div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="circlelight.html" class="tsd-signature-type">CircleLight</a><span class="tsd-signature-symbol"> = new CircleLight(vec2.fromValues(0, 0), vec3.fromValues(0, 0, 0), 0)</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/circle-light.ts#L14">drawables/lights/circle-light.ts:14</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/circle-light.ts#L17">drawables/lights/circle-light.ts:17</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -330,7 +334,7 @@
<div class="tsd-signature tsd-kind-icon">shader<wbr>Combination<wbr>Steps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [0, 1, 2, 4, 8, 16]</span></div> <div class="tsd-signature tsd-kind-icon">shader<wbr>Combination<wbr>Steps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [0, 1, 2, 4, 8, 16]</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/circle-light.ts#L13">drawables/lights/circle-light.ts:13</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/circle-light.ts#L16">drawables/lights/circle-light.ts:16</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -340,7 +344,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><span class="tsd-signature-symbol"> = &quot;CIRCLE_LIGHT_COUNT&quot;</span></div> <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><span class="tsd-signature-symbol"> = &quot;CIRCLE_LIGHT_COUNT&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/circle-light.ts#L12">drawables/lights/circle-light.ts:12</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/circle-light.ts#L15">drawables/lights/circle-light.ts:15</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -350,7 +354,7 @@
<div class="tsd-signature tsd-kind-icon">property<wbr>Uniform<wbr>Mapping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <div class="tsd-signature tsd-kind-icon">property<wbr>Uniform<wbr>Mapping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/circle-light.ts#L7">drawables/lights/circle-light.ts:7</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/circle-light.ts#L10">drawables/lights/circle-light.ts:10</a></li>
</ul> </ul>
</aside> </aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -359,7 +363,7 @@
<div class="tsd-signature tsd-kind-icon">center<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;circleLightCenters&quot;</span></div> <div class="tsd-signature tsd-kind-icon">center<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;circleLightCenters&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/circle-light.ts#L8">drawables/lights/circle-light.ts:8</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/circle-light.ts#L11">drawables/lights/circle-light.ts:11</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -369,7 +373,7 @@
<div class="tsd-signature tsd-kind-icon">color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;circleLightColors&quot;</span></div> <div class="tsd-signature tsd-kind-icon">color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;circleLightColors&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/circle-light.ts#L9">drawables/lights/circle-light.ts:9</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/circle-light.ts#L12">drawables/lights/circle-light.ts:12</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -379,7 +383,7 @@
<div class="tsd-signature tsd-kind-icon">intensity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;circleLightIntensities&quot;</span></div> <div class="tsd-signature tsd-kind-icon">intensity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;circleLightIntensities&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/circle-light.ts#L10">drawables/lights/circle-light.ts:10</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/circle-light.ts#L13">drawables/lights/circle-light.ts:13</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -397,6 +401,9 @@
</nav> </nav>
<nav class="tsd-navigation secondary menu-sticky"> <nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current"> <ul class="before-current">
<li class=" tsd-kind-class">
<a href="circle.html" class="tsd-kind-icon">Circle</a>
</li>
</ul> </ul>
<ul class="current"> <ul class="current">
<li class="current tsd-kind-class"> <li class="current tsd-kind-class">
@ -436,6 +443,39 @@
</li> </li>
</ul> </ul>
<ul class="after-current"> <ul class="after-current">
<li class=" tsd-kind-class">
<a href="drawable.html" class="tsd-kind-icon">Drawable</a>
</li>
<li class=" tsd-kind-class">
<a href="flashlight.html" class="tsd-kind-icon">Flashlight</a>
</li>
<li class=" tsd-kind-class">
<a href="invertedtunnel.html" class="tsd-kind-icon">Inverted<wbr>Tunnel</a>
</li>
<li class=" tsd-kind-class">
<a href="tunnel.html" class="tsd-kind-icon">Tunnel</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/renderer.html" class="tsd-kind-icon">Renderer</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/runtimesettings.html" class="tsd-kind-icon">Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</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> </ul>
</nav> </nav>
</div> </div>
@ -450,22 +490,19 @@
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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"> <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-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> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <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> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <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> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul> </ul>
</div> </div>
</div> </div>

442
docs/classes/contextawarerenderer.html
View file

@ -1,442 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ContextAwareRenderer | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="contextawarerenderer.html">ContextAwareRenderer</a>
</li>
</ul>
<h1>Class ContextAwareRenderer</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">ContextAwareRenderer</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/renderer.html" class="tsd-signature-type">Renderer</a></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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="contextawarerenderer.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="contextawarerenderer.html#canvassize" class="tsd-kind-icon">canvas<wbr>Size</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="contextawarerenderer.html#initializedpromise" class="tsd-kind-icon">initialized<wbr>Promise</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="contextawarerenderer.html#insights" class="tsd-kind-icon">insights</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="contextawarerenderer.html#viewareasize" class="tsd-kind-icon">view<wbr>Area<wbr>Size</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="contextawarerenderer.html#adddrawable" class="tsd-kind-icon">add<wbr>Drawable</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="contextawarerenderer.html#autoscalequality" class="tsd-kind-icon">autoscale<wbr>Quality</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="contextawarerenderer.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="contextawarerenderer.html#renderdrawables" class="tsd-kind-icon">render<wbr>Drawables</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="contextawarerenderer.html#setruntimesettings" class="tsd-kind-icon">set<wbr>Runtime<wbr>Settings</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="contextawarerenderer.html#setviewarea" class="tsd-kind-icon">set<wbr>View<wbr>Area</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Context<wbr>Aware<wbr>Renderer<span class="tsd-signature-symbol">(</span>canvas<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLCanvasElement</span>, descriptors<span class="tsd-signature-symbol">: </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span>, settingsOverrides<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/startupsettings.html" class="tsd-signature-type">StartupSettings</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="contextawarerenderer.html" class="tsd-signature-type">ContextAwareRenderer</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/context-aware-renderer.ts#L18">graphics/rendering/renderer/context-aware-renderer.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>canvas: <span class="tsd-signature-type">HTMLCanvasElement</span></h5>
</li>
<li>
<h5>descriptors: <a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>settingsOverrides: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/startupsettings.html" class="tsd-signature-type">StartupSettings</a><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="contextawarerenderer.html" class="tsd-signature-type">ContextAwareRenderer</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="canvassize" class="tsd-anchor"></a>
<h3>canvas<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> canvasSize<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/rendering/renderer/context-aware-renderer.ts#L102">graphics/rendering/renderer/context-aware-renderer.ts:102</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec2</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="initializedpromise" class="tsd-anchor"></a>
<h3>initialized<wbr>Promise</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> initializedPromise<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/context-aware-renderer.ts#L34">graphics/rendering/renderer/context-aware-renderer.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="insights" class="tsd-anchor"></a>
<h3>insights</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> insights<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/48490b3/src/graphics/rendering/renderer/context-aware-renderer.ts#L110">graphics/rendering/renderer/context-aware-renderer.ts:110</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="viewareasize" class="tsd-anchor"></a>
<h3>view<wbr>Area<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> viewAreaSize<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/rendering/renderer/context-aware-renderer.ts#L106">graphics/rendering/renderer/context-aware-renderer.ts:106</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec2</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="adddrawable" class="tsd-anchor"></a>
<h3>add<wbr>Drawable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Drawable<span class="tsd-signature-symbol">(</span>drawable<span class="tsd-signature-symbol">: </span><a href="drawable.html" class="tsd-signature-type">Drawable</a><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">
<p>Implementation of <a href="../interfaces/renderer.html">Renderer</a>.<a href="../interfaces/renderer.html#adddrawable">addDrawable</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/context-aware-renderer.ts#L129">graphics/rendering/renderer/context-aware-renderer.ts:129</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>drawable: <a href="drawable.html" class="tsd-signature-type">Drawable</a></h5>
</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-class">
<a name="autoscalequality" class="tsd-anchor"></a>
<h3>autoscale<wbr>Quality</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<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">number</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/48490b3/src/graphics/rendering/renderer/context-aware-renderer.ts#L133">graphics/rendering/renderer/context-aware-renderer.ts:133</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>deltaTime: <span class="tsd-signature-type">number</span></h5>
</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-class">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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">
<p>Implementation of <a href="../interfaces/renderer.html">Renderer</a>.<a href="../interfaces/renderer.html#destroy">destroy</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/context-aware-renderer.ts#L141">graphics/rendering/renderer/context-aware-renderer.ts:141</a></li>
</ul>
</aside>
<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-class">
<a name="renderdrawables" class="tsd-anchor"></a>
<h3>render<wbr>Drawables</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">render<wbr>Drawables<span class="tsd-signature-symbol">(</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">
<p>Implementation of <a href="../interfaces/renderer.html">Renderer</a>.<a href="../interfaces/renderer.html#renderdrawables">renderDrawables</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/context-aware-renderer.ts#L137">graphics/rendering/renderer/context-aware-renderer.ts:137</a></li>
</ul>
</aside>
<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-class">
<a name="setruntimesettings" class="tsd-anchor"></a>
<h3>set<wbr>Runtime<wbr>Settings</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Runtime<wbr>Settings<span class="tsd-signature-symbol">(</span>overrides<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/runtimesettings.html" class="tsd-signature-type">RuntimeSettings</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/renderer.html">Renderer</a>.<a href="../interfaces/renderer.html#setruntimesettings">setRuntimeSettings</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/context-aware-renderer.ts#L120">graphics/rendering/renderer/context-aware-renderer.ts:120</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>overrides: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/runtimesettings.html" class="tsd-signature-type">RuntimeSettings</a><span class="tsd-signature-symbol">&gt;</span></h5>
</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-class">
<a name="setviewarea" class="tsd-anchor"></a>
<h3>set<wbr>View<wbr>Area</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>View<wbr>Area<span class="tsd-signature-symbol">(</span>topLeft<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</span>, size<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/renderer.html">Renderer</a>.<a href="../interfaces/renderer.html#setviewarea">setViewArea</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/context-aware-renderer.ts#L114">graphics/rendering/renderer/context-aware-renderer.ts:114</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>topLeft: <span class="tsd-signature-type">vec2</span></h5>
</li>
<li>
<h5>size: <span class="tsd-signature-type">vec2</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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-class">
<a href="contextawarerenderer.html" class="tsd-kind-icon">Context<wbr>Aware<wbr>Renderer</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="contextawarerenderer.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="contextawarerenderer.html#canvassize" class="tsd-kind-icon">canvas<wbr>Size</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="contextawarerenderer.html#initializedpromise" class="tsd-kind-icon">initialized<wbr>Promise</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="contextawarerenderer.html#insights" class="tsd-kind-icon">insights</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="contextawarerenderer.html#viewareasize" class="tsd-kind-icon">view<wbr>Area<wbr>Size</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="contextawarerenderer.html#adddrawable" class="tsd-kind-icon">add<wbr>Drawable</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="contextawarerenderer.html#autoscalequality" class="tsd-kind-icon">autoscale<wbr>Quality</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="contextawarerenderer.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="contextawarerenderer.html#renderdrawables" class="tsd-kind-icon">render<wbr>Drawables</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="contextawarerenderer.html#setruntimesettings" class="tsd-kind-icon">set<wbr>Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="contextawarerenderer.html#setviewarea" class="tsd-kind-icon">set<wbr>View<wbr>Area</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

363
docs/classes/defaultframebuffer.html
View file

@ -1,363 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DefaultFrameBuffer | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="defaultframebuffer.html">DefaultFrameBuffer</a>
</li>
</ul>
<h1>Class DefaultFrameBuffer</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>
<a href="framebuffer.html" class="tsd-signature-type">FrameBuffer</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">DefaultFrameBuffer</span>
</li>
</ul>
</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="defaultframebuffer.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="defaultframebuffer.html#enablehighdpirendering" class="tsd-kind-icon">enable<wbr>High<wbr>Dpi<wbr>Rendering</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="defaultframebuffer.html#framebuffer" class="tsd-kind-icon">frame<wbr>Buffer</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="defaultframebuffer.html#gl" class="tsd-kind-icon">gl</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="defaultframebuffer.html#renderscale" class="tsd-kind-icon">render<wbr>Scale</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="defaultframebuffer.html#size" class="tsd-kind-icon">size</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="defaultframebuffer.html#bindandclear" class="tsd-kind-icon">bind<wbr>And<wbr>Clear</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="defaultframebuffer.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="defaultframebuffer.html#getsize" class="tsd-kind-icon">get<wbr>Size</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="defaultframebuffer.html#setsize" class="tsd-kind-icon">set<wbr>Size</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Default<wbr>Frame<wbr>Buffer<span class="tsd-signature-symbol">(</span>gl<span class="tsd-signature-symbol">: </span><a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="defaultframebuffer.html" class="tsd-signature-type">DefaultFrameBuffer</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/default-frame-buffer.ts#L4">graphics/graphics-library/frame-buffer/default-frame-buffer.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>gl: <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="defaultframebuffer.html" class="tsd-signature-type">DefaultFrameBuffer</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<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><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#enablehighdpirendering">enableHighDpiRendering</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L6">graphics/graphics-library/frame-buffer/frame-buffer.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="framebuffer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> frame<wbr>Buffer</h3>
<div class="tsd-signature tsd-kind-icon">frame<wbr>Buffer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WebGLFramebuffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#framebuffer-1">frameBuffer</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L11">graphics/graphics-library/frame-buffer/frame-buffer.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="gl" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> gl</h3>
<div class="tsd-signature tsd-kind-icon">gl<span class="tsd-signature-symbol">:</span> <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#gl">gl</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L13">graphics/graphics-library/frame-buffer/frame-buffer.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="renderscale" class="tsd-anchor"></a>
<h3>render<wbr>Scale</h3>
<div class="tsd-signature tsd-kind-icon">render<wbr>Scale<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#renderscale">renderScale</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L5">graphics/graphics-library/frame-buffer/frame-buffer.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="size" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> size</h3>
<div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol"> = vec2.create()</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#size">size</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L8">graphics/graphics-library/frame-buffer/frame-buffer.ts:8</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="bindandclear" class="tsd-anchor"></a>
<h3>bind<wbr>And<wbr>Clear</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">bind<wbr>And<wbr>Clear<span class="tsd-signature-symbol">(</span>inputTextures<span class="tsd-signature-symbol">: </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">WebGLTexture</span><span class="tsd-signature-symbol">&gt;</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">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#bindandclear">bindAndClear</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L15">graphics/graphics-library/frame-buffer/frame-buffer.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>inputTextures: <a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">WebGLTexture</span><span class="tsd-signature-symbol">&gt;</span></h5>
</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-class tsd-is-inherited">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#destroy">destroy</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L26">graphics/graphics-library/frame-buffer/frame-buffer.ts:26</a></li>
</ul>
</aside>
<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-class tsd-is-inherited">
<a name="getsize" class="tsd-anchor"></a>
<h3>get<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Size<span class="tsd-signature-symbol">(</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">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#getsize">getSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L46">graphics/graphics-library/frame-buffer/frame-buffer.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec2</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="setsize" class="tsd-anchor"></a>
<h3>set<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">set<wbr>Size<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#setsize">setSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/default-frame-buffer.ts#L11">graphics/graphics-library/frame-buffer/default-frame-buffer.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</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-class">
<a href="defaultframebuffer.html" class="tsd-kind-icon">Default<wbr>Frame<wbr>Buffer</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="defaultframebuffer.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="defaultframebuffer.html#enablehighdpirendering" class="tsd-kind-icon">enable<wbr>High<wbr>Dpi<wbr>Rendering</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="defaultframebuffer.html#framebuffer" class="tsd-kind-icon">frame<wbr>Buffer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="defaultframebuffer.html#gl" class="tsd-kind-icon">gl</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="defaultframebuffer.html#renderscale" class="tsd-kind-icon">render<wbr>Scale</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="defaultframebuffer.html#size" class="tsd-kind-icon">size</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="defaultframebuffer.html#bindandclear" class="tsd-kind-icon">bind<wbr>And<wbr>Clear</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="defaultframebuffer.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="defaultframebuffer.html#getsize" class="tsd-kind-icon">get<wbr>Size</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="defaultframebuffer.html#setsize" class="tsd-kind-icon">set<wbr>Size</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

377
docs/classes/distancerenderpass.html
View file

@ -1,377 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DistanceRenderPass | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="distancerenderpass.html">DistanceRenderPass</a>
</li>
</ul>
<h1>Class DistanceRenderPass</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>
<a href="renderpass.html" class="tsd-signature-type">RenderPass</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">DistanceRenderPass</span>
</li>
</ul>
</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 tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="distancerenderpass.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="distancerenderpass.html#frame" class="tsd-kind-icon">frame</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="distancerenderpass.html#isworldinverted" class="tsd-kind-icon">is<wbr>World<wbr>Inverted</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="distancerenderpass.html#program" class="tsd-kind-icon">program</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="distancerenderpass.html#tilemultiplier" class="tsd-kind-icon">tile<wbr>Multiplier</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="distancerenderpass.html#adddrawable" class="tsd-kind-icon">add<wbr>Drawable</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="distancerenderpass.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="distancerenderpass.html#initialize" class="tsd-kind-icon">initialize</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="distancerenderpass.html#render" class="tsd-kind-icon">render</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Distance<wbr>Render<wbr>Pass<span class="tsd-signature-symbol">(</span>gl<span class="tsd-signature-symbol">: </span><a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a>, frame<span class="tsd-signature-symbol">: </span><a href="framebuffer.html" class="tsd-signature-type">FrameBuffer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="distancerenderpass.html" class="tsd-signature-type">DistanceRenderPass</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="renderpass.html">RenderPass</a>.<a href="renderpass.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L8">graphics/rendering/render-pass/render-pass.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>gl: <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></h5>
</li>
<li>
<h5>frame: <a href="framebuffer.html" class="tsd-signature-type">FrameBuffer</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="distancerenderpass.html" class="tsd-signature-type">DistanceRenderPass</a></h4>
</li>
</ul>
</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-class tsd-is-inherited tsd-is-protected">
<a name="frame" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> frame</h3>
<div class="tsd-signature tsd-kind-icon">frame<span class="tsd-signature-symbol">:</span> <a href="framebuffer.html" class="tsd-signature-type">FrameBuffer</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="renderpass.html">RenderPass</a>.<a href="renderpass.html#frame">frame</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L10">graphics/rendering/render-pass/render-pass.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="isworldinverted" class="tsd-anchor"></a>
<h3>is<wbr>World<wbr>Inverted</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>World<wbr>Inverted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/distance-render-pass.ts#L8">graphics/rendering/render-pass/distance-render-pass.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="program" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> program</h3>
<div class="tsd-signature tsd-kind-icon">program<span class="tsd-signature-symbol">:</span> <a href="uniformarrayautoscalingprogram.html" class="tsd-signature-type">UniformArrayAutoScalingProgram</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="renderpass.html">RenderPass</a>.<a href="renderpass.html#program">program</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L8">graphics/rendering/render-pass/render-pass.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="tilemultiplier" class="tsd-anchor"></a>
<h3>tile<wbr>Multiplier</h3>
<div class="tsd-signature tsd-kind-icon">tile<wbr>Multiplier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 8</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/distance-render-pass.ts#L7">graphics/rendering/render-pass/distance-render-pass.ts:7</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="adddrawable" class="tsd-anchor"></a>
<h3>add<wbr>Drawable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Drawable<span class="tsd-signature-symbol">(</span>drawable<span class="tsd-signature-symbol">: </span><a href="drawable.html" class="tsd-signature-type">Drawable</a><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/48490b3/src/graphics/rendering/render-pass/distance-render-pass.ts#L12">graphics/rendering/render-pass/distance-render-pass.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>drawable: <a href="drawable.html" class="tsd-signature-type">Drawable</a></h5>
</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-class tsd-is-inherited">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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">
<p>Inherited from <a href="renderpass.html">RenderPass</a>.<a href="renderpass.html#destroy">destroy</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L25">graphics/rendering/render-pass/render-pass.ts:25</a></li>
</ul>
</aside>
<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-class tsd-is-inherited">
<a name="initialize" class="tsd-anchor"></a>
<h3>initialize</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">initialize<span class="tsd-signature-symbol">(</span>shaderSources<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span>, descriptors<span class="tsd-signature-symbol">: </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span>, substitutions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span>, compiler<span class="tsd-signature-symbol">: </span><a href="parallelcompiler.html" class="tsd-signature-type">ParallelCompiler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="renderpass.html">RenderPass</a>.<a href="renderpass.html#initialize">initialize</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L14">graphics/rendering/render-pass/render-pass.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>shaderSources: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></h5>
</li>
<li>
<h5>descriptors: <a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> substitutions: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></h5>
<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">any</span></h5>
</li>
</ul>
</li>
<li>
<h5>compiler: <a href="parallelcompiler.html" class="tsd-signature-type">ParallelCompiler</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="render" class="tsd-anchor"></a>
<h3>render</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">render<span class="tsd-signature-symbol">(</span>commonUniforms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, <span class="tsd-signature-symbol">...</span>inputTextures<span class="tsd-signature-symbol">: </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">WebGLTexture</span><span class="tsd-signature-symbol">&gt;</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">
<p>Overrides <a href="renderpass.html">RenderPass</a>.<a href="renderpass.html#render">render</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/distance-render-pass.ts#L16">graphics/rendering/render-pass/distance-render-pass.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>commonUniforms: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>inputTextures: <a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">WebGLTexture</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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-class">
<a href="distancerenderpass.html" class="tsd-kind-icon">Distance<wbr>Render<wbr>Pass</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="distancerenderpass.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="distancerenderpass.html#frame" class="tsd-kind-icon">frame</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="distancerenderpass.html#isworldinverted" class="tsd-kind-icon">is<wbr>World<wbr>Inverted</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="distancerenderpass.html#program" class="tsd-kind-icon">program</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="distancerenderpass.html#tilemultiplier" class="tsd-kind-icon">tile<wbr>Multiplier</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="distancerenderpass.html#adddrawable" class="tsd-kind-icon">add<wbr>Drawable</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="distancerenderpass.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="distancerenderpass.html#initialize" class="tsd-kind-icon">initialize</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="distancerenderpass.html#render" class="tsd-kind-icon">render</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

102
docs/classes/drawable.html
View file

@ -3,8 +3,8 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Drawable | SDF-2D - v0.3.1</title> <title>Drawable | SDF-2D - v0.3.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1"> <meta name="description" content="Documentation for SDF-2D - v0.3.2">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/css/main.css">
</head> </head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li> <li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li> <li class="state failure">The search index is not available</li>
</ul> </ul>
<a href="../index.html" class="title">SDF-2D - v0.3.1</a> <a href="../index.html" class="title">SDF-2D - v0.3.2</a>
</div> </div>
<div class="table-cell" id="tsd-widgets"> <div class="table-cell" id="tsd-widgets">
<div id="tsd-filter"> <div id="tsd-filter">
@ -62,6 +62,17 @@
<div class="container container-main"> <div class="container container-main">
<div class="row"> <div class="row">
<div class="col-8 col-content"> <div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Base class of every drawable object.</p>
</div>
<p>To create your own drawables, you need to subclass from this.</p>
<blockquote>
<p>Although lights are also subclasses of Drawable, you cannot create your own light sources.</p>
</blockquote>
</div>
</section>
<section class="tsd-panel tsd-hierarchy"> <section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3> <h3>Hierarchy</h3>
<ul class="tsd-hierarchy"> <ul class="tsd-hierarchy">
@ -77,9 +88,6 @@
<li> <li>
<a href="tunnel.html" class="tsd-signature-type">Tunnel</a> <a href="tunnel.html" class="tsd-signature-type">Tunnel</a>
</li> </li>
<li>
<a href="lightdrawable.html" class="tsd-signature-type">LightDrawable</a>
</li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -113,9 +121,14 @@
<div class="tsd-signature tsd-kind-icon">descriptor<span class="tsd-signature-symbol">:</span> <a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a></div> <div class="tsd-signature tsd-kind-icon">descriptor<span class="tsd-signature-symbol">:</span> <a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable.ts#L6">drawables/drawable.ts:6</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable.ts#L15">drawables/drawable.ts:15</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This should be defined in inherited classes.</p>
</div>
</div>
</section> </section>
</section> </section>
<section class="tsd-panel-group tsd-member-group "> <section class="tsd-panel-group tsd-member-group ">
@ -130,16 +143,29 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable.ts#L9">drawables/drawable.ts:9</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable.ts#L34">drawables/drawable.ts:34</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Return the values that should be given to the shaders through uniform inputs.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters"> <ul class="tsd-parameters">
<li> <li>
<h5>transform2d: <span class="tsd-signature-type">mat2d</span></h5> <h5>transform2d: <span class="tsd-signature-type">mat2d</span></h5>
<div class="tsd-comment tsd-typography">
<p>position-like properties should be transformed by this matrix
before being returned.</p>
</div>
</li> </li>
<li> <li>
<h5>transform1d: <span class="tsd-signature-type">number</span></h5> <h5>transform1d: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>scalar properties should be transformed by this number
before being returned.</p>
</div>
</li> </li>
</ul> </ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
@ -156,13 +182,22 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable.ts#L8">drawables/drawable.ts:8</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable.ts#L24">drawables/drawable.ts:24</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The lower bound of the distance between the target and the object.</p>
</div>
<p>It can return 0 by default, the only consequence of this, is a reduced performance.
Because this object won&#39;t benefit from tile-based rendering.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters"> <ul class="tsd-parameters">
<li> <li>
<h5>target: <span class="tsd-signature-type">vec2</span></h5> <h5>target: <span class="tsd-signature-type">vec2</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li> </li>
</ul> </ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
@ -179,7 +214,7 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable.ts#L11">drawables/drawable.ts:11</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable.ts#L36">drawables/drawable.ts:36</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -210,6 +245,12 @@
</nav> </nav>
<nav class="tsd-navigation secondary menu-sticky"> <nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current"> <ul class="before-current">
<li class=" tsd-kind-class">
<a href="circle.html" class="tsd-kind-icon">Circle</a>
</li>
<li class=" tsd-kind-class">
<a href="circlelight.html" class="tsd-kind-icon">Circle<wbr>Light</a>
</li>
</ul> </ul>
<ul class="current"> <ul class="current">
<li class="current tsd-kind-class"> <li class="current tsd-kind-class">
@ -231,6 +272,36 @@
</li> </li>
</ul> </ul>
<ul class="after-current"> <ul class="after-current">
<li class=" tsd-kind-class">
<a href="flashlight.html" class="tsd-kind-icon">Flashlight</a>
</li>
<li class=" tsd-kind-class">
<a href="invertedtunnel.html" class="tsd-kind-icon">Inverted<wbr>Tunnel</a>
</li>
<li class=" tsd-kind-class">
<a href="tunnel.html" class="tsd-kind-icon">Tunnel</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/renderer.html" class="tsd-kind-icon">Renderer</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/runtimesettings.html" class="tsd-kind-icon">Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</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> </ul>
</nav> </nav>
</div> </div>
@ -245,22 +316,19 @@
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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"> <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-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> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <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> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <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> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul> </ul>
</div> </div>
</div> </div>

101
docs/classes/flashlight.html
View file

@ -3,8 +3,8 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Flashlight | SDF-2D - v0.3.1</title> <title>Flashlight | SDF-2D - v0.3.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1"> <meta name="description" content="Documentation for SDF-2D - v0.3.2">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/css/main.css">
</head> </head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li> <li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li> <li class="state failure">The search index is not available</li>
</ul> </ul>
<a href="../index.html" class="title">SDF-2D - v0.3.1</a> <a href="../index.html" class="title">SDF-2D - v0.3.2</a>
</div> </div>
<div class="table-cell" id="tsd-widgets"> <div class="table-cell" id="tsd-widgets">
<div id="tsd-filter"> <div id="tsd-filter">
@ -62,11 +62,15 @@
<div class="container container-main"> <div class="container container-main">
<div class="row"> <div class="row">
<div class="col-8 col-content"> <div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-hierarchy"> <section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3> <h3>Hierarchy</h3>
<ul class="tsd-hierarchy"> <ul class="tsd-hierarchy">
<li> <li>
<a href="lightdrawable.html" class="tsd-signature-type">LightDrawable</a> <span class="tsd-signature-type">LightDrawable</span>
<ul class="tsd-hierarchy"> <ul class="tsd-hierarchy">
<li> <li>
<span class="target">Flashlight</span> <span class="target">Flashlight</span>
@ -124,9 +128,9 @@
<ul class="tsd-descriptions"> <ul class="tsd-descriptions">
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Overrides <a href="lightdrawable.html">LightDrawable</a>.<a href="lightdrawable.html#constructor">constructor</a></p> <p>Overrides LightDrawable.__constructor</p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L21">drawables/lights/flashlight.ts:21</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L24">drawables/lights/flashlight.ts:24</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -158,7 +162,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#center">center</a></p> <p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#center">center</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L7">drawables/lights/light-drawable.ts:7</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -169,7 +173,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#color">color</a></p> <p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#color">color</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L7">drawables/lights/light-drawable.ts:7</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -179,7 +183,7 @@
<div class="tsd-signature tsd-kind-icon">direction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div> <div class="tsd-signature tsd-kind-icon">direction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L27">drawables/lights/flashlight.ts:27</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L30">drawables/lights/flashlight.ts:30</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -190,7 +194,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#intensity">intensity</a></p> <p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#intensity">intensity</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L7">drawables/lights/light-drawable.ts:7</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L8">drawables/lights/light-drawable.ts:8</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -201,7 +205,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#lightnessratio">lightnessRatio</a></p> <p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#lightnessratio">lightnessRatio</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L5">drawables/lights/light-drawable.ts:5</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L6">drawables/lights/light-drawable.ts:6</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -217,9 +221,9 @@
<ul class="tsd-descriptions"> <ul class="tsd-descriptions">
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Overrides <a href="lightdrawable.html">LightDrawable</a>.<a href="lightdrawable.html#getobjecttoserialize">getObjectToSerialize</a></p> <p>Overrides LightDrawable.getObjectToSerialize</p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L32">drawables/lights/flashlight.ts:32</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L35">drawables/lights/flashlight.ts:35</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -247,7 +251,7 @@
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#mindistance">minDistance</a></p> <p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#mindistance">minDistance</a></p>
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#mindistance">minDistance</a></p> <p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#mindistance">minDistance</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L15">drawables/lights/light-drawable.ts:15</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L16">drawables/lights/light-drawable.ts:16</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -271,7 +275,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="drawable.html">Drawable</a>.<a href="drawable.html#serializetouniforms">serializeToUniforms</a></p> <p>Inherited from <a href="drawable.html">Drawable</a>.<a href="drawable.html#serializetouniforms">serializeToUniforms</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable.ts#L11">drawables/drawable.ts:11</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable.ts#L36">drawables/drawable.ts:36</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -301,7 +305,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#setlightnessratio">setLightnessRatio</a></p> <p>Inherited from <a href="flashlight.html">Flashlight</a>.<a href="flashlight.html#setlightnessratio">setLightnessRatio</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L11">drawables/lights/light-drawable.ts:11</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/light-drawable.ts#L12">drawables/lights/light-drawable.ts:12</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -324,7 +328,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#descriptor">descriptor</a></p> <p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#descriptor">descriptor</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L6">drawables/lights/flashlight.ts:6</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L9">drawables/lights/flashlight.ts:9</a></li>
</ul> </ul>
</aside> </aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -333,7 +337,7 @@
<div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="flashlight.html" class="tsd-signature-type">Flashlight</a><span class="tsd-signature-symbol"> = new Flashlight(vec2.fromValues(0, 0),vec3.fromValues(0, 0, 0),0,vec2.fromValues(0, 0))</span></div> <div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="flashlight.html" class="tsd-signature-type">Flashlight</a><span class="tsd-signature-symbol"> = new Flashlight(vec2.fromValues(0, 0),vec3.fromValues(0, 0, 0),0,vec2.fromValues(0, 0))</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L15">drawables/lights/flashlight.ts:15</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L18">drawables/lights/flashlight.ts:18</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -343,7 +347,7 @@
<div class="tsd-signature tsd-kind-icon">shader<wbr>Combination<wbr>Steps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [0, 1, 2, 4]</span></div> <div class="tsd-signature tsd-kind-icon">shader<wbr>Combination<wbr>Steps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [0, 1, 2, 4]</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L14">drawables/lights/flashlight.ts:14</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L17">drawables/lights/flashlight.ts:17</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -353,7 +357,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><span class="tsd-signature-symbol"> = &quot;FLASHLIGHT_COUNT&quot;</span></div> <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><span class="tsd-signature-symbol"> = &quot;FLASHLIGHT_COUNT&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L13">drawables/lights/flashlight.ts:13</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L16">drawables/lights/flashlight.ts:16</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -363,7 +367,7 @@
<div class="tsd-signature tsd-kind-icon">property<wbr>Uniform<wbr>Mapping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <div class="tsd-signature tsd-kind-icon">property<wbr>Uniform<wbr>Mapping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L7">drawables/lights/flashlight.ts:7</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L10">drawables/lights/flashlight.ts:10</a></li>
</ul> </ul>
</aside> </aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -372,7 +376,7 @@
<div class="tsd-signature tsd-kind-icon">center<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;flashlightCenters&quot;</span></div> <div class="tsd-signature tsd-kind-icon">center<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;flashlightCenters&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L8">drawables/lights/flashlight.ts:8</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L11">drawables/lights/flashlight.ts:11</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -382,7 +386,7 @@
<div class="tsd-signature tsd-kind-icon">color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;flashlightColors&quot;</span></div> <div class="tsd-signature tsd-kind-icon">color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;flashlightColors&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L9">drawables/lights/flashlight.ts:9</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L12">drawables/lights/flashlight.ts:12</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -392,7 +396,7 @@
<div class="tsd-signature tsd-kind-icon">direction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;flashlightDirections&quot;</span></div> <div class="tsd-signature tsd-kind-icon">direction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;flashlightDirections&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L11">drawables/lights/flashlight.ts:11</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L14">drawables/lights/flashlight.ts:14</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -402,7 +406,7 @@
<div class="tsd-signature tsd-kind-icon">intensity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;flashlightIntensities&quot;</span></div> <div class="tsd-signature tsd-kind-icon">intensity<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;flashlightIntensities&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/flashlight.ts#L10">drawables/lights/flashlight.ts:10</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/lights/flashlight.ts#L13">drawables/lights/flashlight.ts:13</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -420,6 +424,15 @@
</nav> </nav>
<nav class="tsd-navigation secondary menu-sticky"> <nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current"> <ul class="before-current">
<li class=" tsd-kind-class">
<a href="circle.html" class="tsd-kind-icon">Circle</a>
</li>
<li class=" tsd-kind-class">
<a href="circlelight.html" class="tsd-kind-icon">Circle<wbr>Light</a>
</li>
<li class=" tsd-kind-class">
<a href="drawable.html" class="tsd-kind-icon">Drawable</a>
</li>
</ul> </ul>
<ul class="current"> <ul class="current">
<li class="current tsd-kind-class"> <li class="current tsd-kind-class">
@ -462,6 +475,33 @@
</li> </li>
</ul> </ul>
<ul class="after-current"> <ul class="after-current">
<li class=" tsd-kind-class">
<a href="invertedtunnel.html" class="tsd-kind-icon">Inverted<wbr>Tunnel</a>
</li>
<li class=" tsd-kind-class">
<a href="tunnel.html" class="tsd-kind-icon">Tunnel</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/renderer.html" class="tsd-kind-icon">Renderer</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/runtimesettings.html" class="tsd-kind-icon">Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</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> </ul>
</nav> </nav>
</div> </div>
@ -476,22 +516,19 @@
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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"> <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-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> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <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> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <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> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul> </ul>
</div> </div>
</div> </div>

272
docs/classes/fpsautoscaler.html
View file

@ -1,272 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FpsAutoscaler | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="fpsautoscaler.html">FpsAutoscaler</a>
</li>
</ul>
<h1>Class FpsAutoscaler</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">FpsAutoscaler</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="fpsautoscaler.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fpsautoscaler.html#autoscale" class="tsd-kind-icon">autoscale</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fpsautoscaler.html#decrease" class="tsd-kind-icon">decrease</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="fpsautoscaler.html#increase" class="tsd-kind-icon">increase</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Fps<wbr>Autoscaler<span class="tsd-signature-symbol">(</span>setters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="fpsautoscaler.html" class="tsd-signature-type">FpsAutoscaler</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/fps-autoscaler.ts#L38">graphics/rendering/fps-autoscaler.ts:38</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>setters: <span class="tsd-signature-symbol">{}</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="fpsautoscaler.html" class="tsd-signature-type">FpsAutoscaler</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="autoscale" class="tsd-anchor"></a>
<h3>autoscale</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">autoscale<span class="tsd-signature-symbol">(</span>lastDeltaTime<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/48490b3/src/graphics/rendering/fps-autoscaler.ts#L82">graphics/rendering/fps-autoscaler.ts:82</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>lastDeltaTime: <span class="tsd-signature-type">DOMHighResTimeStamp</span></h5>
</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-class">
<a name="decrease" class="tsd-anchor"></a>
<h3>decrease</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">decrease<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/rendering/fps-autoscaler.ts#L49">graphics/rendering/fps-autoscaler.ts:49</a></li>
</ul>
</aside>
<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-class">
<a name="increase" class="tsd-anchor"></a>
<h3>increase</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">increase<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/rendering/fps-autoscaler.ts#L44">graphics/rendering/fps-autoscaler.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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-class">
<a href="fpsautoscaler.html" class="tsd-kind-icon">Fps<wbr>Autoscaler</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="fpsautoscaler.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="fpsautoscaler.html#autoscale" class="tsd-kind-icon">autoscale</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="fpsautoscaler.html#decrease" class="tsd-kind-icon">decrease</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="fpsautoscaler.html#increase" class="tsd-kind-icon">increase</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

412
docs/classes/fragmentshaderonlyprogram.html
View file

@ -1,412 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FragmentShaderOnlyProgram | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="fragmentshaderonlyprogram.html">FragmentShaderOnlyProgram</a>
</li>
</ul>
<h1>Class FragmentShaderOnlyProgram</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>
<a href="program.html" class="tsd-signature-type">Program</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">FragmentShaderOnlyProgram</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/iprogram.html" class="tsd-signature-type">IProgram</a></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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="fragmentshaderonlyprogram.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="fragmentshaderonlyprogram.html#gl" class="tsd-kind-icon">gl</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="fragmentshaderonlyprogram.html#program" class="tsd-kind-icon">program</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="fragmentshaderonlyprogram.html#bind" class="tsd-kind-icon">bind</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="fragmentshaderonlyprogram.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="fragmentshaderonlyprogram.html#draw" class="tsd-kind-icon">draw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="fragmentshaderonlyprogram.html#initialize" class="tsd-kind-icon">initialize</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="fragmentshaderonlyprogram.html#setdrawingrectangleuv" class="tsd-kind-icon">set<wbr>Drawing<wbr>RectangleUV</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="fragmentshaderonlyprogram.html#setuniforms" class="tsd-kind-icon">set<wbr>Uniforms</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Fragment<wbr>Shader<wbr>Only<wbr>Program<span class="tsd-signature-symbol">(</span>gl<span class="tsd-signature-symbol">: </span><a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="fragmentshaderonlyprogram.html" class="tsd-signature-type">FragmentShaderOnlyProgram</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="program.html">Program</a>.<a href="program.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/fragment-shader-only-program.ts#L8">graphics/graphics-library/program/fragment-shader-only-program.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>gl: <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="fragmentshaderonlyprogram.html" class="tsd-signature-type">FragmentShaderOnlyProgram</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="gl" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> gl</h3>
<div class="tsd-signature tsd-kind-icon">gl<span class="tsd-signature-symbol">:</span> <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="program.html">Program</a>.<a href="program.html#gl">gl</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/program.ts#L18">graphics/graphics-library/program/program.ts:18</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="program" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagOptional">Optional</span> program</h3>
<div class="tsd-signature tsd-kind-icon">program<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WebGLProgram</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="program.html">Program</a>.<a href="program.html#program-1">program</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/program.ts#L8">graphics/graphics-library/program/program.ts:8</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="bind" class="tsd-anchor"></a>
<h3>bind</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">bind<span class="tsd-signature-symbol">(</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">
<p>Overrides <a href="program.html">Program</a>.<a href="program.html#bind">bind</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/fragment-shader-only-program.ts#L25">graphics/graphics-library/program/fragment-shader-only-program.ts:25</a></li>
</ul>
</aside>
<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-class tsd-is-overwrite">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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">
<p>Implementation of <a href="../interfaces/iprogram.html">IProgram</a>.<a href="../interfaces/iprogram.html#destroy">destroy</a></p>
<p>Overrides <a href="program.html">Program</a>.<a href="program.html#destroy">destroy</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/fragment-shader-only-program.ts#L39">graphics/graphics-library/program/fragment-shader-only-program.ts:39</a></li>
</ul>
</aside>
<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-class tsd-is-overwrite">
<a name="draw" class="tsd-anchor"></a>
<h3>draw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">draw<span class="tsd-signature-symbol">(</span>uniforms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</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">
<p>Overrides <a href="program.html">Program</a>.<a href="program.html#draw">draw</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/fragment-shader-only-program.ts#L34">graphics/graphics-library/program/fragment-shader-only-program.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uniforms: <span class="tsd-signature-symbol">{}</span></h5>
<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">any</span></h5>
</li>
</ul>
</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-class tsd-is-overwrite">
<a name="initialize" class="tsd-anchor"></a>
<h3>initialize</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">initialize<span class="tsd-signature-symbol">(</span>sources<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span>, substitutions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span>, compiler<span class="tsd-signature-symbol">: </span><a href="parallelcompiler.html" class="tsd-signature-type">ParallelCompiler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="program.html">Program</a>.<a href="program.html#initialize">initialize</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/fragment-shader-only-program.ts#L16">graphics/graphics-library/program/fragment-shader-only-program.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>sources: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></h5>
</li>
<li>
<h5>substitutions: <span class="tsd-signature-symbol">{}</span></h5>
<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">string</span></h5>
</li>
</ul>
</li>
<li>
<h5>compiler: <a href="parallelcompiler.html" class="tsd-signature-type">ParallelCompiler</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="setdrawingrectangleuv" class="tsd-anchor"></a>
<h3>set<wbr>Drawing<wbr>RectangleUV</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">set<wbr>Drawing<wbr>RectangleUV<span class="tsd-signature-symbol">(</span>bottomLeft<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</span>, size<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/iprogram.html">IProgram</a>.<a href="../interfaces/iprogram.html#setdrawingrectangleuv">setDrawingRectangleUV</a></p>
<p>Inherited from <a href="program.html">Program</a>.<a href="program.html#setdrawingrectangleuv">setDrawingRectangleUV</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/program.ts#L36">graphics/graphics-library/program/program.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bottomLeft: <span class="tsd-signature-type">vec2</span></h5>
</li>
<li>
<h5>size: <span class="tsd-signature-type">vec2</span></h5>
</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-class tsd-is-inherited">
<a name="setuniforms" class="tsd-anchor"></a>
<h3>set<wbr>Uniforms</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">set<wbr>Uniforms<span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</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">
<p>Inherited from <a href="program.html">Program</a>.<a href="program.html#setuniforms">setUniforms</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/program.ts#L43">graphics/graphics-library/program/program.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>values: <span class="tsd-signature-symbol">{}</span></h5>
<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">any</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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-class">
<a href="fragmentshaderonlyprogram.html" class="tsd-kind-icon">Fragment<wbr>Shader<wbr>Only<wbr>Program</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="fragmentshaderonlyprogram.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="fragmentshaderonlyprogram.html#gl" class="tsd-kind-icon">gl</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="fragmentshaderonlyprogram.html#program" class="tsd-kind-icon">program</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="fragmentshaderonlyprogram.html#bind" class="tsd-kind-icon">bind</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="fragmentshaderonlyprogram.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="fragmentshaderonlyprogram.html#draw" class="tsd-kind-icon">draw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="fragmentshaderonlyprogram.html#initialize" class="tsd-kind-icon">initialize</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="fragmentshaderonlyprogram.html#setdrawingrectangleuv" class="tsd-kind-icon">set<wbr>Drawing<wbr>RectangleUV</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="fragmentshaderonlyprogram.html#setuniforms" class="tsd-kind-icon">set<wbr>Uniforms</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

356
docs/classes/framebuffer.html
View file

@ -1,356 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FrameBuffer | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="framebuffer.html">FrameBuffer</a>
</li>
</ul>
<h1>Class FrameBuffer</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">FrameBuffer</span>
<ul class="tsd-hierarchy">
<li>
<a href="defaultframebuffer.html" class="tsd-signature-type">DefaultFrameBuffer</a>
</li>
<li>
<a href="intermediateframebuffer.html" class="tsd-signature-type">IntermediateFrameBuffer</a>
</li>
</ul>
</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="framebuffer.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="framebuffer.html#enablehighdpirendering" class="tsd-kind-icon">enable<wbr>High<wbr>Dpi<wbr>Rendering</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="framebuffer.html#framebuffer-1" class="tsd-kind-icon">frame<wbr>Buffer</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="framebuffer.html#gl" class="tsd-kind-icon">gl</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="framebuffer.html#renderscale" class="tsd-kind-icon">render<wbr>Scale</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="framebuffer.html#size" class="tsd-kind-icon">size</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="framebuffer.html#bindandclear" class="tsd-kind-icon">bind<wbr>And<wbr>Clear</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="framebuffer.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="framebuffer.html#getsize" class="tsd-kind-icon">get<wbr>Size</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="framebuffer.html#setsize" class="tsd-kind-icon">set<wbr>Size</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Frame<wbr>Buffer<span class="tsd-signature-symbol">(</span>gl<span class="tsd-signature-symbol">: </span><a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="framebuffer.html" class="tsd-signature-type">FrameBuffer</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L11">graphics/graphics-library/frame-buffer/frame-buffer.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>gl: <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="framebuffer.html" class="tsd-signature-type">FrameBuffer</a></h4>
</li>
</ul>
</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-class">
<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><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L6">graphics/graphics-library/frame-buffer/frame-buffer.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="framebuffer-1" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> frame<wbr>Buffer</h3>
<div class="tsd-signature tsd-kind-icon">frame<wbr>Buffer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WebGLFramebuffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L11">graphics/graphics-library/frame-buffer/frame-buffer.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="gl" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> gl</h3>
<div class="tsd-signature tsd-kind-icon">gl<span class="tsd-signature-symbol">:</span> <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L13">graphics/graphics-library/frame-buffer/frame-buffer.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="renderscale" class="tsd-anchor"></a>
<h3>render<wbr>Scale</h3>
<div class="tsd-signature tsd-kind-icon">render<wbr>Scale<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L5">graphics/graphics-library/frame-buffer/frame-buffer.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="size" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> size</h3>
<div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol"> = vec2.create()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L8">graphics/graphics-library/frame-buffer/frame-buffer.ts:8</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="bindandclear" class="tsd-anchor"></a>
<h3>bind<wbr>And<wbr>Clear</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">bind<wbr>And<wbr>Clear<span class="tsd-signature-symbol">(</span>inputTextures<span class="tsd-signature-symbol">: </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">WebGLTexture</span><span class="tsd-signature-symbol">&gt;</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/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L15">graphics/graphics-library/frame-buffer/frame-buffer.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>inputTextures: <a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">WebGLTexture</span><span class="tsd-signature-symbol">&gt;</span></h5>
</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-class">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L26">graphics/graphics-library/frame-buffer/frame-buffer.ts:26</a></li>
</ul>
</aside>
<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-class">
<a name="getsize" class="tsd-anchor"></a>
<h3>get<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Size<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L46">graphics/graphics-library/frame-buffer/frame-buffer.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec2</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="setsize" class="tsd-anchor"></a>
<h3>set<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Size<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L30">graphics/graphics-library/frame-buffer/frame-buffer.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</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-class">
<a href="framebuffer.html" class="tsd-kind-icon">Frame<wbr>Buffer</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="framebuffer.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="framebuffer.html#enablehighdpirendering" class="tsd-kind-icon">enable<wbr>High<wbr>Dpi<wbr>Rendering</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="framebuffer.html#framebuffer-1" class="tsd-kind-icon">frame<wbr>Buffer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="framebuffer.html#gl" class="tsd-kind-icon">gl</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="framebuffer.html#renderscale" class="tsd-kind-icon">render<wbr>Scale</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="framebuffer.html#size" class="tsd-kind-icon">size</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="framebuffer.html#bindandclear" class="tsd-kind-icon">bind<wbr>And<wbr>Clear</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="framebuffer.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="framebuffer.html#getsize" class="tsd-kind-icon">get<wbr>Size</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="framebuffer.html#setsize" class="tsd-kind-icon">set<wbr>Size</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

273
docs/classes/insights.html
View file

@ -1,273 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Insights | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="insights.html">Insights</a>
</li>
</ul>
<h1>Class Insights</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">Insights</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>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="insights.html#values" class="tsd-kind-icon">values</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="insights.html#measure" class="tsd-kind-icon">measure</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="insights.html#measurefunction" class="tsd-kind-icon">measure<wbr>Function</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="insights.html#setvalue" class="tsd-kind-icon">set<wbr>Value</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
<a name="values" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> values</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> values<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/48490b3/src/graphics/rendering/insights.ts#L53">graphics/rendering/insights.ts:53</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="measure" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> measure</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">measure<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">(Anonymous function)</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/48490b3/src/graphics/rendering/insights.ts#L27">graphics/rendering/insights.ts:27</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">(Anonymous function)</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="measurefunction" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> measure<wbr>Function</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">measure<wbr>Function<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, targetFunction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/48490b3/src/graphics/rendering/insights.ts#L39">graphics/rendering/insights.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>targetFunction: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="setvalue" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> set<wbr>Value</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">set<wbr>Value<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/48490b3/src/graphics/rendering/insights.ts#L7">graphics/rendering/insights.ts:7</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>value: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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-class">
<a href="insights.html" class="tsd-kind-icon">Insights</a>
<ul>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
<a href="insights.html#values" class="tsd-kind-icon">values</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="insights.html#measure" class="tsd-kind-icon">measure</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="insights.html#measurefunction" class="tsd-kind-icon">measure<wbr>Function</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="insights.html#setvalue" class="tsd-kind-icon">set<wbr>Value</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

392
docs/classes/intermediateframebuffer.html
View file

@ -1,392 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IntermediateFrameBuffer | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="intermediateframebuffer.html">IntermediateFrameBuffer</a>
</li>
</ul>
<h1>Class IntermediateFrameBuffer</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>
<a href="framebuffer.html" class="tsd-signature-type">FrameBuffer</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">IntermediateFrameBuffer</span>
</li>
</ul>
</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="intermediateframebuffer.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="intermediateframebuffer.html#enablehighdpirendering" class="tsd-kind-icon">enable<wbr>High<wbr>Dpi<wbr>Rendering</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="intermediateframebuffer.html#framebuffer" class="tsd-kind-icon">frame<wbr>Buffer</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="intermediateframebuffer.html#gl" class="tsd-kind-icon">gl</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="intermediateframebuffer.html#renderscale" class="tsd-kind-icon">render<wbr>Scale</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="intermediateframebuffer.html#size" class="tsd-kind-icon">size</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="intermediateframebuffer.html#colortexture" class="tsd-kind-icon">color<wbr>Texture</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="intermediateframebuffer.html#bindandclear" class="tsd-kind-icon">bind<wbr>And<wbr>Clear</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="intermediateframebuffer.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="intermediateframebuffer.html#getsize" class="tsd-kind-icon">get<wbr>Size</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="intermediateframebuffer.html#setsize" class="tsd-kind-icon">set<wbr>Size</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Intermediate<wbr>Frame<wbr>Buffer<span class="tsd-signature-symbol">(</span>gl<span class="tsd-signature-symbol">: </span><a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="intermediateframebuffer.html" class="tsd-signature-type">IntermediateFrameBuffer</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/intermediate-frame-buffer.ts#L8">graphics/graphics-library/frame-buffer/intermediate-frame-buffer.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>gl: <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="intermediateframebuffer.html" class="tsd-signature-type">IntermediateFrameBuffer</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<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><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#enablehighdpirendering">enableHighDpiRendering</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L6">graphics/graphics-library/frame-buffer/frame-buffer.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="framebuffer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> frame<wbr>Buffer</h3>
<div class="tsd-signature tsd-kind-icon">frame<wbr>Buffer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WebGLFramebuffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#framebuffer-1">frameBuffer</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L11">graphics/graphics-library/frame-buffer/frame-buffer.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="gl" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> gl</h3>
<div class="tsd-signature tsd-kind-icon">gl<span class="tsd-signature-symbol">:</span> <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#gl">gl</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L13">graphics/graphics-library/frame-buffer/frame-buffer.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="renderscale" class="tsd-anchor"></a>
<h3>render<wbr>Scale</h3>
<div class="tsd-signature tsd-kind-icon">render<wbr>Scale<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#renderscale">renderScale</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L5">graphics/graphics-library/frame-buffer/frame-buffer.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="size" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> size</h3>
<div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span><span class="tsd-signature-symbol"> = vec2.create()</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#size">size</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L8">graphics/graphics-library/frame-buffer/frame-buffer.ts:8</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="colortexture" class="tsd-anchor"></a>
<h3>color<wbr>Texture</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> colorTexture<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">WebGLTexture</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/48490b3/src/graphics/graphics-library/frame-buffer/intermediate-frame-buffer.ts#L40">graphics/graphics-library/frame-buffer/intermediate-frame-buffer.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">WebGLTexture</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="bindandclear" class="tsd-anchor"></a>
<h3>bind<wbr>And<wbr>Clear</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">bind<wbr>And<wbr>Clear<span class="tsd-signature-symbol">(</span>inputTextures<span class="tsd-signature-symbol">: </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">WebGLTexture</span><span class="tsd-signature-symbol">&gt;</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">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#bindandclear">bindAndClear</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L15">graphics/graphics-library/frame-buffer/frame-buffer.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>inputTextures: <a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">WebGLTexture</span><span class="tsd-signature-symbol">&gt;</span></h5>
</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-class tsd-is-overwrite">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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">
<p>Overrides <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#destroy">destroy</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/intermediate-frame-buffer.ts#L36">graphics/graphics-library/frame-buffer/intermediate-frame-buffer.ts:36</a></li>
</ul>
</aside>
<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-class tsd-is-inherited">
<a name="getsize" class="tsd-anchor"></a>
<h3>get<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Size<span class="tsd-signature-symbol">(</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">
<p>Inherited from <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#getsize">getSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/frame-buffer.ts#L46">graphics/graphics-library/frame-buffer/frame-buffer.ts:46</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec2</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="setsize" class="tsd-anchor"></a>
<h3>set<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">set<wbr>Size<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="framebuffer.html">FrameBuffer</a>.<a href="framebuffer.html#setsize">setSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/frame-buffer/intermediate-frame-buffer.ts#L44">graphics/graphics-library/frame-buffer/intermediate-frame-buffer.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</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-class">
<a href="intermediateframebuffer.html" class="tsd-kind-icon">Intermediate<wbr>Frame<wbr>Buffer</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="intermediateframebuffer.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="intermediateframebuffer.html#enablehighdpirendering" class="tsd-kind-icon">enable<wbr>High<wbr>Dpi<wbr>Rendering</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="intermediateframebuffer.html#framebuffer" class="tsd-kind-icon">frame<wbr>Buffer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="intermediateframebuffer.html#gl" class="tsd-kind-icon">gl</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a href="intermediateframebuffer.html#renderscale" class="tsd-kind-icon">render<wbr>Scale</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="intermediateframebuffer.html#size" class="tsd-kind-icon">size</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="intermediateframebuffer.html#colortexture" class="tsd-kind-icon">color<wbr>Texture</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="intermediateframebuffer.html#bindandclear" class="tsd-kind-icon">bind<wbr>And<wbr>Clear</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="intermediateframebuffer.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="intermediateframebuffer.html#getsize" class="tsd-kind-icon">get<wbr>Size</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="intermediateframebuffer.html#setsize" class="tsd-kind-icon">set<wbr>Size</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

99
docs/classes/invertedtunnel.html
View file

@ -3,8 +3,8 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>InvertedTunnel | SDF-2D - v0.3.1</title> <title>InvertedTunnel | SDF-2D - v0.3.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1"> <meta name="description" content="Documentation for SDF-2D - v0.3.2">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/css/main.css">
</head> </head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li> <li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li> <li class="state failure">The search index is not available</li>
</ul> </ul>
<a href="../index.html" class="title">SDF-2D - v0.3.1</a> <a href="../index.html" class="title">SDF-2D - v0.3.2</a>
</div> </div>
<div class="table-cell" id="tsd-widgets"> <div class="table-cell" id="tsd-widgets">
<div id="tsd-filter"> <div id="tsd-filter">
@ -62,6 +62,10 @@
<div class="container container-main"> <div class="container container-main">
<div class="row"> <div class="row">
<div class="col-8 col-content"> <div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-hierarchy"> <section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3> <h3>Hierarchy</h3>
<ul class="tsd-hierarchy"> <ul class="tsd-hierarchy">
@ -123,7 +127,7 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L53">drawables/shapes/inverted-tunnel.ts:53</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L56">drawables/shapes/inverted-tunnel.ts:56</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -154,7 +158,7 @@
<div class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div> <div class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L56">drawables/shapes/inverted-tunnel.ts:56</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L59">drawables/shapes/inverted-tunnel.ts:59</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -164,7 +168,7 @@
<div class="tsd-signature tsd-kind-icon">from<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <div class="tsd-signature tsd-kind-icon">from<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L58">drawables/shapes/inverted-tunnel.ts:58</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L61">drawables/shapes/inverted-tunnel.ts:61</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -174,7 +178,7 @@
<div class="tsd-signature tsd-kind-icon">to<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div> <div class="tsd-signature tsd-kind-icon">to<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L57">drawables/shapes/inverted-tunnel.ts:57</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L60">drawables/shapes/inverted-tunnel.ts:60</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -184,7 +188,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <div class="tsd-signature tsd-kind-icon">to<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L59">drawables/shapes/inverted-tunnel.ts:59</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L62">drawables/shapes/inverted-tunnel.ts:62</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -202,7 +206,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#getobjecttoserialize">getObjectToSerialize</a></p> <p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#getobjecttoserialize">getObjectToSerialize</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L78">drawables/shapes/inverted-tunnel.ts:78</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L81">drawables/shapes/inverted-tunnel.ts:81</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -229,7 +233,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#mindistance">minDistance</a></p> <p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#mindistance">minDistance</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L64">drawables/shapes/inverted-tunnel.ts:64</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L67">drawables/shapes/inverted-tunnel.ts:67</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -253,7 +257,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="drawable.html">Drawable</a>.<a href="drawable.html#serializetouniforms">serializeToUniforms</a></p> <p>Inherited from <a href="drawable.html">Drawable</a>.<a href="drawable.html#serializetouniforms">serializeToUniforms</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable.ts#L11">drawables/drawable.ts:11</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable.ts#L36">drawables/drawable.ts:36</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -282,7 +286,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#descriptor">descriptor</a></p> <p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#descriptor">descriptor</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L8">drawables/shapes/inverted-tunnel.ts:8</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L11">drawables/shapes/inverted-tunnel.ts:11</a></li>
</ul> </ul>
</aside> </aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -291,7 +295,7 @@
<div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="invertedtunnel.html" class="tsd-signature-type">InvertedTunnel</a><span class="tsd-signature-symbol"> = new InvertedTunnel(vec2.fromValues(0, 0), vec2.fromValues(0, 0), 0, 0)</span></div> <div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="invertedtunnel.html" class="tsd-signature-type">InvertedTunnel</a><span class="tsd-signature-symbol"> = new InvertedTunnel(vec2.fromValues(0, 0), vec2.fromValues(0, 0), 0, 0)</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L52">drawables/shapes/inverted-tunnel.ts:52</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L55">drawables/shapes/inverted-tunnel.ts:55</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -301,7 +305,7 @@
<div class="tsd-signature tsd-kind-icon">shader<wbr>Combination<wbr>Steps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [0, 1, 4, 16, 32]</span></div> <div class="tsd-signature tsd-kind-icon">shader<wbr>Combination<wbr>Steps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [0, 1, 4, 16, 32]</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L51">drawables/shapes/inverted-tunnel.ts:51</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L54">drawables/shapes/inverted-tunnel.ts:54</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -311,7 +315,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><span class="tsd-signature-symbol"> = &quot;INVERTED_TUNNEL_COUNT&quot;</span></div> <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><span class="tsd-signature-symbol"> = &quot;INVERTED_TUNNEL_COUNT&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L50">drawables/shapes/inverted-tunnel.ts:50</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L53">drawables/shapes/inverted-tunnel.ts:53</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -321,7 +325,7 @@
<div class="tsd-signature tsd-kind-icon">property<wbr>Uniform<wbr>Mapping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <div class="tsd-signature tsd-kind-icon">property<wbr>Uniform<wbr>Mapping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L44">drawables/shapes/inverted-tunnel.ts:44</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L47">drawables/shapes/inverted-tunnel.ts:47</a></li>
</ul> </ul>
</aside> </aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -330,7 +334,7 @@
<div class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;froms&quot;</span></div> <div class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;froms&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L45">drawables/shapes/inverted-tunnel.ts:45</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L48">drawables/shapes/inverted-tunnel.ts:48</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -340,7 +344,7 @@
<div class="tsd-signature tsd-kind-icon">from<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;fromRadii&quot;</span></div> <div class="tsd-signature tsd-kind-icon">from<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;fromRadii&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L47">drawables/shapes/inverted-tunnel.ts:47</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L50">drawables/shapes/inverted-tunnel.ts:50</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -350,7 +354,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>From<wbr>Delta<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;toFromDeltas&quot;</span></div> <div class="tsd-signature tsd-kind-icon">to<wbr>From<wbr>Delta<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;toFromDeltas&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L46">drawables/shapes/inverted-tunnel.ts:46</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L49">drawables/shapes/inverted-tunnel.ts:49</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -360,7 +364,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;toRadii&quot;</span></div> <div class="tsd-signature tsd-kind-icon">to<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;toRadii&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L48">drawables/shapes/inverted-tunnel.ts:48</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L51">drawables/shapes/inverted-tunnel.ts:51</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -371,7 +375,7 @@
<div class="tsd-signature tsd-kind-icon">sdf<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <div class="tsd-signature tsd-kind-icon">sdf<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L9">drawables/shapes/inverted-tunnel.ts:9</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L12">drawables/shapes/inverted-tunnel.ts:12</a></li>
</ul> </ul>
</aside> </aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -380,7 +384,7 @@
<div class="tsd-signature tsd-kind-icon">distance<wbr>Function<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;invertedTunnelMinDistance&quot;</span></div> <div class="tsd-signature tsd-kind-icon">distance<wbr>Function<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;invertedTunnelMinDistance&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L42">drawables/shapes/inverted-tunnel.ts:42</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L45">drawables/shapes/inverted-tunnel.ts:45</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -390,7 +394,7 @@
<div class="tsd-signature tsd-kind-icon">is<wbr>Inverted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</span></div> <div class="tsd-signature tsd-kind-icon">is<wbr>Inverted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> = true</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L41">drawables/shapes/inverted-tunnel.ts:41</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L44">drawables/shapes/inverted-tunnel.ts:44</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -400,7 +404,7 @@
<div class="tsd-signature tsd-kind-icon">shader<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x60;uniform vec2 froms[INVERTED_TUNNEL_COUNT];uniform vec2 toFromDeltas[INVERTED_TUNNEL_COUNT];uniform float fromRadii[INVERTED_TUNNEL_COUNT];uniform float toRadii[INVERTED_TUNNEL_COUNT];float invertedTunnelMinDistance(vec2 target, out float colorIndex) {colorIndex &#x3D; 3.0;float minDistance &#x3D; 1000.0;for (int i &#x3D; 0; i &lt; INVERTED_TUNNEL_COUNT; i++) {vec2 targetFromDelta &#x3D; target - froms[i];float h &#x3D; clamp(dot(targetFromDelta, toFromDeltas[i])/ dot(toFromDeltas[i], toFromDeltas[i]),0.0, 1.0);float currentDistance &#x3D; -mix(fromRadii[i], toRadii[i], h) + distance(targetFromDelta, toFromDeltas[i] * h);minDistance &#x3D; min(minDistance, currentDistance);}return -minDistance;}&#x60;</span></div> <div class="tsd-signature tsd-kind-icon">shader<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x60;uniform vec2 froms[INVERTED_TUNNEL_COUNT];uniform vec2 toFromDeltas[INVERTED_TUNNEL_COUNT];uniform float fromRadii[INVERTED_TUNNEL_COUNT];uniform float toRadii[INVERTED_TUNNEL_COUNT];float invertedTunnelMinDistance(vec2 target, out float colorIndex) {colorIndex &#x3D; 3.0;float minDistance &#x3D; 1000.0;for (int i &#x3D; 0; i &lt; INVERTED_TUNNEL_COUNT; i++) {vec2 targetFromDelta &#x3D; target - froms[i];float h &#x3D; clamp(dot(targetFromDelta, toFromDeltas[i])/ dot(toFromDeltas[i], toFromDeltas[i]),0.0, 1.0);float currentDistance &#x3D; -mix(fromRadii[i], toRadii[i], h) + distance(targetFromDelta, toFromDeltas[i] * h);minDistance &#x3D; min(minDistance, currentDistance);}return -minDistance;}&#x60;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/inverted-tunnel.ts#L10">drawables/shapes/inverted-tunnel.ts:10</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/inverted-tunnel.ts#L13">drawables/shapes/inverted-tunnel.ts:13</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -418,6 +422,18 @@
</nav> </nav>
<nav class="tsd-navigation secondary menu-sticky"> <nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current"> <ul class="before-current">
<li class=" tsd-kind-class">
<a href="circle.html" class="tsd-kind-icon">Circle</a>
</li>
<li class=" tsd-kind-class">
<a href="circlelight.html" class="tsd-kind-icon">Circle<wbr>Light</a>
</li>
<li class=" tsd-kind-class">
<a href="drawable.html" class="tsd-kind-icon">Drawable</a>
</li>
<li class=" tsd-kind-class">
<a href="flashlight.html" class="tsd-kind-icon">Flashlight</a>
</li>
</ul> </ul>
<ul class="current"> <ul class="current">
<li class="current tsd-kind-class"> <li class="current tsd-kind-class">
@ -454,6 +470,30 @@
</li> </li>
</ul> </ul>
<ul class="after-current"> <ul class="after-current">
<li class=" tsd-kind-class">
<a href="tunnel.html" class="tsd-kind-icon">Tunnel</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/renderer.html" class="tsd-kind-icon">Renderer</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/runtimesettings.html" class="tsd-kind-icon">Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</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> </ul>
</nav> </nav>
</div> </div>
@ -468,22 +508,19 @@
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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"> <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-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> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <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> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <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> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul> </ul>
</div> </div>
</div> </div>

398
docs/classes/lightdrawable.html
View file

@ -1,398 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LightDrawable | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="lightdrawable.html">LightDrawable</a>
</li>
</ul>
<h1>Class LightDrawable</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>
<a href="drawable.html" class="tsd-signature-type">Drawable</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">LightDrawable</span>
<ul class="tsd-hierarchy">
<li>
<a href="flashlight.html" class="tsd-signature-type">Flashlight</a>
</li>
<li>
<a href="circlelight.html" class="tsd-signature-type">CircleLight</a>
</li>
</ul>
</li>
</ul>
</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="lightdrawable.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="lightdrawable.html#center" class="tsd-kind-icon">center</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="lightdrawable.html#color" class="tsd-kind-icon">color</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="lightdrawable.html#intensity" class="tsd-kind-icon">intensity</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="lightdrawable.html#lightnessratio" class="tsd-kind-icon">lightness<wbr>Ratio</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="lightdrawable.html#descriptor" class="tsd-kind-icon">descriptor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="lightdrawable.html#getobjecttoserialize" class="tsd-kind-icon">get<wbr>Object<wbr>ToSerialize</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="lightdrawable.html#mindistance" class="tsd-kind-icon">min<wbr>Distance</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="lightdrawable.html#serializetouniforms" class="tsd-kind-icon">serialize<wbr>ToUniforms</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="lightdrawable.html#setlightnessratio" class="tsd-kind-icon">set<wbr>Lightness<wbr>Ratio</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Light<wbr>Drawable<span class="tsd-signature-symbol">(</span>center<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</span>, color<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec3</span>, intensity<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><a href="lightdrawable.html" class="tsd-signature-type">LightDrawable</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L5">drawables/lights/light-drawable.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>center: <span class="tsd-signature-type">vec2</span></h5>
</li>
<li>
<h5>color: <span class="tsd-signature-type">vec3</span></h5>
</li>
<li>
<h5>intensity: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="lightdrawable.html" class="tsd-signature-type">LightDrawable</a></h4>
</li>
</ul>
</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-class">
<a name="center" class="tsd-anchor"></a>
<h3>center</h3>
<div class="tsd-signature tsd-kind-icon">center<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/48490b3/src/drawables/lights/light-drawable.ts#L7">drawables/lights/light-drawable.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="color" class="tsd-anchor"></a>
<h3>color</h3>
<div class="tsd-signature tsd-kind-icon">color<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/48490b3/src/drawables/lights/light-drawable.ts#L7">drawables/lights/light-drawable.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="intensity" class="tsd-anchor"></a>
<h3>intensity</h3>
<div class="tsd-signature tsd-kind-icon">intensity<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/48490b3/src/drawables/lights/light-drawable.ts#L7">drawables/lights/light-drawable.ts:7</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="lightnessratio" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> lightness<wbr>Ratio</h3>
<div class="tsd-signature tsd-kind-icon">lightness<wbr>Ratio<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L5">drawables/lights/light-drawable.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a name="descriptor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> descriptor</h3>
<div class="tsd-signature tsd-kind-icon">descriptor<span class="tsd-signature-symbol">:</span> <a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="drawable.html">Drawable</a>.<a href="drawable.html#descriptor">descriptor</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable.ts#L6">drawables/drawable.ts:6</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<a name="getobjecttoserialize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Object<wbr>ToSerialize</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">get<wbr>Object<wbr>ToSerialize<span class="tsd-signature-symbol">(</span>transform2d<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">mat2d</span>, transform1d<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#getobjecttoserialize">getObjectToSerialize</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L19">drawables/lights/light-drawable.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>transform2d: <span class="tsd-signature-type">mat2d</span></h5>
</li>
<li>
<h5>transform1d: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="mindistance" class="tsd-anchor"></a>
<h3>min<wbr>Distance</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">min<wbr>Distance<span class="tsd-signature-symbol">(</span>target<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">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#mindistance">minDistance</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/lights/light-drawable.ts#L15">drawables/lights/light-drawable.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>target: <span class="tsd-signature-type">vec2</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="serializetouniforms" class="tsd-anchor"></a>
<h3>serialize<wbr>ToUniforms</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">serialize<wbr>ToUniforms<span class="tsd-signature-symbol">(</span>uniforms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, transform2d<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">mat2d</span>, transform1d<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="drawable.html">Drawable</a>.<a href="drawable.html#serializetouniforms">serializeToUniforms</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable.ts#L11">drawables/drawable.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uniforms: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>transform2d: <span class="tsd-signature-type">mat2d</span></h5>
</li>
<li>
<h5>transform1d: <span class="tsd-signature-type">number</span></h5>
</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-class">
<a name="setlightnessratio" class="tsd-anchor"></a>
<h3>set<wbr>Lightness<wbr>Ratio</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Lightness<wbr>Ratio<span class="tsd-signature-symbol">(</span>ratio<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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/48490b3/src/drawables/lights/light-drawable.ts#L11">drawables/lights/light-drawable.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>ratio: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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-class">
<a href="lightdrawable.html" class="tsd-kind-icon">Light<wbr>Drawable</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="lightdrawable.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="lightdrawable.html#center" class="tsd-kind-icon">center</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="lightdrawable.html#color" class="tsd-kind-icon">color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="lightdrawable.html#intensity" class="tsd-kind-icon">intensity</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="lightdrawable.html#lightnessratio" class="tsd-kind-icon">lightness<wbr>Ratio</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static">
<a href="lightdrawable.html#descriptor" class="tsd-kind-icon">descriptor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<a href="lightdrawable.html#getobjecttoserialize" class="tsd-kind-icon">get<wbr>Object<wbr>ToSerialize</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="lightdrawable.html#mindistance" class="tsd-kind-icon">min<wbr>Distance</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="lightdrawable.html#serializetouniforms" class="tsd-kind-icon">serialize<wbr>ToUniforms</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="lightdrawable.html#setlightnessratio" class="tsd-kind-icon">set<wbr>Lightness<wbr>Ratio</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

363
docs/classes/lightsrenderpass.html
View file

@ -1,363 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>LightsRenderPass | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="lightsrenderpass.html">LightsRenderPass</a>
</li>
</ul>
<h1>Class LightsRenderPass</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>
<a href="renderpass.html" class="tsd-signature-type">RenderPass</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">LightsRenderPass</span>
</li>
</ul>
</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 tsd-is-inherited">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="lightsrenderpass.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="lightsrenderpass.html#frame" class="tsd-kind-icon">frame</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="lightsrenderpass.html#lightcutoffdistance" class="tsd-kind-icon">light<wbr>Cutoff<wbr>Distance</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="lightsrenderpass.html#program" class="tsd-kind-icon">program</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="lightsrenderpass.html#adddrawable" class="tsd-kind-icon">add<wbr>Drawable</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="lightsrenderpass.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="lightsrenderpass.html#initialize" class="tsd-kind-icon">initialize</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="lightsrenderpass.html#render" class="tsd-kind-icon">render</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">new <wbr>Lights<wbr>Render<wbr>Pass<span class="tsd-signature-symbol">(</span>gl<span class="tsd-signature-symbol">: </span><a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a>, frame<span class="tsd-signature-symbol">: </span><a href="framebuffer.html" class="tsd-signature-type">FrameBuffer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="lightsrenderpass.html" class="tsd-signature-type">LightsRenderPass</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="renderpass.html">RenderPass</a>.<a href="renderpass.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L8">graphics/rendering/render-pass/render-pass.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>gl: <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></h5>
</li>
<li>
<h5>frame: <a href="framebuffer.html" class="tsd-signature-type">FrameBuffer</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="lightsrenderpass.html" class="tsd-signature-type">LightsRenderPass</a></h4>
</li>
</ul>
</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-class tsd-is-inherited tsd-is-protected">
<a name="frame" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> frame</h3>
<div class="tsd-signature tsd-kind-icon">frame<span class="tsd-signature-symbol">:</span> <a href="framebuffer.html" class="tsd-signature-type">FrameBuffer</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="renderpass.html">RenderPass</a>.<a href="renderpass.html#frame">frame</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L10">graphics/rendering/render-pass/render-pass.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="lightcutoffdistance" class="tsd-anchor"></a>
<h3>light<wbr>Cutoff<wbr>Distance</h3>
<div class="tsd-signature tsd-kind-icon">light<wbr>Cutoff<wbr>Distance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 400</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/lights-render-pass.ts#L8">graphics/rendering/render-pass/lights-render-pass.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="program" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> program</h3>
<div class="tsd-signature tsd-kind-icon">program<span class="tsd-signature-symbol">:</span> <a href="uniformarrayautoscalingprogram.html" class="tsd-signature-type">UniformArrayAutoScalingProgram</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="renderpass.html">RenderPass</a>.<a href="renderpass.html#program">program</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L8">graphics/rendering/render-pass/render-pass.ts:8</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="adddrawable" class="tsd-anchor"></a>
<h3>add<wbr>Drawable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Drawable<span class="tsd-signature-symbol">(</span>drawable<span class="tsd-signature-symbol">: </span><a href="lightdrawable.html" class="tsd-signature-type">LightDrawable</a><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/48490b3/src/graphics/rendering/render-pass/lights-render-pass.ts#L11">graphics/rendering/render-pass/lights-render-pass.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>drawable: <a href="lightdrawable.html" class="tsd-signature-type">LightDrawable</a></h5>
</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-class tsd-is-inherited">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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">
<p>Inherited from <a href="renderpass.html">RenderPass</a>.<a href="renderpass.html#destroy">destroy</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L25">graphics/rendering/render-pass/render-pass.ts:25</a></li>
</ul>
</aside>
<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-class tsd-is-inherited">
<a name="initialize" class="tsd-anchor"></a>
<h3>initialize</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">initialize<span class="tsd-signature-symbol">(</span>shaderSources<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span>, descriptors<span class="tsd-signature-symbol">: </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span>, substitutions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span>, compiler<span class="tsd-signature-symbol">: </span><a href="parallelcompiler.html" class="tsd-signature-type">ParallelCompiler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="renderpass.html">RenderPass</a>.<a href="renderpass.html#initialize">initialize</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L14">graphics/rendering/render-pass/render-pass.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>shaderSources: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></h5>
</li>
<li>
<h5>descriptors: <a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> substitutions: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></h5>
<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">any</span></h5>
</li>
</ul>
</li>
<li>
<h5>compiler: <a href="parallelcompiler.html" class="tsd-signature-type">ParallelCompiler</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="render" class="tsd-anchor"></a>
<h3>render</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">render<span class="tsd-signature-symbol">(</span>commonUniforms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, <span class="tsd-signature-symbol">...</span>inputTextures<span class="tsd-signature-symbol">: </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">WebGLTexture</span><span class="tsd-signature-symbol">&gt;</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">
<p>Overrides <a href="renderpass.html">RenderPass</a>.<a href="renderpass.html#render">render</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/lights-render-pass.ts#L15">graphics/rendering/render-pass/lights-render-pass.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>commonUniforms: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>inputTextures: <a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">WebGLTexture</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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-class">
<a href="lightsrenderpass.html" class="tsd-kind-icon">Lights<wbr>Render<wbr>Pass</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
<a href="lightsrenderpass.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="lightsrenderpass.html#frame" class="tsd-kind-icon">frame</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="lightsrenderpass.html#lightcutoffdistance" class="tsd-kind-icon">light<wbr>Cutoff<wbr>Distance</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="lightsrenderpass.html#program" class="tsd-kind-icon">program</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="lightsrenderpass.html#adddrawable" class="tsd-kind-icon">add<wbr>Drawable</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="lightsrenderpass.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="lightsrenderpass.html#initialize" class="tsd-kind-icon">initialize</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="lightsrenderpass.html#render" class="tsd-kind-icon">render</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

287
docs/classes/palettetexture.html
View file

@ -1,287 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>PaletteTexture | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="palettetexture.html">PaletteTexture</a>
</li>
</ul>
<h1>Class PaletteTexture</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">PaletteTexture</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="palettetexture.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="palettetexture.html#colortexture" class="tsd-kind-icon">color<wbr>Texture</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="palettetexture.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="palettetexture.html#setimage" class="tsd-kind-icon">set<wbr>Image</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="palettetexture.html#setpalette" class="tsd-kind-icon">set<wbr>Palette</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Palette<wbr>Texture<span class="tsd-signature-symbol">(</span>gl<span class="tsd-signature-symbol">: </span><a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a>, paletteSize<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><a href="palettetexture.html" class="tsd-signature-type">PaletteTexture</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/palette-texture.ts#L5">graphics/graphics-library/palette-texture.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>gl: <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></h5>
</li>
<li>
<h5>paletteSize: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="palettetexture.html" class="tsd-signature-type">PaletteTexture</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="colortexture" class="tsd-anchor"></a>
<h3>color<wbr>Texture</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> colorTexture<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">WebGLTexture</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/48490b3/src/graphics/graphics-library/palette-texture.ts#L20">graphics/graphics-library/palette-texture.ts:20</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">WebGLTexture</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/graphics-library/palette-texture.ts#L61">graphics/graphics-library/palette-texture.ts:61</a></li>
</ul>
</aside>
<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-class">
<a name="setimage" class="tsd-anchor"></a>
<h3>set<wbr>Image</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Image<span class="tsd-signature-symbol">(</span>image<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TexImageSource</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/48490b3/src/graphics/graphics-library/palette-texture.ts#L48">graphics/graphics-library/palette-texture.ts:48</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>image: <span class="tsd-signature-type">TexImageSource</span></h5>
</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-class">
<a name="setpalette" class="tsd-anchor"></a>
<h3>set<wbr>Palette</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Palette<span class="tsd-signature-symbol">(</span>colors<span class="tsd-signature-symbol">: </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol">&gt;</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/48490b3/src/graphics/graphics-library/palette-texture.ts#L29">graphics/graphics-library/palette-texture.ts:29</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>colors: <a href="../interfaces/__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></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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-class">
<a href="palettetexture.html" class="tsd-kind-icon">Palette<wbr>Texture</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="palettetexture.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="palettetexture.html#colortexture" class="tsd-kind-icon">color<wbr>Texture</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="palettetexture.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="palettetexture.html#setimage" class="tsd-kind-icon">set<wbr>Image</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="palettetexture.html#setpalette" class="tsd-kind-icon">set<wbr>Palette</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

239
docs/classes/parallelcompiler.html
View file

@ -1,239 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ParallelCompiler | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="parallelcompiler.html">ParallelCompiler</a>
</li>
</ul>
<h1>Class ParallelCompiler</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">ParallelCompiler</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="parallelcompiler.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="parallelcompiler.html#compileprograms" class="tsd-kind-icon">compile<wbr>Programs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="parallelcompiler.html#createprogram" class="tsd-kind-icon">create<wbr>Program</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Parallel<wbr>Compiler<span class="tsd-signature-symbol">(</span>gl<span class="tsd-signature-symbol">: </span><a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="parallelcompiler.html" class="tsd-signature-type">ParallelCompiler</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/parallel-compiler.ts#L18">graphics/graphics-library/parallel-compiler.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>gl: <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="parallelcompiler.html" class="tsd-signature-type">ParallelCompiler</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="compileprograms" class="tsd-anchor"></a>
<h3>compile<wbr>Programs</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">compile<wbr>Programs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/parallel-compiler.ts#L61">graphics/graphics-library/parallel-compiler.ts:61</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="createprogram" class="tsd-anchor"></a>
<h3>create<wbr>Program</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>Program<span class="tsd-signature-symbol">(</span>vertexShaderSource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fragmentShaderSource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, substitutions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">WebGLProgram</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/parallel-compiler.ts#L25">graphics/graphics-library/parallel-compiler.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>vertexShaderSource: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>fragmentShaderSource: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>substitutions: <span class="tsd-signature-symbol">{}</span></h5>
<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">string</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">WebGLProgram</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</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-class">
<a href="parallelcompiler.html" class="tsd-kind-icon">Parallel<wbr>Compiler</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="parallelcompiler.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="parallelcompiler.html#compileprograms" class="tsd-kind-icon">compile<wbr>Programs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="parallelcompiler.html#createprogram" class="tsd-kind-icon">create<wbr>Program</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

403
docs/classes/program.html
View file

@ -1,403 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Program | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="program.html">Program</a>
</li>
</ul>
<h1>Class Program</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">Program</span>
<ul class="tsd-hierarchy">
<li>
<a href="fragmentshaderonlyprogram.html" class="tsd-signature-type">FragmentShaderOnlyProgram</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/iprogram.html" class="tsd-signature-type">IProgram</a></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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="program.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="program.html#gl" class="tsd-kind-icon">gl</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="program.html#program-1" class="tsd-kind-icon">program</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="program.html#bind" class="tsd-kind-icon">bind</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="program.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="program.html#draw" class="tsd-kind-icon">draw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="program.html#initialize" class="tsd-kind-icon">initialize</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="program.html#setdrawingrectangleuv" class="tsd-kind-icon">set<wbr>Drawing<wbr>RectangleUV</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="program.html#setuniforms" class="tsd-kind-icon">set<wbr>Uniforms</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Program<span class="tsd-signature-symbol">(</span>gl<span class="tsd-signature-symbol">: </span><a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="program.html" class="tsd-signature-type">Program</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/program.ts#L16">graphics/graphics-library/program/program.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>gl: <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="program.html" class="tsd-signature-type">Program</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="gl" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> gl</h3>
<div class="tsd-signature tsd-kind-icon">gl<span class="tsd-signature-symbol">:</span> <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/program.ts#L18">graphics/graphics-library/program/program.ts:18</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="program-1" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagOptional">Optional</span> program</h3>
<div class="tsd-signature tsd-kind-icon">program<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">WebGLProgram</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/program.ts#L8">graphics/graphics-library/program/program.ts:8</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="bind" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> bind</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">bind<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/graphics-library/program/program.ts#L65">graphics/graphics-library/program/program.ts:65</a></li>
</ul>
</aside>
<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-class">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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">
<p>Implementation of <a href="../interfaces/iprogram.html">IProgram</a>.<a href="../interfaces/iprogram.html#destroy">destroy</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/program.ts#L56">graphics/graphics-library/program/program.ts:56</a></li>
</ul>
</aside>
<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-class">
<a name="draw" class="tsd-anchor"></a>
<h3>draw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">draw<span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</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/48490b3/src/graphics/graphics-library/program/program.ts#L60">graphics/graphics-library/program/program.ts:60</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>values: <span class="tsd-signature-symbol">{}</span></h5>
<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">any</span></h5>
</li>
</ul>
</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-class">
<a name="initialize" class="tsd-anchor"></a>
<h3>initialize</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">initialize<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span>, substitutions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span>, compiler<span class="tsd-signature-symbol">: </span><a href="parallelcompiler.html" class="tsd-signature-type">ParallelCompiler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/program.ts#L20">graphics/graphics-library/program/program.ts:20</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></h5>
</li>
<li>
<h5>substitutions: <span class="tsd-signature-symbol">{}</span></h5>
<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">string</span></h5>
</li>
</ul>
</li>
<li>
<h5>compiler: <a href="parallelcompiler.html" class="tsd-signature-type">ParallelCompiler</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="setdrawingrectangleuv" class="tsd-anchor"></a>
<h3>set<wbr>Drawing<wbr>RectangleUV</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Drawing<wbr>RectangleUV<span class="tsd-signature-symbol">(</span>bottomLeft<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</span>, size<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/iprogram.html">IProgram</a>.<a href="../interfaces/iprogram.html#setdrawingrectangleuv">setDrawingRectangleUV</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/program.ts#L36">graphics/graphics-library/program/program.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bottomLeft: <span class="tsd-signature-type">vec2</span></h5>
</li>
<li>
<h5>size: <span class="tsd-signature-type">vec2</span></h5>
</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-class">
<a name="setuniforms" class="tsd-anchor"></a>
<h3>set<wbr>Uniforms</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Uniforms<span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</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/48490b3/src/graphics/graphics-library/program/program.ts#L43">graphics/graphics-library/program/program.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>values: <span class="tsd-signature-symbol">{}</span></h5>
<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">any</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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-class">
<a href="program.html" class="tsd-kind-icon">Program</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="program.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="program.html#gl" class="tsd-kind-icon">gl</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="program.html#program-1" class="tsd-kind-icon">program</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="program.html#bind" class="tsd-kind-icon">bind</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="program.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="program.html#draw" class="tsd-kind-icon">draw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="program.html#initialize" class="tsd-kind-icon">initialize</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="program.html#setdrawingrectangleuv" class="tsd-kind-icon">set<wbr>Drawing<wbr>RectangleUV</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="program.html#setuniforms" class="tsd-kind-icon">set<wbr>Uniforms</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

449
docs/classes/rendererimplementation.html
View file

@ -1,449 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RendererImplementation | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="rendererimplementation.html">RendererImplementation</a>
</li>
</ul>
<h1>Class RendererImplementation</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">RendererImplementation</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/renderer.html" class="tsd-signature-type">Renderer</a></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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="rendererimplementation.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="rendererimplementation.html#canvassize" class="tsd-kind-icon">canvas<wbr>Size</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="rendererimplementation.html#insights" class="tsd-kind-icon">insights</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="rendererimplementation.html#viewareasize" class="tsd-kind-icon">view<wbr>Area<wbr>Size</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="rendererimplementation.html#adddrawable" class="tsd-kind-icon">add<wbr>Drawable</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="rendererimplementation.html#autoscalequality" class="tsd-kind-icon">autoscale<wbr>Quality</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="rendererimplementation.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="rendererimplementation.html#initialize" class="tsd-kind-icon">initialize</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="rendererimplementation.html#renderdrawables" class="tsd-kind-icon">render<wbr>Drawables</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="rendererimplementation.html#setruntimesettings" class="tsd-kind-icon">set<wbr>Runtime<wbr>Settings</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="rendererimplementation.html#setviewarea" class="tsd-kind-icon">set<wbr>View<wbr>Area</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Renderer<wbr>Implementation<span class="tsd-signature-symbol">(</span>canvas<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLCanvasElement</span>, descriptors<span class="tsd-signature-symbol">: </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span>, ignoreWebGL2<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><span class="tsd-signature-symbol">: </span><a href="rendererimplementation.html" class="tsd-signature-type">RendererImplementation</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer-implementation.ts#L63">graphics/rendering/renderer/renderer-implementation.ts:63</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>canvas: <span class="tsd-signature-type">HTMLCanvasElement</span></h5>
</li>
<li>
<h5>descriptors: <a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ignoreWebGL2: <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></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="rendererimplementation.html" class="tsd-signature-type">RendererImplementation</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="canvassize" class="tsd-anchor"></a>
<h3>canvas<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> canvasSize<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/rendering/renderer/renderer-implementation.ts#L239">graphics/rendering/renderer/renderer-implementation.ts:239</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec2</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="insights" class="tsd-anchor"></a>
<h3>insights</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> insights<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/48490b3/src/graphics/rendering/renderer/renderer-implementation.ts#L145">graphics/rendering/renderer/renderer-implementation.ts:145</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="viewareasize" class="tsd-anchor"></a>
<h3>view<wbr>Area<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> viewAreaSize<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/rendering/renderer/renderer-implementation.ts#L235">graphics/rendering/renderer/renderer-implementation.ts:235</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec2</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="adddrawable" class="tsd-anchor"></a>
<h3>add<wbr>Drawable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<wbr>Drawable<span class="tsd-signature-symbol">(</span>drawable<span class="tsd-signature-symbol">: </span><a href="drawable.html" class="tsd-signature-type">Drawable</a><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">
<p>Implementation of <a href="../interfaces/renderer.html">Renderer</a>.<a href="../interfaces/renderer.html#adddrawable">addDrawable</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer-implementation.ts#L177">graphics/rendering/renderer/renderer-implementation.ts:177</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>drawable: <a href="drawable.html" class="tsd-signature-type">Drawable</a></h5>
</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-class">
<a name="autoscalequality" class="tsd-anchor"></a>
<h3>autoscale<wbr>Quality</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<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">
<p>Implementation of <a href="../interfaces/renderer.html">Renderer</a>.<a href="../interfaces/renderer.html#autoscalequality">autoscaleQuality</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer-implementation.ts#L187">graphics/rendering/renderer/renderer-implementation.ts:187</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>deltaTime: <span class="tsd-signature-type">DOMHighResTimeStamp</span></h5>
</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-class">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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">
<p>Implementation of <a href="../interfaces/renderer.html">Renderer</a>.<a href="../interfaces/renderer.html#destroy">destroy</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer-implementation.ts#L243">graphics/rendering/renderer/renderer-implementation.ts:243</a></li>
</ul>
</aside>
<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-class">
<a name="initialize" class="tsd-anchor"></a>
<h3>initialize</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">initialize<span class="tsd-signature-symbol">(</span>settingsOverrides<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/startupsettings.html" class="tsd-signature-type">StartupSettings</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer-implementation.ts#L99">graphics/rendering/renderer/renderer-implementation.ts:99</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>settingsOverrides: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/startupsettings.html" class="tsd-signature-type">StartupSettings</a><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="renderdrawables" class="tsd-anchor"></a>
<h3>render<wbr>Drawables</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">render<wbr>Drawables<span class="tsd-signature-symbol">(</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">
<p>Implementation of <a href="../interfaces/renderer.html">Renderer</a>.<a href="../interfaces/renderer.html#renderdrawables">renderDrawables</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer-implementation.ts#L191">graphics/rendering/renderer/renderer-implementation.ts:191</a></li>
</ul>
</aside>
<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-class">
<a name="setruntimesettings" class="tsd-anchor"></a>
<h3>set<wbr>Runtime<wbr>Settings</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Runtime<wbr>Settings<span class="tsd-signature-symbol">(</span>overrides<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/runtimesettings.html" class="tsd-signature-type">RuntimeSettings</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/renderer.html">Renderer</a>.<a href="../interfaces/renderer.html#setruntimesettings">setRuntimeSettings</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer-implementation.ts#L59">graphics/rendering/renderer/renderer-implementation.ts:59</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>overrides: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/runtimesettings.html" class="tsd-signature-type">RuntimeSettings</a><span class="tsd-signature-symbol">&gt;</span></h5>
</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-class">
<a name="setviewarea" class="tsd-anchor"></a>
<h3>set<wbr>View<wbr>Area</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>View<wbr>Area<span class="tsd-signature-symbol">(</span>topLeft<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</span>, size<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/renderer.html">Renderer</a>.<a href="../interfaces/renderer.html#setviewarea">setViewArea</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer-implementation.ts#L231">graphics/rendering/renderer/renderer-implementation.ts:231</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>topLeft: <span class="tsd-signature-type">vec2</span></h5>
</li>
<li>
<h5>size: <span class="tsd-signature-type">vec2</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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-class">
<a href="rendererimplementation.html" class="tsd-kind-icon">Renderer<wbr>Implementation</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="rendererimplementation.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="rendererimplementation.html#canvassize" class="tsd-kind-icon">canvas<wbr>Size</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="rendererimplementation.html#insights" class="tsd-kind-icon">insights</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="rendererimplementation.html#viewareasize" class="tsd-kind-icon">view<wbr>Area<wbr>Size</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="rendererimplementation.html#adddrawable" class="tsd-kind-icon">add<wbr>Drawable</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="rendererimplementation.html#autoscalequality" class="tsd-kind-icon">autoscale<wbr>Quality</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="rendererimplementation.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="rendererimplementation.html#initialize" class="tsd-kind-icon">initialize</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="rendererimplementation.html#renderdrawables" class="tsd-kind-icon">render<wbr>Drawables</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="rendererimplementation.html#setruntimesettings" class="tsd-kind-icon">set<wbr>Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="rendererimplementation.html#setviewarea" class="tsd-kind-icon">set<wbr>View<wbr>Area</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

319
docs/classes/renderpass.html
View file

@ -1,319 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RenderPass | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="renderpass.html">RenderPass</a>
</li>
</ul>
<h1>Class RenderPass</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">RenderPass</span>
<ul class="tsd-hierarchy">
<li>
<a href="distancerenderpass.html" class="tsd-signature-type">DistanceRenderPass</a>
</li>
<li>
<a href="lightsrenderpass.html" class="tsd-signature-type">LightsRenderPass</a>
</li>
</ul>
</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="renderpass.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="renderpass.html#frame" class="tsd-kind-icon">frame</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="renderpass.html#program" class="tsd-kind-icon">program</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="renderpass.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="renderpass.html#initialize" class="tsd-kind-icon">initialize</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="renderpass.html#render" class="tsd-kind-icon">render</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Render<wbr>Pass<span class="tsd-signature-symbol">(</span>gl<span class="tsd-signature-symbol">: </span><a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a>, frame<span class="tsd-signature-symbol">: </span><a href="framebuffer.html" class="tsd-signature-type">FrameBuffer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="renderpass.html" class="tsd-signature-type">RenderPass</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L8">graphics/rendering/render-pass/render-pass.ts:8</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>gl: <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></h5>
</li>
<li>
<h5>frame: <a href="framebuffer.html" class="tsd-signature-type">FrameBuffer</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="renderpass.html" class="tsd-signature-type">RenderPass</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="frame" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> frame</h3>
<div class="tsd-signature tsd-kind-icon">frame<span class="tsd-signature-symbol">:</span> <a href="framebuffer.html" class="tsd-signature-type">FrameBuffer</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L10">graphics/rendering/render-pass/render-pass.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="program" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> program</h3>
<div class="tsd-signature tsd-kind-icon">program<span class="tsd-signature-symbol">:</span> <a href="uniformarrayautoscalingprogram.html" class="tsd-signature-type">UniformArrayAutoScalingProgram</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L8">graphics/rendering/render-pass/render-pass.ts:8</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L25">graphics/rendering/render-pass/render-pass.ts:25</a></li>
</ul>
</aside>
<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-class">
<a name="initialize" class="tsd-anchor"></a>
<h3>initialize</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">initialize<span class="tsd-signature-symbol">(</span>shaderSources<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span>, descriptors<span class="tsd-signature-symbol">: </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span>, substitutions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{}</span>, compiler<span class="tsd-signature-symbol">: </span><a href="parallelcompiler.html" class="tsd-signature-type">ParallelCompiler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L14">graphics/rendering/render-pass/render-pass.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>shaderSources: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></h5>
</li>
<li>
<h5>descriptors: <a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> substitutions: <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> = {}</span></h5>
<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">any</span></h5>
</li>
</ul>
</li>
<li>
<h5>compiler: <a href="parallelcompiler.html" class="tsd-signature-type">ParallelCompiler</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="render" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> render</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">render<span class="tsd-signature-symbol">(</span>commonUniforms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, inputTexture<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">WebGLTexture</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/48490b3/src/graphics/rendering/render-pass/render-pass.ts#L23">graphics/rendering/render-pass/render-pass.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>commonUniforms: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> inputTexture: <span class="tsd-signature-type">WebGLTexture</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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-class">
<a href="renderpass.html" class="tsd-kind-icon">Render<wbr>Pass</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="renderpass.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="renderpass.html#frame" class="tsd-kind-icon">frame</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="renderpass.html#program" class="tsd-kind-icon">program</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="renderpass.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="renderpass.html#initialize" class="tsd-kind-icon">initialize</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="renderpass.html#render" class="tsd-kind-icon">render</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

97
docs/classes/tunnel.html
View file

@ -3,8 +3,8 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Tunnel | SDF-2D - v0.3.1</title> <title>Tunnel | SDF-2D - v0.3.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1"> <meta name="description" content="Documentation for SDF-2D - v0.3.2">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/css/main.css">
</head> </head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li> <li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li> <li class="state failure">The search index is not available</li>
</ul> </ul>
<a href="../index.html" class="title">SDF-2D - v0.3.1</a> <a href="../index.html" class="title">SDF-2D - v0.3.2</a>
</div> </div>
<div class="table-cell" id="tsd-widgets"> <div class="table-cell" id="tsd-widgets">
<div id="tsd-filter"> <div id="tsd-filter">
@ -62,6 +62,10 @@
<div class="container container-main"> <div class="container container-main">
<div class="row"> <div class="row">
<div class="col-8 col-content"> <div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-hierarchy"> <section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3> <h3>Hierarchy</h3>
<ul class="tsd-hierarchy"> <ul class="tsd-hierarchy">
@ -123,7 +127,7 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L57">drawables/shapes/tunnel.ts:57</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L60">drawables/shapes/tunnel.ts:60</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -154,7 +158,7 @@
<div class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div> <div class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L60">drawables/shapes/tunnel.ts:60</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L63">drawables/shapes/tunnel.ts:63</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -164,7 +168,7 @@
<div class="tsd-signature tsd-kind-icon">from<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <div class="tsd-signature tsd-kind-icon">from<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L62">drawables/shapes/tunnel.ts:62</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L65">drawables/shapes/tunnel.ts:65</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -174,7 +178,7 @@
<div class="tsd-signature tsd-kind-icon">to<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div> <div class="tsd-signature tsd-kind-icon">to<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L61">drawables/shapes/tunnel.ts:61</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L64">drawables/shapes/tunnel.ts:64</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -184,7 +188,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <div class="tsd-signature tsd-kind-icon">to<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L63">drawables/shapes/tunnel.ts:63</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L66">drawables/shapes/tunnel.ts:66</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -202,7 +206,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#getobjecttoserialize">getObjectToSerialize</a></p> <p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#getobjecttoserialize">getObjectToSerialize</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L82">drawables/shapes/tunnel.ts:82</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L85">drawables/shapes/tunnel.ts:85</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -229,7 +233,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#mindistance">minDistance</a></p> <p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#mindistance">minDistance</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L68">drawables/shapes/tunnel.ts:68</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L71">drawables/shapes/tunnel.ts:71</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -253,7 +257,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Inherited from <a href="drawable.html">Drawable</a>.<a href="drawable.html#serializetouniforms">serializeToUniforms</a></p> <p>Inherited from <a href="drawable.html">Drawable</a>.<a href="drawable.html#serializetouniforms">serializeToUniforms</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable.ts#L11">drawables/drawable.ts:11</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable.ts#L36">drawables/drawable.ts:36</a></li>
</ul> </ul>
</aside> </aside>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
@ -282,7 +286,7 @@
<aside class="tsd-sources"> <aside class="tsd-sources">
<p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#descriptor">descriptor</a></p> <p>Overrides <a href="drawable.html">Drawable</a>.<a href="drawable.html#descriptor">descriptor</a></p>
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L8">drawables/shapes/tunnel.ts:8</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L11">drawables/shapes/tunnel.ts:11</a></li>
</ul> </ul>
</aside> </aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -291,7 +295,7 @@
<div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="tunnel.html" class="tsd-signature-type">Tunnel</a><span class="tsd-signature-symbol"> = new Tunnel(vec2.fromValues(-100000, -100000),vec2.fromValues(-100000, -100000),0,0)</span></div> <div class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">:</span> <a href="tunnel.html" class="tsd-signature-type">Tunnel</a><span class="tsd-signature-symbol"> = new Tunnel(vec2.fromValues(-100000, -100000),vec2.fromValues(-100000, -100000),0,0)</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L51">drawables/shapes/tunnel.ts:51</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L54">drawables/shapes/tunnel.ts:54</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -301,7 +305,7 @@
<div class="tsd-signature tsd-kind-icon">shader<wbr>Combination<wbr>Steps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [0, 1, 4, 16, 32]</span></div> <div class="tsd-signature tsd-kind-icon">shader<wbr>Combination<wbr>Steps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [0, 1, 4, 16, 32]</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L50">drawables/shapes/tunnel.ts:50</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L53">drawables/shapes/tunnel.ts:53</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -311,7 +315,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><span class="tsd-signature-symbol"> = &quot;TUNNEL_COUNT&quot;</span></div> <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><span class="tsd-signature-symbol"> = &quot;TUNNEL_COUNT&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L49">drawables/shapes/tunnel.ts:49</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L52">drawables/shapes/tunnel.ts:52</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -321,7 +325,7 @@
<div class="tsd-signature tsd-kind-icon">property<wbr>Uniform<wbr>Mapping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <div class="tsd-signature tsd-kind-icon">property<wbr>Uniform<wbr>Mapping<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L43">drawables/shapes/tunnel.ts:43</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L46">drawables/shapes/tunnel.ts:46</a></li>
</ul> </ul>
</aside> </aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -330,7 +334,7 @@
<div class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;froms&quot;</span></div> <div class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;froms&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L44">drawables/shapes/tunnel.ts:44</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L47">drawables/shapes/tunnel.ts:47</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -340,7 +344,7 @@
<div class="tsd-signature tsd-kind-icon">from<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;fromRadii&quot;</span></div> <div class="tsd-signature tsd-kind-icon">from<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;fromRadii&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L46">drawables/shapes/tunnel.ts:46</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L49">drawables/shapes/tunnel.ts:49</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -350,7 +354,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>From<wbr>Delta<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;toFromDeltas&quot;</span></div> <div class="tsd-signature tsd-kind-icon">to<wbr>From<wbr>Delta<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;toFromDeltas&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L45">drawables/shapes/tunnel.ts:45</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L48">drawables/shapes/tunnel.ts:48</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -360,7 +364,7 @@
<div class="tsd-signature tsd-kind-icon">to<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;toRadii&quot;</span></div> <div class="tsd-signature tsd-kind-icon">to<wbr>Radius<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;toRadii&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L47">drawables/shapes/tunnel.ts:47</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L50">drawables/shapes/tunnel.ts:50</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -371,7 +375,7 @@
<div class="tsd-signature tsd-kind-icon">sdf<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div> <div class="tsd-signature tsd-kind-icon">sdf<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L9">drawables/shapes/tunnel.ts:9</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L12">drawables/shapes/tunnel.ts:12</a></li>
</ul> </ul>
</aside> </aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal"> <section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@ -380,7 +384,7 @@
<div class="tsd-signature tsd-kind-icon">distance<wbr>Function<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;tunnelMinDistance&quot;</span></div> <div class="tsd-signature tsd-kind-icon">distance<wbr>Function<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &quot;tunnelMinDistance&quot;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L41">drawables/shapes/tunnel.ts:41</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L44">drawables/shapes/tunnel.ts:44</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -390,7 +394,7 @@
<div class="tsd-signature tsd-kind-icon">shader<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x60;uniform vec2 froms[TUNNEL_COUNT];uniform vec2 toFromDeltas[TUNNEL_COUNT];uniform float fromRadii[TUNNEL_COUNT];uniform float toRadii[TUNNEL_COUNT];float tunnelMinDistance(vec2 target, out float colorIndex) {colorIndex &#x3D; 1.0;float minDistance &#x3D; 1000.0;for (int i &#x3D; 0; i &lt; TUNNEL_COUNT; i++) {vec2 targetFromDelta &#x3D; target - froms[i];float h &#x3D; clamp(dot(targetFromDelta, toFromDeltas[i])/ dot(toFromDeltas[i], toFromDeltas[i]),0.0, 1.0);float currentDistance &#x3D; -mix(fromRadii[i], toRadii[i], h) + distance(targetFromDelta, toFromDeltas[i] * h);minDistance &#x3D; min(minDistance, currentDistance);}return minDistance;}&#x60;</span></div> <div class="tsd-signature tsd-kind-icon">shader<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x60;uniform vec2 froms[TUNNEL_COUNT];uniform vec2 toFromDeltas[TUNNEL_COUNT];uniform float fromRadii[TUNNEL_COUNT];uniform float toRadii[TUNNEL_COUNT];float tunnelMinDistance(vec2 target, out float colorIndex) {colorIndex &#x3D; 1.0;float minDistance &#x3D; 1000.0;for (int i &#x3D; 0; i &lt; TUNNEL_COUNT; i++) {vec2 targetFromDelta &#x3D; target - froms[i];float h &#x3D; clamp(dot(targetFromDelta, toFromDeltas[i])/ dot(toFromDeltas[i], toFromDeltas[i]),0.0, 1.0);float currentDistance &#x3D; -mix(fromRadii[i], toRadii[i], h) + distance(targetFromDelta, toFromDeltas[i] * h);minDistance &#x3D; min(minDistance, currentDistance);}return minDistance;}&#x60;</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/shapes/tunnel.ts#L10">drawables/shapes/tunnel.ts:10</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/shapes/tunnel.ts#L13">drawables/shapes/tunnel.ts:13</a></li>
</ul> </ul>
</aside> </aside>
</section> </section>
@ -408,6 +412,21 @@
</nav> </nav>
<nav class="tsd-navigation secondary menu-sticky"> <nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current"> <ul class="before-current">
<li class=" tsd-kind-class">
<a href="circle.html" class="tsd-kind-icon">Circle</a>
</li>
<li class=" tsd-kind-class">
<a href="circlelight.html" class="tsd-kind-icon">Circle<wbr>Light</a>
</li>
<li class=" tsd-kind-class">
<a href="drawable.html" class="tsd-kind-icon">Drawable</a>
</li>
<li class=" tsd-kind-class">
<a href="flashlight.html" class="tsd-kind-icon">Flashlight</a>
</li>
<li class=" tsd-kind-class">
<a href="invertedtunnel.html" class="tsd-kind-icon">Inverted<wbr>Tunnel</a>
</li>
</ul> </ul>
<ul class="current"> <ul class="current">
<li class="current tsd-kind-class"> <li class="current tsd-kind-class">
@ -444,6 +463,27 @@
</li> </li>
</ul> </ul>
<ul class="after-current"> <ul class="after-current">
<li class=" tsd-kind-interface">
<a href="../interfaces/drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/renderer.html" class="tsd-kind-icon">Renderer</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/runtimesettings.html" class="tsd-kind-icon">Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="../interfaces/startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</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> </ul>
</nav> </nav>
</div> </div>
@ -458,22 +498,19 @@
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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"> <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-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> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <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> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <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> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul> </ul>
</div> </div>
</div> </div>

312
docs/classes/uniformarrayautoscalingprogram.html
View file

@ -1,312 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>UniformArrayAutoScalingProgram | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="uniformarrayautoscalingprogram.html">UniformArrayAutoScalingProgram</a>
</li>
</ul>
<h1>Class UniformArrayAutoScalingProgram</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">UniformArrayAutoScalingProgram</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/iprogram.html" class="tsd-signature-type">IProgram</a></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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="uniformarrayautoscalingprogram.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="uniformarrayautoscalingprogram.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="uniformarrayautoscalingprogram.html#draw" class="tsd-kind-icon">draw</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="uniformarrayautoscalingprogram.html#initialize" class="tsd-kind-icon">initialize</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="uniformarrayautoscalingprogram.html#setdrawingrectangleuv" class="tsd-kind-icon">set<wbr>Drawing<wbr>RectangleUV</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Uniform<wbr>Array<wbr>Auto<wbr>Scaling<wbr>Program<span class="tsd-signature-symbol">(</span>gl<span class="tsd-signature-symbol">: </span><a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="uniformarrayautoscalingprogram.html" class="tsd-signature-type">UniformArrayAutoScalingProgram</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/uniform-array-autoscaling-program.ts#L19">graphics/graphics-library/program/uniform-array-autoscaling-program.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>gl: <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="uniformarrayautoscalingprogram.html" class="tsd-signature-type">UniformArrayAutoScalingProgram</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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">
<p>Implementation of <a href="../interfaces/iprogram.html">IProgram</a>.<a href="../interfaces/iprogram.html#destroy">destroy</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/uniform-array-autoscaling-program.ts#L86">graphics/graphics-library/program/uniform-array-autoscaling-program.ts:86</a></li>
</ul>
</aside>
<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-class">
<a name="draw" class="tsd-anchor"></a>
<h3>draw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">draw<span class="tsd-signature-symbol">(</span>uniforms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</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/48490b3/src/graphics/graphics-library/program/uniform-array-autoscaling-program.ts#L55">graphics/graphics-library/program/uniform-array-autoscaling-program.ts:55</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uniforms: <span class="tsd-signature-symbol">{}</span></h5>
<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">any</span></h5>
</li>
</ul>
</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-class">
<a name="initialize" class="tsd-anchor"></a>
<h3>initialize</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">initialize<span class="tsd-signature-symbol">(</span>shaderSources<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span>, descriptors<span class="tsd-signature-symbol">: </span><a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span>, substitutions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span>, compiler<span class="tsd-signature-symbol">: </span><a href="parallelcompiler.html" class="tsd-signature-type">ParallelCompiler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/uniform-array-autoscaling-program.ts#L23">graphics/graphics-library/program/uniform-array-autoscaling-program.ts:23</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>shaderSources: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]</span></h5>
</li>
<li>
<h5>descriptors: <a href="../interfaces/__global.array.html" class="tsd-signature-type">Array</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/drawabledescriptor.html" class="tsd-signature-type">DrawableDescriptor</a><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>substitutions: <span class="tsd-signature-symbol">{}</span></h5>
<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">any</span></h5>
</li>
</ul>
</li>
<li>
<h5>compiler: <a href="parallelcompiler.html" class="tsd-signature-type">ParallelCompiler</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="setdrawingrectangleuv" class="tsd-anchor"></a>
<h3>set<wbr>Drawing<wbr>RectangleUV</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Drawing<wbr>RectangleUV<span class="tsd-signature-symbol">(</span>bottomLeft<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</span>, size<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/iprogram.html">IProgram</a>.<a href="../interfaces/iprogram.html#setdrawingrectangleuv">setDrawingRectangleUV</a></p>
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/program/uniform-array-autoscaling-program.ts#L50">graphics/graphics-library/program/uniform-array-autoscaling-program.ts:50</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bottomLeft: <span class="tsd-signature-type">vec2</span></h5>
</li>
<li>
<h5>size: <span class="tsd-signature-type">vec2</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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-class">
<a href="uniformarrayautoscalingprogram.html" class="tsd-kind-icon">Uniform<wbr>Array<wbr>Auto<wbr>Scaling<wbr>Program</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="uniformarrayautoscalingprogram.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="uniformarrayautoscalingprogram.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="uniformarrayautoscalingprogram.html#draw" class="tsd-kind-icon">draw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="uniformarrayautoscalingprogram.html#initialize" class="tsd-kind-icon">initialize</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="uniformarrayautoscalingprogram.html#setdrawingrectangleuv" class="tsd-kind-icon">set<wbr>Drawing<wbr>RectangleUV</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

356
docs/classes/uniformsprovider.html
View file

@ -1,356 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>UniformsProvider | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="uniformsprovider.html">UniformsProvider</a>
</li>
</ul>
<h1>Class UniformsProvider</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">UniformsProvider</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="uniformsprovider.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="uniformsprovider.html#_backgroundcolor" class="tsd-kind-icon">_background<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="uniformsprovider.html#ambientlight" class="tsd-kind-icon">ambient<wbr>Light</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-set-signature tsd-parent-kind-class"><a href="uniformsprovider.html#backgroundcolor" class="tsd-kind-icon">background<wbr>Color</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="uniformsprovider.html#getuniforms" class="tsd-kind-icon">get<wbr>Uniforms</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="uniformsprovider.html#getviewarea" class="tsd-kind-icon">get<wbr>View<wbr>Area</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="uniformsprovider.html#screentoworldposition" class="tsd-kind-icon">screen<wbr>ToWorld<wbr>Position</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="uniformsprovider.html#setviewarea" class="tsd-kind-icon">set<wbr>View<wbr>Area</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Uniforms<wbr>Provider<span class="tsd-signature-symbol">(</span>gl<span class="tsd-signature-symbol">: </span><a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="uniformsprovider.html" class="tsd-signature-type">UniformsProvider</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/uniforms-provider.ts#L13">graphics/rendering/uniforms-provider.ts:13</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>gl: <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="uniformsprovider.html" class="tsd-signature-type">UniformsProvider</a></h4>
</li>
</ul>
</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-class">
<a name="_backgroundcolor" class="tsd-anchor"></a>
<h3>_background<wbr>Color</h3>
<div class="tsd-signature tsd-kind-icon">_background<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol"> = vec4.fromValues(1, 1, 1, 1)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/uniforms-provider.ts#L6">graphics/rendering/uniforms-provider.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="ambientlight" class="tsd-anchor"></a>
<h3>ambient<wbr>Light</h3>
<div class="tsd-signature tsd-kind-icon">ambient<wbr>Light<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> = vec3.fromValues(0.25, 0.15, 0.25)</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/uniforms-provider.ts#L5">graphics/rendering/uniforms-provider.ts:5</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-set-signature tsd-parent-kind-class">
<a name="backgroundcolor" class="tsd-anchor"></a>
<h3>background<wbr>Color</h3>
<ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> backgroundColor<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-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/48490b3/src/graphics/rendering/uniforms-provider.ts#L31">graphics/rendering/uniforms-provider.ts:31</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getuniforms" class="tsd-anchor"></a>
<h3>get<wbr>Uniforms</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Uniforms<span class="tsd-signature-symbol">(</span>uniforms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/48490b3/src/graphics/rendering/uniforms-provider.ts#L17">graphics/rendering/uniforms-provider.ts:17</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>uniforms: <span class="tsd-signature-type">any</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getviewarea" class="tsd-anchor"></a>
<h3>get<wbr>View<wbr>Area</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>View<wbr>Area<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/rendering/uniforms-provider.ts#L39">graphics/rendering/uniforms-provider.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec2</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="screentoworldposition" class="tsd-anchor"></a>
<h3>screen<wbr>ToWorld<wbr>Position</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">screen<wbr>ToWorld<wbr>Position<span class="tsd-signature-symbol">(</span>screenPosition<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/48490b3/src/graphics/rendering/uniforms-provider.ts#L80">graphics/rendering/uniforms-provider.ts:80</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>screenPosition: <span class="tsd-signature-type">vec2</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">vec2</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="setviewarea" class="tsd-anchor"></a>
<h3>set<wbr>View<wbr>Area</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>View<wbr>Area<span class="tsd-signature-symbol">(</span>topLeft<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</span>, size<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">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/48490b3/src/graphics/rendering/uniforms-provider.ts#L43">graphics/rendering/uniforms-provider.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>topLeft: <span class="tsd-signature-type">vec2</span></h5>
</li>
<li>
<h5>size: <span class="tsd-signature-type">vec2</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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-class">
<a href="uniformsprovider.html" class="tsd-kind-icon">Uniforms<wbr>Provider</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="uniformsprovider.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="uniformsprovider.html#_backgroundcolor" class="tsd-kind-icon">_background<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="uniformsprovider.html#ambientlight" class="tsd-kind-icon">ambient<wbr>Light</a>
</li>
<li class=" tsd-kind-set-signature tsd-parent-kind-class">
<a href="uniformsprovider.html#backgroundcolor" class="tsd-kind-icon">background<wbr>Color</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="uniformsprovider.html#getuniforms" class="tsd-kind-icon">get<wbr>Uniforms</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="uniformsprovider.html#getviewarea" class="tsd-kind-icon">get<wbr>View<wbr>Area</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="uniformsprovider.html#screentoworldposition" class="tsd-kind-icon">screen<wbr>ToWorld<wbr>Position</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="uniformsprovider.html#setviewarea" class="tsd-kind-icon">set<wbr>View<wbr>Area</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

314
docs/classes/webglstopwatch.html
View file

@ -1,314 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>WebGlStopwatch | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="webglstopwatch.html">WebGlStopwatch</a>
</li>
</ul>
<h1>Class WebGlStopwatch</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">WebGlStopwatch</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="webglstopwatch.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="webglstopwatch.html#isready" class="tsd-kind-icon">is<wbr>Ready</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="webglstopwatch.html#isrunning" class="tsd-kind-icon">is<wbr>Running</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="webglstopwatch.html#resultsinmilliseconds" class="tsd-kind-icon">results<wbr>InMilli<wbr>Seconds</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="webglstopwatch.html#start" class="tsd-kind-icon">start</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="webglstopwatch.html#stop" class="tsd-kind-icon">stop</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="webglstopwatch.html#trygetresults" class="tsd-kind-icon">try<wbr>Get<wbr>Results</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Web<wbr>GlStopwatch<span class="tsd-signature-symbol">(</span>gl<span class="tsd-signature-symbol">: </span><a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="webglstopwatch.html" class="tsd-signature-type">WebGlStopwatch</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/helper/stopwatch.ts#L15">graphics/graphics-library/helper/stopwatch.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>gl: <a href="../globals.html#universalrenderingcontext" class="tsd-signature-type">UniversalRenderingContext</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="webglstopwatch.html" class="tsd-signature-type">WebGlStopwatch</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="isready" class="tsd-anchor"></a>
<h3>is<wbr>Ready</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isReady<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/helper/stopwatch.ts#L63">graphics/graphics-library/helper/stopwatch.ts:63</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="isrunning" class="tsd-anchor"></a>
<h3>is<wbr>Running</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isRunning<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/helper/stopwatch.ts#L67">graphics/graphics-library/helper/stopwatch.ts:67</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="resultsinmilliseconds" class="tsd-anchor"></a>
<h3>results<wbr>InMilli<wbr>Seconds</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> resultsInMilliSeconds<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/48490b3/src/graphics/graphics-library/helper/stopwatch.ts#L71">graphics/graphics-library/helper/stopwatch.ts:71</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="start" class="tsd-anchor"></a>
<h3>start</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/graphics-library/helper/stopwatch.ts#L21">graphics/graphics-library/helper/stopwatch.ts:21</a></li>
</ul>
</aside>
<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-class">
<a name="stop" class="tsd-anchor"></a>
<h3>stop</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">stop<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/graphics-library/helper/stopwatch.ts#L31">graphics/graphics-library/helper/stopwatch.ts:31</a></li>
</ul>
</aside>
<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-class">
<a name="trygetresults" class="tsd-anchor"></a>
<h3>try<wbr>Get<wbr>Results</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">try<wbr>Get<wbr>Results<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/helper/stopwatch.ts#L40">graphics/graphics-library/helper/stopwatch.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</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-class">
<a href="webglstopwatch.html" class="tsd-kind-icon">Web<wbr>GlStopwatch</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="webglstopwatch.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="webglstopwatch.html#isready" class="tsd-kind-icon">is<wbr>Ready</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="webglstopwatch.html#isrunning" class="tsd-kind-icon">is<wbr>Running</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
<a href="webglstopwatch.html#resultsinmilliseconds" class="tsd-kind-icon">results<wbr>InMilli<wbr>Seconds</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="webglstopwatch.html#start" class="tsd-kind-icon">start</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="webglstopwatch.html#stop" class="tsd-kind-icon">stop</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="webglstopwatch.html#trygetresults" class="tsd-kind-icon">try<wbr>Get<wbr>Results</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

179
docs/enums/stopwatchstate.html
View file

@ -1,179 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>StopwatchState | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="stopwatchstate.html">StopwatchState</a>
</li>
</ul>
<h1>Enumeration StopwatchState</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Enumeration members</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="stopwatchstate.html#ready" class="tsd-kind-icon">ready</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="stopwatchstate.html#running" class="tsd-kind-icon">running</a></li>
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="stopwatchstate.html#waitingforresults" class="tsd-kind-icon">waiting<wbr>For<wbr>Results</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Enumeration members</h2>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="ready" class="tsd-anchor"></a>
<h3>ready</h3>
<div class="tsd-signature tsd-kind-icon">ready<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;ready&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/helper/stopwatch.ts#L5">graphics/graphics-library/helper/stopwatch.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="running" class="tsd-anchor"></a>
<h3>running</h3>
<div class="tsd-signature tsd-kind-icon">running<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;running&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/helper/stopwatch.ts#L6">graphics/graphics-library/helper/stopwatch.ts:6</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
<a name="waitingforresults" class="tsd-anchor"></a>
<h3>waiting<wbr>For<wbr>Results</h3>
<div class="tsd-signature tsd-kind-icon">waiting<wbr>For<wbr>Results<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = &quot;waitingForResults&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/graphics-library/helper/stopwatch.ts#L7">graphics/graphics-library/helper/stopwatch.ts:7</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-enum">
<a href="stopwatchstate.html" class="tsd-kind-icon">Stopwatch<wbr>State</a>
<ul>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="stopwatchstate.html#ready" class="tsd-kind-icon">ready</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="stopwatchstate.html#running" class="tsd-kind-icon">running</a>
</li>
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
<a href="stopwatchstate.html#waitingforresults" class="tsd-kind-icon">waiting<wbr>For<wbr>Results</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

876
docs/globals.html
View file

File diff suppressed because it is too large Load diff

189
docs/index.html
View file

@ -3,8 +3,8 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SDF-2D - v0.3.1</title> <title>SDF-2D - v0.3.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1"> <meta name="description" content="Documentation for SDF-2D - v0.3.2">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css"> <link rel="stylesheet" href="assets/css/main.css">
</head> </head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li> <li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li> <li class="state failure">The search index is not available</li>
</ul> </ul>
<a href="index.html" class="title">SDF-2D - v0.3.1</a> <a href="index.html" class="title">SDF-2D - v0.3.2</a>
</div> </div>
<div class="table-cell" id="tsd-widgets"> <div class="table-cell" id="tsd-widgets">
<div id="tsd-filter"> <div id="tsd-filter">
@ -52,7 +52,7 @@
<a href="globals.html">Globals</a> <a href="globals.html">Globals</a>
</li> </li>
</ul> </ul>
<h1>SDF-2D - v0.3.1</h1> <h1>SDF-2D - v0.3.2</h1>
</div> </div>
</div> </div>
</header> </header>
@ -63,7 +63,7 @@
<a href="#-documentation" id="-documentation" style="color: inherit; text-decoration: none;"> <a href="#-documentation" id="-documentation" style="color: inherit; text-decoration: none;">
<h1><img src="media/logo-colored.svg" alt="SDF-2D logo"> Documentation</h1> <h1><img src="media/logo-colored.svg" alt="SDF-2D logo"> Documentation</h1>
</a> </a>
<p>Background and more in depth information about the rendring techniques can be found in <a href="media/sdf-2d.pdf">this technical report</a>.</p> <p>The motivation behind this library and more in-depth information about the rendering techniques utilised can be found in <a href="media/sdf-2d.pdf">this technical report</a>.</p>
<a href="#links" id="links" style="color: inherit; text-decoration: none;"> <a href="#links" id="links" style="color: inherit; text-decoration: none;">
<h2>Links</h2> <h2>Links</h2>
</a> </a>
@ -71,19 +71,44 @@
<li><a href="https://github.com/schmelczerandras/sdf-2d">Repository</a></li> <li><a href="https://github.com/schmelczerandras/sdf-2d">Repository</a></li>
<li><a href="https://sdf2d.schmelczer.dev/">Demo</a></li> <li><a href="https://sdf2d.schmelczer.dev/">Demo</a></li>
<li><a href="https://github.com/schmelczerandras/sdf-2d-minimal-example">Minimal example</a></li> <li><a href="https://github.com/schmelczerandras/sdf-2d-minimal-example">Minimal example</a></li>
<li><a href="https://github.com/schmelczerandras/sdf-2d-minimal-example">More complex example</a></li> <li><a href="https://github.com/schmelczerandras/sdf-2d-more-complex-example">More complex example</a></li>
<li><a href="https://github.com/schmelczerandras/sdf-2d-demo">Source code of the demo</a></li>
</ul> </ul>
<a href="#important-to-know" id="important-to-know" style="color: inherit; text-decoration: none;"> <a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
<h2>Important to know</h2> <h2>Usage</h2>
</a> </a>
<ul>
<li>To start using cutting-edge 2D graphics, first you have get a renderer instance. This is possible by calling the <a href="globals.html#compile">compile function</a>.<ul>
<li>For this, some <a href="interfaces/drawabledescriptor.html">DrawableDescriptors</a> has to be provided.</li>
<li>Optionally, default compile settings can overridden using <a href="interfaces/startupsettings.html">StartupSettings</a>.</li>
</ul>
</li>
<li>After acquiring a renderer, the drawing of objects can be started through the <a href="interfaces/renderer.html">Renderer</a> interface.</li>
</ul>
<a href="#extending-drawables" id="extending-drawables" style="color: inherit; text-decoration: none;">
<h2>Extending drawables</h2>
</a>
<ul>
<li>Subclass <a href="classes/drawable.html">Drawable</a></li>
<li>Implement its abstract methods</li>
<li>Add a static property to your class called <code>descriptor</code> of type <a href="interfaces/drawabledescriptor.html">DrawableDescriptors</a></li>
<li>Follow the instructions given in <a href="#usage">Usage</a></li>
</ul>
<a href="#useful-to-know" id="useful-to-know" style="color: inherit; text-decoration: none;">
<h2>Useful to know</h2>
</a>
<a href="#math" id="math" style="color: inherit; text-decoration: none;">
<h3>Math</h3>
</a>
<p>The <code>vec2</code>, <code>vec3</code>, and <code>vec4</code> types seen in the documentation come from the <a href="http://glmatrix.net/">glMatrix</a> library and are equivalent to regular JS Arrays or Float32Arrays. So, feel free to give <code>[x, y]</code> as an input for functions requiring <code>vec2</code>.</p>
<a href="#coordinates" id="coordinates" style="color: inherit; text-decoration: none;"> <a href="#coordinates" id="coordinates" style="color: inherit; text-decoration: none;">
<h3>Coordinates</h3> <h3>Coordinates</h3>
</a> </a>
<p>Anywhere, where positions need to specified, the <code>y</code> values grow upwards, so are the <code>x</code> values. That means, when specifying the view area, the origin is at the bottom left corner of the display.</p> <p>Anywhere, where positions need to be specified, the <code>y</code> values grow upwards. That means, when setting the view area, the origin is at the bottom left corner of the display.</p>
<a href="#tile-based-rendering" id="tile-based-rendering" style="color: inherit; text-decoration: none;"> <a href="#tile-based-rendering" id="tile-based-rendering" style="color: inherit; text-decoration: none;">
<h3>Tile-based rendering</h3> <h3>Tile-based rendering</h3>
</a> </a>
<p>For optimising the evaluation of the distance field, the display is divided up into a grid of tiles. The shader for each tile is compiled to support a fix maximum number of objects on it. When using the built-in drawables, it is possible that after a certain number of on-screen objects, new ones won&#39;t be visible.</p> <p>For optimising the evaluation of the distance field, the display is divided up into a grid of tiles. The shaders for each tile are compiled to support a fix maximum number of objects on it. When using the built-in drawables it is possible that after a certain number of on-screen objects new ones won&#39;t be visible.</p>
<p>Mitigating this issue is quite easy. Instead of the following code:</p> <p>Mitigating this issue is quite easy. Instead of the following code:</p>
<pre><code class="language-js"><span class="hljs-built_in">this</span>.renderer = <span class="hljs-keyword">await</span> compile(canvas, [Circle.descriptor, CircleLight.descriptor]);</code></pre> <pre><code class="language-js"><span class="hljs-built_in">this</span>.renderer = <span class="hljs-keyword">await</span> compile(canvas, [Circle.descriptor, CircleLight.descriptor]);</code></pre>
<p>Modify it to something similar:</p> <p>Modify it to something similar:</p>
@ -99,12 +124,8 @@
]);</code></pre> ]);</code></pre>
<p>The usage of too large numbers is not advised for compatibility and performance reasons alike.</p> <p>The usage of too large numbers is not advised for compatibility and performance reasons alike.</p>
<blockquote> <blockquote>
<p>Steps are very useful for tile-based rendering, because it is possible for one tile (at a given moment) to be empty or contain just a few objects, while others have a large cluster of objects. The compiled shaders only take into account the necesseary number of objects on each tiles.</p> <p>Steps are very useful for tile-based rendering, because it is possible for one tile (at a given moment) to be empty or contain just a few objects, while others have a large cluster of objects. The compiled shaders only take into account the necessary number of objects on each tile.</p>
</blockquote> </blockquote>
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
<h2>Usage</h2>
</a>
<p>To start using cutting-edge 2D graphics, first you have get a renderer instance. This is possible by calling the <a href="globals.html#compile">compile function</a>.</p>
</div> </div>
</div> </div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@ -113,94 +134,31 @@
<li class="globals "> <li class="globals ">
<a href="globals.html"><em>Globals</em></a> <a href="globals.html"><em>Globals</em></a>
</li> </li>
<li class=" tsd-kind-namespace">
<a href="modules/__global.html">__global</a>
</li>
</ul> </ul>
</nav> </nav>
<nav class="tsd-navigation secondary menu-sticky"> <nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current"> <ul class="before-current">
<li class=" tsd-kind-enum">
<a href="enums/stopwatchstate.html" class="tsd-kind-icon">Stopwatch<wbr>State</a>
</li>
<li class=" tsd-kind-class"> <li class=" tsd-kind-class">
<a href="classes/circle.html" class="tsd-kind-icon">Circle</a> <a href="classes/circle.html" class="tsd-kind-icon">Circle</a>
</li> </li>
<li class=" tsd-kind-class"> <li class=" tsd-kind-class">
<a href="classes/circlelight.html" class="tsd-kind-icon">Circle<wbr>Light</a> <a href="classes/circlelight.html" class="tsd-kind-icon">Circle<wbr>Light</a>
</li> </li>
<li class=" tsd-kind-class">
<a href="classes/contextawarerenderer.html" class="tsd-kind-icon">Context<wbr>Aware<wbr>Renderer</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/defaultframebuffer.html" class="tsd-kind-icon">Default<wbr>Frame<wbr>Buffer</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/distancerenderpass.html" class="tsd-kind-icon">Distance<wbr>Render<wbr>Pass</a>
</li>
<li class=" tsd-kind-class"> <li class=" tsd-kind-class">
<a href="classes/drawable.html" class="tsd-kind-icon">Drawable</a> <a href="classes/drawable.html" class="tsd-kind-icon">Drawable</a>
</li> </li>
<li class=" tsd-kind-class"> <li class=" tsd-kind-class">
<a href="classes/flashlight.html" class="tsd-kind-icon">Flashlight</a> <a href="classes/flashlight.html" class="tsd-kind-icon">Flashlight</a>
</li> </li>
<li class=" tsd-kind-class">
<a href="classes/fpsautoscaler.html" class="tsd-kind-icon">Fps<wbr>Autoscaler</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/fragmentshaderonlyprogram.html" class="tsd-kind-icon">Fragment<wbr>Shader<wbr>Only<wbr>Program</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/framebuffer.html" class="tsd-kind-icon">Frame<wbr>Buffer</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/insights.html" class="tsd-kind-icon">Insights</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/intermediateframebuffer.html" class="tsd-kind-icon">Intermediate<wbr>Frame<wbr>Buffer</a>
</li>
<li class=" tsd-kind-class"> <li class=" tsd-kind-class">
<a href="classes/invertedtunnel.html" class="tsd-kind-icon">Inverted<wbr>Tunnel</a> <a href="classes/invertedtunnel.html" class="tsd-kind-icon">Inverted<wbr>Tunnel</a>
</li> </li>
<li class=" tsd-kind-class">
<a href="classes/lightdrawable.html" class="tsd-kind-icon">Light<wbr>Drawable</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/lightsrenderpass.html" class="tsd-kind-icon">Lights<wbr>Render<wbr>Pass</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/palettetexture.html" class="tsd-kind-icon">Palette<wbr>Texture</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/parallelcompiler.html" class="tsd-kind-icon">Parallel<wbr>Compiler</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/program.html" class="tsd-kind-icon">Program</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/renderpass.html" class="tsd-kind-icon">Render<wbr>Pass</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/rendererimplementation.html" class="tsd-kind-icon">Renderer<wbr>Implementation</a>
</li>
<li class=" tsd-kind-class"> <li class=" tsd-kind-class">
<a href="classes/tunnel.html" class="tsd-kind-icon">Tunnel</a> <a href="classes/tunnel.html" class="tsd-kind-icon">Tunnel</a>
</li> </li>
<li class=" tsd-kind-class">
<a href="classes/uniformarrayautoscalingprogram.html" class="tsd-kind-icon">Uniform<wbr>Array<wbr>Auto<wbr>Scaling<wbr>Program</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/uniformsprovider.html" class="tsd-kind-icon">Uniforms<wbr>Provider</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/webglstopwatch.html" class="tsd-kind-icon">Web<wbr>GlStopwatch</a>
</li>
<li class=" tsd-kind-interface"> <li class=" tsd-kind-interface">
<a href="interfaces/drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a> <a href="interfaces/drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a>
</li> </li>
<li class=" tsd-kind-interface">
<a href="interfaces/iprogram.html" class="tsd-kind-icon">IProgram</a>
</li>
<li class=" tsd-kind-interface"> <li class=" tsd-kind-interface">
<a href="interfaces/renderer.html" class="tsd-kind-icon">Renderer</a> <a href="interfaces/renderer.html" class="tsd-kind-icon">Renderer</a>
</li> </li>
@ -210,75 +168,15 @@
<li class=" tsd-kind-interface"> <li class=" tsd-kind-interface">
<a href="interfaces/startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a> <a href="interfaces/startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
</li> </li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#compilingprogram" class="tsd-kind-icon">Compiling<wbr>Program</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#shaderwithsource" class="tsd-kind-icon">Shader<wbr>With<wbr>Source</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="globals.html#universalrenderingcontext" class="tsd-kind-icon">Universal<wbr>Rendering<wbr>Context</a>
</li>
<li class=" tsd-kind-variable">
<a href="globals.html#isenabled" class="tsd-kind-icon">is<wbr>Enabled</a>
</li>
<li class=" tsd-kind-variable">
<a href="globals.html#loadermat3" class="tsd-kind-icon">loader<wbr>Mat3</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#applyarrayplugins" class="tsd-kind-icon">apply<wbr>Array<wbr>Plugins</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#clamp" class="tsd-kind-icon">clamp</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#clamp01" class="tsd-kind-icon">clamp01</a>
</li>
<li class=" tsd-kind-function"> <li class=" tsd-kind-function">
<a href="globals.html#compile" class="tsd-kind-icon">compile</a> <a href="globals.html#compile" class="tsd-kind-icon">compile</a>
</li> </li>
<li class=" tsd-kind-function"> <li class=" tsd-kind-object-literal">
<a href="globals.html#enablecontextlostsimulator" class="tsd-kind-icon">enable<wbr>Context<wbr>Lost<wbr>Simulator</a> <a href="globals.html#defaultruntimesettings" class="tsd-kind-icon">default<wbr>Runtime<wbr>Settings</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#enableextension" class="tsd-kind-icon">enable<wbr>Extension</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#exponentialdecay" class="tsd-kind-icon">exponential<wbr>Decay</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#getcombinations" class="tsd-kind-icon">get<wbr>Combinations</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#getuniversalrenderingcontext" class="tsd-kind-icon">get<wbr>Universal<wbr>Rendering<wbr>Context</a>
</li>
<li class=" tsd-kind-function tsd-has-type-parameter">
<a href="globals.html#last" class="tsd-kind-icon">last</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#loaduniform" class="tsd-kind-icon">load<wbr>Uniform</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#mix" class="tsd-kind-icon">mix</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#mstostring" class="tsd-kind-icon">ms<wbr>ToString</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#setindexalias" class="tsd-kind-icon">set<wbr>Index<wbr>Alias</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#tryenableextension" class="tsd-kind-icon">try<wbr>Enable<wbr>Extension</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#wait" class="tsd-kind-icon">wait</a>
</li> </li>
<li class=" tsd-kind-object-literal"> <li class=" tsd-kind-object-literal">
<a href="globals.html#defaultstartupsettings" class="tsd-kind-icon">default<wbr>Startup<wbr>Settings</a> <a href="globals.html#defaultstartupsettings" class="tsd-kind-icon">default<wbr>Startup<wbr>Settings</a>
</li> </li>
<li class=" tsd-kind-object-literal">
<a href="globals.html#settings" class="tsd-kind-icon">settings</a>
</li>
</ul> </ul>
</nav> </nav>
</div> </div>
@ -293,22 +191,19 @@
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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"> <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-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> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <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> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <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> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul> </ul>
</div> </div>
</div> </div>

195
docs/interfaces/__global.array.html
View file

@ -1,195 +0,0 @@
<!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.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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, 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>
<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">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/helper/array.ts#L3">helper/array.ts:3</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/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/48490b3/src/helper/array.ts#L4">helper/array.ts:4</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/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">
</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

184
docs/interfaces/__global.float32array.html
View file

@ -1,184 +0,0 @@
<!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.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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/48490b3/src/helper/array.ts#L8">helper/array.ts:8</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/main.ts#L23">main.ts:23</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/48490b3/src/helper/array.ts#L9">helper/array.ts:9</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/main.ts#L24">main.ts:24</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

106
docs/interfaces/drawabledescriptor.html
View file

@ -3,8 +3,8 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DrawableDescriptor | SDF-2D - v0.3.1</title> <title>DrawableDescriptor | SDF-2D - v0.3.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1"> <meta name="description" content="Documentation for SDF-2D - v0.3.2">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/css/main.css">
</head> </head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li> <li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li> <li class="state failure">The search index is not available</li>
</ul> </ul>
<a href="../index.html" class="title">SDF-2D - v0.3.1</a> <a href="../index.html" class="title">SDF-2D - v0.3.2</a>
</div> </div>
<div class="table-cell" id="tsd-widgets"> <div class="table-cell" id="tsd-widgets">
<div id="tsd-filter"> <div id="tsd-filter">
@ -62,6 +62,17 @@
<div class="container container-main"> <div class="container container-main">
<div class="row"> <div class="row">
<div class="col-8 col-content"> <div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Used for containing the required information to compile drawables into
shader code.</p>
</div>
<p>Each <a href="../classes/drawable.html">Drawable</a> must have a static property of this type, called descriptor.</p>
<p>For more information on how to create your own DrawableDescriptor-s, look at the
code of <a href="../classes/circle.html">Circle</a> or <a href="../classes/invertedtunnel.html">InvertedTunnel</a>.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy"> <section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3> <h3>Hierarchy</h3>
<ul class="tsd-hierarchy"> <ul class="tsd-hierarchy">
@ -95,9 +106,15 @@
<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> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable-descriptor.ts#L12">drawables/drawable-descriptor.ts:12</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable-descriptor.ts#L62">drawables/drawable-descriptor.ts:62</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>When no shaderCombinationStep matches the current number of drawables exactly,
the value of <code>empty</code> is used to pad out arrays.</p>
</div>
</div>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="propertyuniformmapping" class="tsd-anchor"></a> <a name="propertyuniformmapping" class="tsd-anchor"></a>
@ -105,9 +122,15 @@
<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> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable-descriptor.ts#L4">drawables/drawable-descriptor.ts:4</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable-descriptor.ts#L17">drawables/drawable-descriptor.ts:17</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An object describing the relationship between the object returned by a <a href="../classes/drawable.html">Drawable</a>&#39;s
getObjectToSerialize and the name of the arrays used in the GLSL code.</p>
</div>
</div>
<div class="tsd-type-declaration"> <div class="tsd-type-declaration">
<h4>Type declaration</h4> <h4>Type declaration</h4>
<ul class="tsd-parameters"> <ul class="tsd-parameters">
@ -123,19 +146,31 @@
<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> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable-descriptor.ts#L6">drawables/drawable-descriptor.ts:6</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable-descriptor.ts#L28">drawables/drawable-descriptor.ts:28</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Required property for shapes having physical dimensions.</p>
</div>
</div>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="shadercombinationsteps" class="tsd-anchor"></a> <a name="shadercombinationsteps" class="tsd-anchor"></a>
<h3>shader<wbr>Combination<wbr>Steps</h3> <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> <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> <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>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable-descriptor.ts#L11">drawables/drawable-descriptor.ts:11</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable-descriptor.ts#L56">drawables/drawable-descriptor.ts:56</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Number of possible drawables around each tile.</p>
</div>
<p>For each step, a shader will be generated. And at runtime the closes matching
shader will be used to render a given part of the scene.</p>
</div>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="uniformcountmacroname" class="tsd-anchor"></a> <a name="uniformcountmacroname" class="tsd-anchor"></a>
@ -143,9 +178,15 @@
<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> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/drawables/drawable-descriptor.ts#L5">drawables/drawable-descriptor.ts:5</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/drawables/drawable-descriptor.ts#L23">drawables/drawable-descriptor.ts:23</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The name of the uniform int used in the code to refer to the
number of drawables of this type.</p>
</div>
</div>
</section> </section>
</section> </section>
</div> </div>
@ -159,6 +200,24 @@
</nav> </nav>
<nav class="tsd-navigation secondary menu-sticky"> <nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current"> <ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/circle.html" class="tsd-kind-icon">Circle</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/flashlight.html" class="tsd-kind-icon">Flashlight</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/invertedtunnel.html" class="tsd-kind-icon">Inverted<wbr>Tunnel</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/tunnel.html" class="tsd-kind-icon">Tunnel</a>
</li>
</ul> </ul>
<ul class="current"> <ul class="current">
<li class="current tsd-kind-interface"> <li class="current tsd-kind-interface">
@ -183,6 +242,24 @@
</li> </li>
</ul> </ul>
<ul class="after-current"> <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-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</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> </ul>
</nav> </nav>
</div> </div>
@ -197,22 +274,19 @@
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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"> <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-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> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <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> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <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> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul> </ul>
</div> </div>
</div> </div>

236
docs/interfaces/iprogram.html
View file

@ -1,236 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IProgram | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="iprogram.html">IProgram</a>
</li>
</ul>
<h1>Interface IProgram</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">IProgram</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/fragmentshaderonlyprogram.html" class="tsd-signature-type">FragmentShaderOnlyProgram</a></li>
<li><a href="../classes/program.html" class="tsd-signature-type">Program</a></li>
<li><a href="../classes/uniformarrayautoscalingprogram.html" class="tsd-signature-type">UniformArrayAutoScalingProgram</a></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>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="iprogram.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="iprogram.html#draw" class="tsd-kind-icon">draw</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="iprogram.html#setdrawingrectangleuv" class="tsd-kind-icon">set<wbr>Drawing<wbr>RectangleUV</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="destroy" class="tsd-anchor"></a>
<h3>destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</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/48490b3/src/graphics/graphics-library/program/i-program.ts#L6">graphics/graphics-library/program/i-program.ts:6</a></li>
</ul>
</aside>
<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="draw" class="tsd-anchor"></a>
<h3>draw</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">draw<span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</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/48490b3/src/graphics/graphics-library/program/i-program.ts#L5">graphics/graphics-library/program/i-program.ts:5</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>values: <span class="tsd-signature-symbol">{}</span></h5>
<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">any</span></h5>
</li>
</ul>
</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="setdrawingrectangleuv" class="tsd-anchor"></a>
<h3>set<wbr>Drawing<wbr>RectangleUV</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">set<wbr>Drawing<wbr>RectangleUV<span class="tsd-signature-symbol">(</span>bottomLeft<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">vec2</span>, size<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">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/48490b3/src/graphics/graphics-library/program/i-program.ts#L4">graphics/graphics-library/program/i-program.ts:4</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bottomLeft: <span class="tsd-signature-type">vec2</span></h5>
</li>
<li>
<h5>size: <span class="tsd-signature-type">vec2</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</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="iprogram.html" class="tsd-kind-icon">IProgram</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="iprogram.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="iprogram.html#draw" class="tsd-kind-icon">draw</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="iprogram.html#setdrawingrectangleuv" class="tsd-kind-icon">set<wbr>Drawing<wbr>RectangleUV</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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

177
docs/interfaces/renderer.html
View file

@ -3,8 +3,8 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Renderer | SDF-2D - v0.3.1</title> <title>Renderer | SDF-2D - v0.3.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1"> <meta name="description" content="Documentation for SDF-2D - v0.3.2">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/css/main.css">
</head> </head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li> <li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li> <li class="state failure">The search index is not available</li>
</ul> </ul>
<a href="../index.html" class="title">SDF-2D - v0.3.1</a> <a href="../index.html" class="title">SDF-2D - v0.3.2</a>
</div> </div>
<div class="table-cell" id="tsd-widgets"> <div class="table-cell" id="tsd-widgets">
<div id="tsd-filter"> <div id="tsd-filter">
@ -62,6 +62,14 @@
<div class="container container-main"> <div class="container container-main">
<div class="row"> <div class="row">
<div class="col-8 col-content"> <div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The main interface through which rendering can be achieved.</p>
</div>
<p>Multiple renderers are permitted on a single page.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy"> <section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3> <h3>Hierarchy</h3>
<ul class="tsd-hierarchy"> <ul class="tsd-hierarchy">
@ -70,13 +78,6 @@
</li> </li>
</ul> </ul>
</section> </section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/contextawarerenderer.html" class="tsd-signature-type">ContextAwareRenderer</a></li>
<li><a href="../classes/rendererimplementation.html" class="tsd-signature-type">RendererImplementation</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group"> <section class="tsd-panel-group tsd-index-group">
<h2>Index</h2> <h2>Index</h2>
<section class="tsd-panel tsd-index-panel"> <section class="tsd-panel tsd-index-panel">
@ -92,7 +93,7 @@
<section class="tsd-index-section "> <section class="tsd-index-section ">
<h3>Methods</h3> <h3>Methods</h3>
<ul class="tsd-index-list"> <ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="renderer.html#adddrawable" class="tsd-kind-icon">add<wbr>Drawable</a></li> <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#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#destroy" class="tsd-kind-icon">destroy</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#renderdrawables" class="tsd-kind-icon">render<wbr>Drawables</a></li>
@ -111,9 +112,14 @@
<div class="tsd-signature tsd-kind-icon">canvas<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec2</span></div> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer.ts#L6">graphics/rendering/renderer/renderer.ts:6</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/renderer/renderer.ts#L14">graphics/rendering/renderer/renderer.ts:14</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the actual resolution of the canvas.</p>
</div>
</div>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="insights" class="tsd-anchor"></a> <a name="insights" class="tsd-anchor"></a>
@ -121,9 +127,18 @@
<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> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer.ts#L8">graphics/rendering/renderer/renderer.ts:8</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/renderer/renderer.ts#L69">graphics/rendering/renderer/renderer.ts:69</a></li>
</ul> </ul>
</aside> </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>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="viewareasize" class="tsd-anchor"></a> <a name="viewareasize" class="tsd-anchor"></a>
@ -131,30 +146,51 @@
<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> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer.ts#L7">graphics/rendering/renderer/renderer.ts:7</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/renderer/renderer.ts#L21">graphics/rendering/renderer/renderer.ts:21</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the viewArea size set by the last <code>setViewArea</code>.</p>
</div>
<p>By default, <code>canvasSize</code> is used for the view area size.</p>
</div>
</section> </section>
</section> </section>
<section class="tsd-panel-group tsd-member-group "> <section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2> <h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter">
<a name="adddrawable" class="tsd-anchor"></a> <a name="adddrawable" class="tsd-anchor"></a>
<h3>add<wbr>Drawable</h3> <h3>add<wbr>Drawable</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">add<wbr>Drawable<span class="tsd-signature-symbol">(</span>drawable<span class="tsd-signature-symbol">: </span><a href="../classes/drawable.html" class="tsd-signature-type">Drawable</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> <li class="tsd-signature tsd-kind-icon">add<wbr>Drawable&lt;T&gt;<span class="tsd-signature-symbol">(</span>drawable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul> </ul>
<ul class="tsd-descriptions"> <ul class="tsd-descriptions">
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer.ts#L12">graphics/rendering/renderer/renderer.ts:12</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/renderer/renderer.ts#L44">graphics/rendering/renderer/renderer.ts:44</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Schedule a drawable to be rendered during the next <code>renderDrawables</code> call.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="../classes/drawable.html" class="tsd-signature-type">Drawable</a></h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters"> <ul class="tsd-parameters">
<li> <li>
<h5>drawable: <a href="../classes/drawable.html" class="tsd-signature-type">Drawable</a></h5> <h5>drawable: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<p>Must be a subclass of drawable and its class must contain a
static descriptor property of type <a href="drawabledescriptor.html">DrawableDescriptor</a>.</p>
</div>
</li> </li>
</ul> </ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@ -171,13 +207,24 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer.ts#L13">graphics/rendering/renderer/renderer.ts:13</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/renderer/renderer.ts#L79">graphics/rendering/renderer/renderer.ts:79</a></li>
</ul> </ul>
</aside> </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> <h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters"> <ul class="tsd-parameters">
<li> <li>
<h5>deltaTime: <span class="tsd-signature-type">DOMHighResTimeStamp</span></h5> <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> </li>
</ul> </ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@ -194,9 +241,16 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer.ts#L15">graphics/rendering/renderer/renderer.ts:15</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/renderer/renderer.ts#L60">graphics/rendering/renderer/renderer.ts:60</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Let go of every GPU resource held by the renderer.</p>
</div>
<p>It&#39;s up to the browser and driver whether these resources are actually freed.
Nonetheless, when a renderer is no longer needed, this method should be called.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li> </li>
</ul> </ul>
@ -211,9 +265,16 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/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/49473bf/src/graphics/rendering/renderer/renderer.ts#L52">graphics/rendering/renderer/renderer.ts:52</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Render every drawable added since the last <code>renderDrawables</code> call.</p>
</div>
<p>Resizing of framebuffers and the canvas also takes effect
when calling <code>renderDrawables</code>.</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li> </li>
</ul> </ul>
@ -228,13 +289,20 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer.ts#L11">graphics/rendering/renderer/renderer.ts:11</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/renderer/renderer.ts#L36">graphics/rendering/renderer/renderer.ts:36</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Patch the current runtime settings with new values.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters"> <ul class="tsd-parameters">
<li> <li>
<h5>overrides: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="runtimesettings.html" class="tsd-signature-type">RuntimeSettings</a><span class="tsd-signature-symbol">&gt;</span></h5> <h5>overrides: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="runtimesettings.html" class="tsd-signature-type">RuntimeSettings</a><span class="tsd-signature-symbol">&gt;</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li> </li>
</ul> </ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@ -251,16 +319,28 @@
<li class="tsd-description"> <li class="tsd-description">
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/renderer/renderer.ts#L10">graphics/rendering/renderer/renderer.ts:10</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/renderer/renderer.ts#L30">graphics/rendering/renderer/renderer.ts:30</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set the camera transformation.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4> <h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters"> <ul class="tsd-parameters">
<li> <li>
<h5>topLeft: <span class="tsd-signature-type">vec2</span></h5> <h5>topLeft: <span class="tsd-signature-type">vec2</span></h5>
<div class="tsd-comment tsd-typography">
<p>top (!) left. By default, equals to [0, canvasHeight].</p>
</div>
</li> </li>
<li> <li>
<h5>size: <span class="tsd-signature-type">vec2</span></h5> <h5>size: <span class="tsd-signature-type">vec2</span></h5>
<div class="tsd-comment tsd-typography">
<p>need not be equal to the canvas size, though their aspect ratio
should be the same to avoid stretching.</p>
</div>
</li> </li>
</ul> </ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@ -279,6 +359,27 @@
</nav> </nav>
<nav class="tsd-navigation secondary menu-sticky"> <nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current"> <ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/circle.html" class="tsd-kind-icon">Circle</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/flashlight.html" class="tsd-kind-icon">Flashlight</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/invertedtunnel.html" class="tsd-kind-icon">Inverted<wbr>Tunnel</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/tunnel.html" class="tsd-kind-icon">Tunnel</a>
</li>
<li class=" tsd-kind-interface">
<a href="drawabledescriptor.html" class="tsd-kind-icon">Drawable<wbr>Descriptor</a>
</li>
</ul> </ul>
<ul class="current"> <ul class="current">
<li class="current tsd-kind-interface"> <li class="current tsd-kind-interface">
@ -293,7 +394,7 @@
<li class=" tsd-kind-property tsd-parent-kind-interface"> <li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="renderer.html#viewareasize" class="tsd-kind-icon">view<wbr>Area<wbr>Size</a> <a href="renderer.html#viewareasize" class="tsd-kind-icon">view<wbr>Area<wbr>Size</a>
</li> </li>
<li class=" tsd-kind-method tsd-parent-kind-interface"> <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> <a href="renderer.html#adddrawable" class="tsd-kind-icon">add<wbr>Drawable</a>
</li> </li>
<li class=" tsd-kind-method tsd-parent-kind-interface"> <li class=" tsd-kind-method tsd-parent-kind-interface">
@ -315,6 +416,21 @@
</li> </li>
</ul> </ul>
<ul class="after-current"> <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-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</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> </ul>
</nav> </nav>
</div> </div>
@ -329,22 +445,19 @@
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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"> <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-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> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <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> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <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> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul> </ul>
</div> </div>
</div> </div>

125
docs/interfaces/runtimesettings.html
View file

@ -3,8 +3,8 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RuntimeSettings | SDF-2D - v0.3.1</title> <title>RuntimeSettings | SDF-2D - v0.3.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1"> <meta name="description" content="Documentation for SDF-2D - v0.3.2">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/css/main.css">
</head> </head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li> <li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li> <li class="state failure">The search index is not available</li>
</ul> </ul>
<a href="../index.html" class="title">SDF-2D - v0.3.1</a> <a href="../index.html" class="title">SDF-2D - v0.3.2</a>
</div> </div>
<div class="table-cell" id="tsd-widgets"> <div class="table-cell" id="tsd-widgets">
<div id="tsd-filter"> <div id="tsd-filter">
@ -62,6 +62,15 @@
<div class="container container-main"> <div class="container container-main">
<div class="row"> <div class="row">
<div class="col-8 col-content"> <div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface for a configuration object containing the settings
that can be changed during runtime.</p>
</div>
<p>The default values for RuntimeSettings can be found in <a href="../globals.html#defaultruntimesettings">defaultRuntimeSettings</a>.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy"> <section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3> <h3>Hierarchy</h3>
<ul class="tsd-hierarchy"> <ul class="tsd-hierarchy">
@ -97,9 +106,14 @@
<div class="tsd-signature tsd-kind-icon">ambient<wbr>Light<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec3</span></div> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/settings/runtime-settings.ts#L10">graphics/rendering/settings/runtime-settings.ts:10</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/settings/runtime-settings.ts#L58">graphics/rendering/settings/runtime-settings.ts:58</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A light affecting every pixel (even the ones inside objects).</p>
</div>
</div>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="backgroundcolor" class="tsd-anchor"></a> <a name="backgroundcolor" class="tsd-anchor"></a>
@ -107,19 +121,32 @@
<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> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/settings/runtime-settings.ts#L8">graphics/rendering/settings/runtime-settings.ts:8</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/settings/runtime-settings.ts#L43">graphics/rendering/settings/runtime-settings.ts:43</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The default background color of the scene, can have transparency.</p>
</div>
</div>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="colorpalette" class="tsd-anchor"></a> <a name="colorpalette" class="tsd-anchor"></a>
<h3>color<wbr>Palette</h3> <h3>color<wbr>Palette</h3>
<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> <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>
<aside class="tsd-sources"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/settings/runtime-settings.ts#L9">graphics/rendering/settings/runtime-settings.ts:9</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/settings/runtime-settings.ts#L53">graphics/rendering/settings/runtime-settings.ts:53</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Its length should be less than the one specified in <a href="startupsettings.html">StartupSettings</a>.paletteSize.</p>
</div>
<p>The possible colors for the objects. Each color is referenced by its index in the
palette.</p>
<p>Can have transparency.</p>
</div>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="enablehighdpirendering" class="tsd-anchor"></a> <a name="enablehighdpirendering" class="tsd-anchor"></a>
@ -127,9 +154,14 @@
<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> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/settings/runtime-settings.ts#L4">graphics/rendering/settings/runtime-settings.ts:4</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/settings/runtime-settings.ts#L13">graphics/rendering/settings/runtime-settings.ts:13</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>When set to <code>true</code> rendering will be done on the screen&#39;s real resolution.</p>
</div>
</div>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="isworldinverted" class="tsd-anchor"></a> <a name="isworldinverted" class="tsd-anchor"></a>
@ -137,9 +169,16 @@
<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> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/settings/runtime-settings.ts#L6">graphics/rendering/settings/runtime-settings.ts:6</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/settings/runtime-settings.ts#L32">graphics/rendering/settings/runtime-settings.ts:32</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>By default, every pixel is outside of objects. Flipping this value to <code>true</code> will
result in every pixel being inside a large object. From then it only makes sense to
draw inverted objects.</p>
</div>
</div>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="lightcutoffdistance" class="tsd-anchor"></a> <a name="lightcutoffdistance" class="tsd-anchor"></a>
@ -147,9 +186,15 @@
<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> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/settings/runtime-settings.ts#L7">graphics/rendering/settings/runtime-settings.ts:7</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/settings/runtime-settings.ts#L38">graphics/rendering/settings/runtime-settings.ts:38</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>When lights reach the end of the display, they are slowly faded out. The length
of this phaseout can be set through this value.</p>
</div>
</div>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="tilemultiplier" class="tsd-anchor"></a> <a name="tilemultiplier" class="tsd-anchor"></a>
@ -157,9 +202,20 @@
<div class="tsd-signature tsd-kind-icon">tile<wbr>Multiplier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/settings/runtime-settings.ts#L5">graphics/rendering/settings/runtime-settings.ts:5</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/settings/runtime-settings.ts#L25">graphics/rendering/settings/runtime-settings.ts:25</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>First, the SDF of the scene is evaluated at every single pixel.
For speeding this process up, the screen is divided up into tiles,
this way each having to deal with a fewer objects.</p>
</div>
<p>For each tile, it is decided which objects are near its close vicinity.
This comes with some overhead for the CPU, while saving the GPU from loads of
calculations. The workload can be balanced between the CPU and the GPU by setting
this number.</p>
</div>
</section> </section>
</section> </section>
</div> </div>
@ -173,6 +229,30 @@
</nav> </nav>
<nav class="tsd-navigation secondary menu-sticky"> <nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current"> <ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/circle.html" class="tsd-kind-icon">Circle</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/flashlight.html" class="tsd-kind-icon">Flashlight</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/invertedtunnel.html" class="tsd-kind-icon">Inverted<wbr>Tunnel</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/tunnel.html" class="tsd-kind-icon">Tunnel</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="renderer.html" class="tsd-kind-icon">Renderer</a>
</li>
</ul> </ul>
<ul class="current"> <ul class="current">
<li class="current tsd-kind-interface"> <li class="current tsd-kind-interface">
@ -203,6 +283,18 @@
</li> </li>
</ul> </ul>
<ul class="after-current"> <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-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</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> </ul>
</nav> </nav>
</div> </div>
@ -217,22 +309,19 @@
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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"> <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-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> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <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> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <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> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul> </ul>
</div> </div>
</div> </div>

91
docs/interfaces/startupsettings.html
View file

@ -3,8 +3,8 @@
<head> <head>
<meta charset="utf-8"> <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>StartupSettings | SDF-2D - v0.3.1</title> <title>StartupSettings | SDF-2D - v0.3.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1"> <meta name="description" content="Documentation for SDF-2D - v0.3.2">
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../assets/css/main.css">
</head> </head>
@ -22,7 +22,7 @@
<li class="state loading">Preparing search index...</li> <li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li> <li class="state failure">The search index is not available</li>
</ul> </ul>
<a href="../index.html" class="title">SDF-2D - v0.3.1</a> <a href="../index.html" class="title">SDF-2D - v0.3.2</a>
</div> </div>
<div class="table-cell" id="tsd-widgets"> <div class="table-cell" id="tsd-widgets">
<div id="tsd-filter"> <div id="tsd-filter">
@ -62,6 +62,15 @@
<div class="container container-main"> <div class="container container-main">
<div class="row"> <div class="row">
<div class="col-8 col-content"> <div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Interface for a configuration object containing the settings
that need to be given before shader compilation.</p>
</div>
<p>The default values for StartupSettings can be found in <a href="../globals.html#defaultstartupsettings">defaultStartupSettings</a>.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy"> <section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3> <h3>Hierarchy</h3>
<ul class="tsd-hierarchy"> <ul class="tsd-hierarchy">
@ -93,9 +102,16 @@
<div class="tsd-signature tsd-kind-icon">ignore<wbr>WebGL2<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/settings/startup-settings.ts#L4">graphics/rendering/settings/startup-settings.ts:4</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/settings/startup-settings.ts#L32">graphics/rendering/settings/startup-settings.ts:32</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>When set to <code>true</code>, rendering will fall back to WebGL
even when WebGL2 is present.</p>
</div>
<p>Useful for testing compatibility.</p>
</div>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="palettesize" class="tsd-anchor"></a> <a name="palettesize" class="tsd-anchor"></a>
@ -103,9 +119,17 @@
<div class="tsd-signature tsd-kind-icon">palette<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/settings/startup-settings.ts#L3">graphics/rendering/settings/startup-settings.ts:3</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/settings/startup-settings.ts#L24">graphics/rendering/settings/startup-settings.ts:24</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Gives the number of possible object colors for the scene.</p>
</div>
<p>When using WebGL, only 256 different colors can be used.
On WebGL2, its value should not be larger than 4096 for
maintaining compatibility with low-end devices.</p>
</div>
</section> </section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="shadowtracecount" class="tsd-anchor"></a> <a name="shadowtracecount" class="tsd-anchor"></a>
@ -113,9 +137,17 @@
<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> <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"> <aside class="tsd-sources">
<ul> <ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/48490b3/src/graphics/rendering/settings/startup-settings.ts#L2">graphics/rendering/settings/startup-settings.ts:2</a></li> <li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/49473bf/src/graphics/rendering/settings/startup-settings.ts#L15">graphics/rendering/settings/startup-settings.ts:15</a></li>
</ul> </ul>
</aside> </aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The raytracing algorithm used for shadows requires a step count.
Sensible values for this are between 8 and 32.</p>
</div>
<p>The higher the number, the harder the shadows will get.
Some ambient occlusion like effects can be visible on lower trace counts.</p>
</div>
</section> </section>
</section> </section>
</div> </div>
@ -129,6 +161,33 @@
</nav> </nav>
<nav class="tsd-navigation secondary menu-sticky"> <nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current"> <ul class="before-current">
<li class=" tsd-kind-class">
<a href="../classes/circle.html" class="tsd-kind-icon">Circle</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/flashlight.html" class="tsd-kind-icon">Flashlight</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/invertedtunnel.html" class="tsd-kind-icon">Inverted<wbr>Tunnel</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/tunnel.html" class="tsd-kind-icon">Tunnel</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="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>
<ul class="current"> <ul class="current">
<li class="current tsd-kind-interface"> <li class="current tsd-kind-interface">
@ -147,6 +206,15 @@
</li> </li>
</ul> </ul>
<ul class="after-current"> <ul class="after-current">
<li class=" tsd-kind-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</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> </ul>
</nav> </nav>
</div> </div>
@ -161,22 +229,19 @@
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</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> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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"> <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-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> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <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> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
</ul> </ul>
<ul class="tsd-legend"> <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> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul> </ul>
</div> </div>
</div> </div>

136
docs/modules/__global.html
View file

@ -1,136 +0,0 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>__global | SDF-2D - v0.3.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</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.3.1</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="__global.html">__global</a>
</li>
</ul>
<h1>Namespace __global</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-namespace tsd-has-type-parameter"><a href="../interfaces/__global.array.html" class="tsd-kind-icon">Array</a></li>
<li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/__global.float32array.html" class="tsd-kind-icon">Float32<wbr>Array</a></li>
</ul>
</section>
</div>
</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="__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="../interfaces/__global.array.html" class="tsd-kind-icon">Array</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-namespace">
<a href="../interfaces/__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-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<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-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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>

64
documentation-readme.md Normal file
View file

@ -0,0 +1,64 @@
# ![SDF-2D logo](media/logo-colored.svg) Documentation
The motivation behind this library and more in-depth information about the rendering techniques utilised can be found in [this technical report](media/sdf-2d.pdf).
## Links
- [Repository](https://github.com/schmelczerandras/sdf-2d)
- [Demo](https://sdf2d.schmelczer.dev/)
- [Minimal example](https://github.com/schmelczerandras/sdf-2d-minimal-example)
- [More complex example](https://github.com/schmelczerandras/sdf-2d-more-complex-example)
- [Source code of the demo](https://github.com/schmelczerandras/sdf-2d-demo)
## Usage
- To start using cutting-edge 2D graphics, first you have get a renderer instance. This is possible by calling the [compile function](globals.html#compile).
- For this, some [DrawableDescriptors](interfaces/drawabledescriptor.html) has to be provided.
- Optionally, default compile settings can overridden using [StartupSettings](interfaces/startupsettings.html).
- After acquiring a renderer, the drawing of objects can be started through the [Renderer](interfaces/renderer.html) interface.
## Extending drawables
- Subclass [Drawable](classes/drawable.html)
- Implement its abstract methods
- Add a static property to your class called `descriptor` of type [DrawableDescriptors](interfaces/drawabledescriptor.html)
- Follow the instructions given in [Usage](#usage)
## Useful to know
### Math
The `vec2`, `vec3`, and `vec4` types seen in the documentation come from the [glMatrix](http://glmatrix.net/) library and are equivalent to regular JS Arrays or Float32Arrays. So, feel free to give `[x, y]` as an input for functions requiring `vec2`.
### Coordinates
Anywhere, where positions need to be specified, the `y` values grow upwards. That means, when setting the view area, the origin is at the bottom left corner of the display.
### Tile-based rendering
For optimising the evaluation of the distance field, the display is divided up into a grid of tiles. The shaders for each tile are compiled to support a fix maximum number of objects on it. When using the built-in drawables it is possible that after a certain number of on-screen objects new ones won't be visible.
Mitigating this issue is quite easy. Instead of the following code:
```js
this.renderer = await compile(canvas, [Circle.descriptor, CircleLight.descriptor]);
```
Modify it to something similar:
```js
this.renderer = await compile(canvas, [
{
...Circle.descriptor,
shaderCombinationSteps: [0, 1, 2, 24, 64],
},
{
...CircleLight.descriptor,
shaderCombinationSteps: [0, 1, 2, 4],
},
]);
```
The usage of too large numbers is not advised for compatibility and performance reasons alike.
> Steps are very useful for tile-based rendering, because it is possible for one tile (at a given moment) to be empty or contain just a few objects, while others have a large cluster of objects. The compiled shaders only take into account the necessary number of objects on each tile.

2
package.json
View file

@ -1,6 +1,6 @@
{ {
"name": "sdf-2d", "name": "sdf-2d",
"version": "0.3.1", "version": "0.3.2",
"description": "Graphics framework for efficiently rendering 2D signed distance fields.", "description": "Graphics framework for efficiently rendering 2D signed distance fields.",
"keywords": [ "keywords": [
"webgl", "webgl",

52
src/drawables/drawable-descriptor.ts
View file

@ -1,13 +1,63 @@
import { Drawable } from './drawable'; import { Drawable } from './drawable';
/**
* Used for containing the required information to compile drawables into
* shader code.
*
* Each [[Drawable]] must have a static property of this type, called descriptor.
*
* For more information on how to create your own DrawableDescriptor-s, look at the
* code of [[Circle]] or [[InvertedTunnel]].
*/
export interface DrawableDescriptor { export interface DrawableDescriptor {
/**
* An object describing the relationship between the object returned by a [[Drawable]]'s
* getObjectToSerialize and the name of the arrays used in the GLSL code.
*/
propertyUniformMapping: { [property: string]: string }; propertyUniformMapping: { [property: string]: string };
/**
* The name of the uniform int used in the code to refer to the
* number of drawables of this type.
*/
uniformCountMacroName: string; uniformCountMacroName: string;
/**
* Required property for shapes having physical dimensions.
*/
sdf?: { sdf?: {
/**
* The actual GLSL code for observing the drawables represented by this descriptor.
*
* Your code should work with both version 100 and version 300 es
*/
shader: string; shader: string;
isInverted?: boolean; /**
* The name of the function defined in the value of `shader`.
* Its signature should look like this:
* ```glsl
* float (in vec2 target, out float colorIndex)
* ```
*/
distanceFunctionName: string; distanceFunctionName: string;
/**
* By default, drawables are not inverted.
*/
isInverted?: boolean;
}; };
/**
* Number of possible drawables around each tile.
*
* For each step, a shader will be generated. And at runtime the closes matching
* shader will be used to render a given part of the scene.
*/
shaderCombinationSteps: Array<number>; shaderCombinationSteps: Array<number>;
/**
* When no shaderCombinationStep matches the current number of drawables exactly,
* the value of `empty` is used to pad out arrays.
*/
readonly empty: Drawable; readonly empty: Drawable;
} }

27
src/drawables/drawable.ts
View file

@ -1,11 +1,36 @@
import { mat2d, vec2 } from 'gl-matrix'; import { mat2d, vec2 } from 'gl-matrix';
import { DrawableDescriptor } from './drawable-descriptor'; import { DrawableDescriptor } from './drawable-descriptor';
/**
* Base class of every drawable object.
*
* To create your own drawables, you need to subclass from this.
*
* > Although lights are also subclasses of Drawable, you cannot create your own light sources.
*/
export abstract class Drawable { export abstract class Drawable {
// This should be overriden by inherited classes /**
* This should be defined in inherited classes.
*/
public static readonly descriptor: DrawableDescriptor; public static readonly descriptor: DrawableDescriptor;
/**
* The lower bound of the distance between the target and the object.
*
* It can return 0 by default, the only consequence of this, is a reduced performance.
* Because this object won't benefit from tile-based rendering.
* @param target
*/
public abstract minDistance(target: vec2): number; public abstract minDistance(target: vec2): number;
/**
* Return the values that should be given to the shaders through uniform inputs.
*
* @param transform2d position-like properties should be transformed by this matrix
* before being returned.
* @param transform1d scalar properties should be transformed by this number
* before being returned.
*/
protected abstract getObjectToSerialize(transform2d: mat2d, transform1d: number): any; protected abstract getObjectToSerialize(transform2d: mat2d, transform1d: number): any;
public serializeToUniforms( public serializeToUniforms(

3
src/drawables/lights/circle-light.ts
View file

@ -2,6 +2,9 @@ import { vec2, vec3 } from 'gl-matrix';
import { DrawableDescriptor } from '../drawable-descriptor'; import { DrawableDescriptor } from '../drawable-descriptor';
import { LightDrawable } from './light-drawable'; import { LightDrawable } from './light-drawable';
/**
* @category Drawable
*/
export class CircleLight extends LightDrawable { export class CircleLight extends LightDrawable {
public static readonly descriptor: DrawableDescriptor = { public static readonly descriptor: DrawableDescriptor = {
propertyUniformMapping: { propertyUniformMapping: {

3
src/drawables/lights/flashlight.ts
View file

@ -2,6 +2,9 @@ import { mat2d, vec2, vec3 } from 'gl-matrix';
import { DrawableDescriptor } from '../drawable-descriptor'; import { DrawableDescriptor } from '../drawable-descriptor';
import { LightDrawable } from './light-drawable'; import { LightDrawable } from './light-drawable';
/**
* @category Drawable
*/
export class Flashlight extends LightDrawable { export class Flashlight extends LightDrawable {
public static readonly descriptor: DrawableDescriptor = { public static readonly descriptor: DrawableDescriptor = {
propertyUniformMapping: { propertyUniformMapping: {

1
src/drawables/lights/light-drawable.ts
View file

@ -1,6 +1,7 @@
import { mat2d, vec2, vec3 } from 'gl-matrix'; import { mat2d, vec2, vec3 } from 'gl-matrix';
import { Drawable } from '../../main'; import { Drawable } from '../../main';
/** @internal */
export class LightDrawable extends Drawable { export class LightDrawable extends Drawable {
protected lightnessRatio = 1; protected lightnessRatio = 1;

3
src/drawables/shapes/circle.ts
View file

@ -2,6 +2,9 @@ import { mat2d, vec2 } from 'gl-matrix';
import { Drawable } from '../drawable'; import { Drawable } from '../drawable';
import { DrawableDescriptor } from '../drawable-descriptor'; import { DrawableDescriptor } from '../drawable-descriptor';
/**
* @category Drawable
*/
export class Circle extends Drawable { export class Circle extends Drawable {
public static descriptor: DrawableDescriptor = { public static descriptor: DrawableDescriptor = {
sdf: { sdf: {

3
src/drawables/shapes/inverted-tunnel.ts
View file

@ -4,6 +4,9 @@ import { mix } from '../../helper/mix';
import { Drawable } from '../drawable'; import { Drawable } from '../drawable';
import { DrawableDescriptor } from '../drawable-descriptor'; import { DrawableDescriptor } from '../drawable-descriptor';
/**
* @category Drawable
*/
export class InvertedTunnel extends Drawable { export class InvertedTunnel extends Drawable {
public static descriptor: DrawableDescriptor = { public static descriptor: DrawableDescriptor = {
sdf: { sdf: {

3
src/drawables/shapes/tunnel.ts
View file

@ -4,6 +4,9 @@ import { mix } from '../../helper/mix';
import { Drawable } from '../drawable'; import { Drawable } from '../drawable';
import { DrawableDescriptor } from '../drawable-descriptor'; import { DrawableDescriptor } from '../drawable-descriptor';
/**
* @category Drawable
*/
export class Tunnel extends Drawable { export class Tunnel extends Drawable {
public static descriptor: DrawableDescriptor = { public static descriptor: DrawableDescriptor = {
sdf: { sdf: {

1
src/graphics/graphics-library/frame-buffer/default-frame-buffer.ts
View file

@ -1,6 +1,7 @@
import { UniversalRenderingContext } from '../universal-rendering-context'; import { UniversalRenderingContext } from '../universal-rendering-context';
import { FrameBuffer } from './frame-buffer'; import { FrameBuffer } from './frame-buffer';
/** @internal */
export class DefaultFrameBuffer extends FrameBuffer { export class DefaultFrameBuffer extends FrameBuffer {
constructor(gl: UniversalRenderingContext) { constructor(gl: UniversalRenderingContext) {
super(gl); super(gl);

3
src/graphics/graphics-library/frame-buffer/frame-buffer.ts
View file

@ -1,9 +1,10 @@
import { vec2 } from 'gl-matrix'; import { vec2 } from 'gl-matrix';
import { UniversalRenderingContext } from '../universal-rendering-context'; import { UniversalRenderingContext } from '../universal-rendering-context';
/** @internal */
export abstract class FrameBuffer { export abstract class FrameBuffer {
public renderScale = 1; public renderScale = 1;
public enableHighDpiRendering = false; public enableHighDpiRendering!: boolean;
protected size = vec2.create(); protected size = vec2.create();

1
src/graphics/graphics-library/frame-buffer/intermediate-frame-buffer.ts
View file

@ -2,6 +2,7 @@ import { enableExtension } from '../helper/enable-extension';
import { UniversalRenderingContext } from '../universal-rendering-context'; import { UniversalRenderingContext } from '../universal-rendering-context';
import { FrameBuffer } from './frame-buffer'; import { FrameBuffer } from './frame-buffer';
/** @internal */
export class IntermediateFrameBuffer extends FrameBuffer { export class IntermediateFrameBuffer extends FrameBuffer {
private frameTexture: WebGLTexture; private frameTexture: WebGLTexture;
private floatEnabled = false; private floatEnabled = false;

2
src/graphics/graphics-library/helper/enable-context-lost-simulator.ts
View file

@ -1,5 +1,7 @@
/** @internal */
let isEnabled = false; let isEnabled = false;
/** @internal */
export const enableContextLostSimulator = (canvas: HTMLCanvasElement) => { export const enableContextLostSimulator = (canvas: HTMLCanvasElement) => {
if (isEnabled) { if (isEnabled) {
return; return;

2
src/graphics/graphics-library/helper/enable-extension.ts
View file

@ -1,6 +1,7 @@
import { Insights } from '../../rendering/insights'; import { Insights } from '../../rendering/insights';
import { UniversalRenderingContext } from '../universal-rendering-context'; import { UniversalRenderingContext } from '../universal-rendering-context';
/** @internal */
export const tryEnableExtension = ( export const tryEnableExtension = (
gl: UniversalRenderingContext, gl: UniversalRenderingContext,
name: string name: string
@ -15,6 +16,7 @@ export const tryEnableExtension = (
return extension; return extension;
}; };
/** @internal */
export const enableExtension = (gl: UniversalRenderingContext, name: string): any => { export const enableExtension = (gl: UniversalRenderingContext, name: string): any => {
const extension = tryEnableExtension(gl, name); const extension = tryEnableExtension(gl, name);

2
src/graphics/graphics-library/helper/load-uniform.ts
View file

@ -1,8 +1,10 @@
import { mat3, ReadonlyVec3, ReadonlyVec4, vec2, vec3, vec4 } from 'gl-matrix'; import { mat3, ReadonlyVec3, ReadonlyVec4, vec2, vec3, vec4 } from 'gl-matrix';
import { UniversalRenderingContext } from '../universal-rendering-context'; import { UniversalRenderingContext } from '../universal-rendering-context';
/** @internal */
const loaderMat3 = mat3.create(); const loaderMat3 = mat3.create();
/** @internal */
export const loadUniform = ( export const loadUniform = (
gl: UniversalRenderingContext, gl: UniversalRenderingContext,
value: any, value: any,

2
src/graphics/graphics-library/helper/stopwatch.ts
View file

@ -1,12 +1,14 @@
import { UniversalRenderingContext } from '../universal-rendering-context'; import { UniversalRenderingContext } from '../universal-rendering-context';
import { enableExtension } from './enable-extension'; import { enableExtension } from './enable-extension';
/** @internal */
enum StopwatchState { enum StopwatchState {
ready = 'ready', ready = 'ready',
running = 'running', running = 'running',
waitingForResults = 'waitingForResults', waitingForResults = 'waitingForResults',
} }
/** @internal */
export class WebGlStopwatch { export class WebGlStopwatch {
private state = StopwatchState.ready; private state = StopwatchState.ready;
private resultsInNanoSeconds = 0; private resultsInNanoSeconds = 0;

1
src/graphics/graphics-library/palette-texture.ts
View file

@ -1,6 +1,7 @@
import { vec3, vec4 } from 'gl-matrix'; import { vec3, vec4 } from 'gl-matrix';
import { UniversalRenderingContext } from './universal-rendering-context'; import { UniversalRenderingContext } from './universal-rendering-context';
/** @internal */
export class PaletteTexture { export class PaletteTexture {
private texture: WebGLTexture; private texture: WebGLTexture;

3
src/graphics/graphics-library/parallel-compiler.ts
View file

@ -3,6 +3,7 @@ import { Insights } from '../rendering/insights';
import { tryEnableExtension } from './helper/enable-extension'; import { tryEnableExtension } from './helper/enable-extension';
import { UniversalRenderingContext } from './universal-rendering-context'; import { UniversalRenderingContext } from './universal-rendering-context';
/** @internal */
type CompilingProgram = { type CompilingProgram = {
program: WebGLProgram; program: WebGLProgram;
resolvePromise: ((program: WebGLProgram) => void) | null; resolvePromise: ((program: WebGLProgram) => void) | null;
@ -10,8 +11,10 @@ type CompilingProgram = {
fragmentShader: ShaderWithSource; fragmentShader: ShaderWithSource;
}; };
/** @internal */
type ShaderWithSource = WebGLShader & { source: string }; type ShaderWithSource = WebGLShader & { source: string };
/** @internal */
export class ParallelCompiler { export class ParallelCompiler {
private extension?: any; private extension?: any;
private gl: UniversalRenderingContext; private gl: UniversalRenderingContext;

1
src/graphics/graphics-library/program/fragment-shader-only-program.ts
View file

@ -3,6 +3,7 @@ import { ParallelCompiler } from '../parallel-compiler';
import { UniversalRenderingContext } from '../universal-rendering-context'; import { UniversalRenderingContext } from '../universal-rendering-context';
import Program from './program'; import Program from './program';
/** @internal */
export class FragmentShaderOnlyProgram extends Program { export class FragmentShaderOnlyProgram extends Program {
private vao?: WebGLVertexArrayObject; private vao?: WebGLVertexArrayObject;
private vertexArrayExtension: any; private vertexArrayExtension: any;

1
src/graphics/graphics-library/program/i-program.ts
View file

@ -1,5 +1,6 @@
import { vec2 } from 'gl-matrix'; import { vec2 } from 'gl-matrix';
/** @internal */
export interface IProgram { export interface IProgram {
setDrawingRectangleUV(bottomLeft: vec2, size: vec2): void; setDrawingRectangleUV(bottomLeft: vec2, size: vec2): void;
draw(values: { [name: string]: any }): void; draw(values: { [name: string]: any }): void;

1
src/graphics/graphics-library/program/program.ts
View file

@ -4,6 +4,7 @@ import { ParallelCompiler } from '../parallel-compiler';
import { UniversalRenderingContext } from '../universal-rendering-context'; import { UniversalRenderingContext } from '../universal-rendering-context';
import { IProgram } from './i-program'; import { IProgram } from './i-program';
/** @internal */
export default abstract class Program implements IProgram { export default abstract class Program implements IProgram {
protected program?: WebGLProgram; protected program?: WebGLProgram;

1
src/graphics/graphics-library/program/uniform-array-autoscaling-program.ts
View file

@ -7,6 +7,7 @@ import { UniversalRenderingContext } from '../universal-rendering-context';
import { FragmentShaderOnlyProgram } from './fragment-shader-only-program'; import { FragmentShaderOnlyProgram } from './fragment-shader-only-program';
import { IProgram } from './i-program'; import { IProgram } from './i-program';
/** @internal */
export class UniformArrayAutoScalingProgram implements IProgram { export class UniformArrayAutoScalingProgram implements IProgram {
private programs: Array<{ private programs: Array<{
program: FragmentShaderOnlyProgram; program: FragmentShaderOnlyProgram;

2
src/graphics/graphics-library/universal-rendering-context.ts
View file

@ -1,8 +1,10 @@
import { Insights } from '../rendering/insights'; import { Insights } from '../rendering/insights';
/** @internal */
export type UniversalRenderingContext = WebGL2RenderingContext & export type UniversalRenderingContext = WebGL2RenderingContext &
WebGLRenderingContext & { isWebGL2: boolean }; WebGLRenderingContext & { isWebGL2: boolean };
/** @internal */
export const getUniversalRenderingContext = ( export const getUniversalRenderingContext = (
canvas: HTMLCanvasElement, canvas: HTMLCanvasElement,
ignoreWebGL2 = false ignoreWebGL2 = false

2
src/graphics/rendering/fps-autoscaler.ts
View file

@ -3,6 +3,7 @@ import { exponentialDecay } from '../../helper/exponential-decay';
import { mix } from '../../helper/mix'; import { mix } from '../../helper/mix';
import { Insights } from './insights'; import { Insights } from './insights';
/** @internal */
const settings = { const settings = {
targetDeltaTimeInMilliseconds: 20, targetDeltaTimeInMilliseconds: 20,
deltaTimeErrorInMilliseconds: 3, deltaTimeErrorInMilliseconds: 3,
@ -30,6 +31,7 @@ const settings = {
qualityStepDecrese: 0.2, qualityStepDecrese: 0.2,
}; };
/** @internal */
export class FpsAutoscaler { export class FpsAutoscaler {
private timeSinceLastAdjusment = 0; private timeSinceLastAdjusment = 0;
private exponentialDecayedDeltaTime = settings.targetDeltaTimeInMilliseconds; private exponentialDecayedDeltaTime = settings.targetDeltaTimeInMilliseconds;

1
src/graphics/rendering/insights.ts
View file

@ -1,6 +1,7 @@
import { last } from '../../helper/last'; import { last } from '../../helper/last';
import { msToString } from '../../helper/ms-to-string'; import { msToString } from '../../helper/ms-to-string';
/** @internal */
export class Insights { export class Insights {
private static insights: any = {}; private static insights: any = {};

5
src/graphics/rendering/render-pass/distance-render-pass.ts
View file

@ -3,9 +3,10 @@ import { Drawable } from '../../../drawables/drawable';
import { Insights } from '../insights'; import { Insights } from '../insights';
import { RenderPass } from './render-pass'; import { RenderPass } from './render-pass';
/** @internal */
export class DistanceRenderPass extends RenderPass { export class DistanceRenderPass extends RenderPass {
public tileMultiplier = 8; public tileMultiplier!: number;
public isWorldInverted = false; public isWorldInverted!: boolean;
private drawables: Array<Drawable> = []; private drawables: Array<Drawable> = [];

3
src/graphics/rendering/render-pass/lights-render-pass.ts
View file

@ -4,8 +4,9 @@ import { clamp01 } from '../../../helper/clamp';
import { Insights } from '../insights'; import { Insights } from '../insights';
import { RenderPass } from './render-pass'; import { RenderPass } from './render-pass';
/** @internal */
export class LightsRenderPass extends RenderPass { export class LightsRenderPass extends RenderPass {
public lightCutoffDistance = 400; public lightCutoffDistance!: number;
private drawables: Array<LightDrawable> = []; private drawables: Array<LightDrawable> = [];
public addDrawable(drawable: LightDrawable) { public addDrawable(drawable: LightDrawable) {

1
src/graphics/rendering/render-pass/render-pass.ts
View file

@ -4,6 +4,7 @@ import { ParallelCompiler } from '../../graphics-library/parallel-compiler';
import { UniformArrayAutoScalingProgram } from '../../graphics-library/program/uniform-array-autoscaling-program'; import { UniformArrayAutoScalingProgram } from '../../graphics-library/program/uniform-array-autoscaling-program';
import { UniversalRenderingContext } from '../../graphics-library/universal-rendering-context'; import { UniversalRenderingContext } from '../../graphics-library/universal-rendering-context';
/** @internal */
export abstract class RenderPass { export abstract class RenderPass {
protected program: UniformArrayAutoScalingProgram; protected program: UniformArrayAutoScalingProgram;

4
src/graphics/rendering/renderer/context-aware-renderer.ts
View file

@ -1,10 +1,12 @@
import { vec2 } from 'gl-matrix'; import { vec2 } from 'gl-matrix';
import { Drawable, DrawableDescriptor } from '../../../main'; import { Drawable } from '../../../drawables/drawable';
import { DrawableDescriptor } from '../../../drawables/drawable-descriptor';
import { RuntimeSettings } from '../settings/runtime-settings'; import { RuntimeSettings } from '../settings/runtime-settings';
import { StartupSettings } from '../settings/startup-settings'; import { StartupSettings } from '../settings/startup-settings';
import { Renderer } from './renderer'; import { Renderer } from './renderer';
import { RendererImplementation } from './renderer-implementation'; import { RendererImplementation } from './renderer-implementation';
/** @internal */
export class ContextAwareRenderer implements Renderer { export class ContextAwareRenderer implements Renderer {
private renderer?: RendererImplementation; private renderer?: RendererImplementation;
private isRendererReady = false; private isRendererReady = false;

12
src/graphics/rendering/renderer/renderer-implementation.ts
View file

@ -16,6 +16,7 @@ import { FpsAutoscaler } from '../fps-autoscaler';
import { Insights } from '../insights'; import { Insights } from '../insights';
import { DistanceRenderPass } from '../render-pass/distance-render-pass'; import { DistanceRenderPass } from '../render-pass/distance-render-pass';
import { LightsRenderPass } from '../render-pass/lights-render-pass'; import { LightsRenderPass } from '../render-pass/lights-render-pass';
import { defaultRuntimeSettings } from '../settings/default-runtime-settings';
import { defaultStartupSettings } from '../settings/default-startup-settings'; import { defaultStartupSettings } from '../settings/default-startup-settings';
import { RuntimeSettings } from '../settings/runtime-settings'; import { RuntimeSettings } from '../settings/runtime-settings';
import { StartupSettings } from '../settings/startup-settings'; import { StartupSettings } from '../settings/startup-settings';
@ -30,6 +31,7 @@ import lightsVertexShader from '../shaders/shading-vs.glsl';
import { UniformsProvider } from '../uniforms-provider'; import { UniformsProvider } from '../uniforms-provider';
import { Renderer } from './renderer'; import { Renderer } from './renderer';
/** @internal */
export class RendererImplementation implements Renderer { export class RendererImplementation implements Renderer {
private readonly gl: UniversalRenderingContext; private readonly gl: UniversalRenderingContext;
private stopwatch?: WebGlStopwatch; private stopwatch?: WebGlStopwatch;
@ -38,7 +40,7 @@ export class RendererImplementation implements Renderer {
private distancePass: DistanceRenderPass; private distancePass: DistanceRenderPass;
private lightingFrameBuffer: DefaultFrameBuffer; private lightingFrameBuffer: DefaultFrameBuffer;
private lightsPass: LightsRenderPass; private lightsPass: LightsRenderPass;
private palette?: PaletteTexture; private palette!: PaletteTexture;
private autoscaler: FpsAutoscaler; private autoscaler: FpsAutoscaler;
private applyRuntimeSettings: { private applyRuntimeSettings: {
@ -53,7 +55,7 @@ export class RendererImplementation implements Renderer {
backgroundColor: (v) => (this.uniformsProvider.backgroundColor = v), backgroundColor: (v) => (this.uniformsProvider.backgroundColor = v),
ambientLight: (v) => (this.uniformsProvider.ambientLight = v), ambientLight: (v) => (this.uniformsProvider.ambientLight = v),
lightCutoffDistance: (v) => (this.lightsPass.lightCutoffDistance = v), lightCutoffDistance: (v) => (this.lightsPass.lightCutoffDistance = v),
colorPalette: (v) => this.palette!.setPalette(v), colorPalette: (v) => this.palette.setPalette(v),
}; };
setRuntimeSettings(overrides: Partial<RuntimeSettings>): void { setRuntimeSettings(overrides: Partial<RuntimeSettings>): void {
@ -103,6 +105,8 @@ export class RendererImplementation implements Renderer {
}; };
this.palette = new PaletteTexture(this.gl, settings.paletteSize); this.palette = new PaletteTexture(this.gl, settings.paletteSize);
this.setRuntimeSettings(defaultRuntimeSettings);
const promises: Array<Promise<void>> = []; const promises: Array<Promise<void>> = [];
const compiler = new ParallelCompiler(this.gl); const compiler = new ParallelCompiler(this.gl);
@ -219,7 +223,7 @@ export class RendererImplementation implements Renderer {
this.lightsPass.render( this.lightsPass.render(
this.uniformsProvider.getUniforms(common), this.uniformsProvider.getUniforms(common),
this.distanceFieldFrameBuffer.colorTexture, this.distanceFieldFrameBuffer.colorTexture,
this.palette!.colorTexture this.palette.colorTexture
); );
this.gl.disable(this.gl.BLEND); this.gl.disable(this.gl.BLEND);
@ -243,6 +247,6 @@ export class RendererImplementation implements Renderer {
public destroy(): void { public destroy(): void {
this.distancePass.destroy(); this.distancePass.destroy();
this.lightsPass.destroy(); this.lightsPass.destroy();
this.palette!.destroy(); this.palette.destroy();
} }
} }

74
src/graphics/rendering/renderer/renderer.ts
View file

@ -2,15 +2,79 @@ import { vec2 } from 'gl-matrix';
import { Drawable } from '../../../drawables/drawable'; import { Drawable } from '../../../drawables/drawable';
import { RuntimeSettings } from '../settings/runtime-settings'; import { RuntimeSettings } from '../settings/runtime-settings';
/**
* The main interface through which rendering can be achieved.
*
* Multiple renderers are permitted on a single page.
*/
export interface Renderer { export interface Renderer {
/**
* Get the actual resolution of the canvas.
*/
readonly canvasSize: vec2; readonly canvasSize: vec2;
/**
* Get the viewArea size set by the last `setViewArea`.
*
* By default, `canvasSize` is used for the view area size.
*/
readonly viewAreaSize: vec2; readonly viewAreaSize: vec2;
/**
* Set the camera transformation.
*
* @param topLeft top (!) left. By default, equals to [0, canvasHeight].
* @param size need not be equal to the canvas size, though their aspect ratio
* should be the same to avoid stretching.
*/
setViewArea(topLeft: vec2, size: vec2): void;
/**
* Patch the current runtime settings with new values.
* @param overrides
*/
setRuntimeSettings(overrides: Partial<RuntimeSettings>): void;
/**
* Schedule a drawable to be rendered during the next `renderDrawables` call.
*
* @param drawable Must be a subclass of drawable and its class must contain a
* static descriptor property of type [[DrawableDescriptor]].
*/
addDrawable<T extends Drawable>(drawable: T): void;
/**
* Render every drawable added since the last `renderDrawables` call.
*
* Resizing of framebuffers and the canvas also takes effect
* when calling `renderDrawables`.
*/
renderDrawables(): void;
/**
* Let go of every GPU resource held by the renderer.
*
* It's up to the browser and driver whether these resources are actually freed.
* Nonetheless, when a renderer is no longer needed, this method should be called.
*/
destroy(): void;
/**
* @experimental
*
* Debug information updated on each `renderDrawables` call.
* Its scheme is not yet defined. The main purpose of this is
* human debugging.
*/
readonly insights: any; readonly insights: any;
setViewArea(topLeft: vec2, size: vec2): void; /**
setRuntimeSettings(overrides: Partial<RuntimeSettings>): void; * @experimental
addDrawable(drawable: Drawable): void; *
* Scale the render scale for both the canvas and the SDF memoization based
* on the current and historical FPS values.
*
* @param deltaTime since the last frame, in milliseconds.
*/
autoscaleQuality(deltaTime: DOMHighResTimeStamp): void; autoscaleQuality(deltaTime: DOMHighResTimeStamp): void;
renderDrawables(): void;
destroy(): void;
} }

15
src/graphics/rendering/settings/default-runtime-settings.ts Normal file
View file

@ -0,0 +1,15 @@
import { vec3, vec4 } from 'gl-matrix';
import { RuntimeSettings } from './runtime-settings';
/**
* Contains the default values used for [[RuntimeSettings]].
*/
export const defaultRuntimeSettings: RuntimeSettings = {
enableHighDpiRendering: true,
tileMultiplier: 8,
isWorldInverted: false,
lightCutoffDistance: 400,
backgroundColor: vec4.fromValues(1, 1, 1, 1),
colorPalette: [],
ambientLight: vec3.fromValues(0.25, 0.15, 0.25),
};

3
src/graphics/rendering/settings/default-startup-settings.ts
View file

@ -1,5 +1,8 @@
import { StartupSettings } from './startup-settings'; import { StartupSettings } from './startup-settings';
/**
* Contains the default values used for [[StartupSettings]].
*/
export const defaultStartupSettings: StartupSettings = { export const defaultStartupSettings: StartupSettings = {
shadowTraceCount: 16, shadowTraceCount: 16,
paletteSize: 256, paletteSize: 256,

48
src/graphics/rendering/settings/runtime-settings.ts
View file

@ -1,11 +1,59 @@
import { vec3, vec4 } from 'gl-matrix'; import { vec3, vec4 } from 'gl-matrix';
/**
* Interface for a configuration object containing the settings
* that can be changed during runtime.
*
* The default values for RuntimeSettings can be found in [[defaultRuntimeSettings]].
*/
export interface RuntimeSettings { export interface RuntimeSettings {
/**
* When set to `true` rendering will be done on the screen's real resolution.
*/
enableHighDpiRendering: boolean; enableHighDpiRendering: boolean;
/**
* First, the SDF of the scene is evaluated at every single pixel.
* For speeding this process up, the screen is divided up into tiles,
* this way each having to deal with a fewer objects.
*
* For each tile, it is decided which objects are near its close vicinity.
* This comes with some overhead for the CPU, while saving the GPU from loads of
* calculations. The workload can be balanced between the CPU and the GPU by setting
* this number.
*/
tileMultiplier: number; tileMultiplier: number;
/**
* By default, every pixel is outside of objects. Flipping this value to `true` will
* result in every pixel being inside a large object. From then it only makes sense to
* draw inverted objects.
*/
isWorldInverted: boolean; isWorldInverted: boolean;
/**
* When lights reach the end of the display, they are slowly faded out. The length
* of this phaseout can be set through this value.
*/
lightCutoffDistance: number; lightCutoffDistance: number;
/**
* The default background color of the scene, can have transparency.
*/
backgroundColor: vec3 | vec4; backgroundColor: vec3 | vec4;
/**
* Its length should be less than the one specified in [[StartupSettings]].paletteSize.
*
* The possible colors for the objects. Each color is referenced by its index in the
* palette.
*
* Can have transparency.
*/
colorPalette: Array<vec3 | vec4>; colorPalette: Array<vec3 | vec4>;
/**
* A light affecting every pixel (even the ones inside objects).
*/
ambientLight: vec3; ambientLight: vec3;
} }

28
src/graphics/rendering/settings/startup-settings.ts
View file

@ -1,5 +1,33 @@
/**
* Interface for a configuration object containing the settings
* that need to be given before shader compilation.
*
* The default values for StartupSettings can be found in [[defaultStartupSettings]].
*/
export interface StartupSettings { export interface StartupSettings {
/**
* The raytracing algorithm used for shadows requires a step count.
* Sensible values for this are between 8 and 32.
*
* The higher the number, the harder the shadows will get.
* Some ambient occlusion like effects can be visible on lower trace counts.
*/
shadowTraceCount: number; shadowTraceCount: number;
/**
* Gives the number of possible object colors for the scene.
*
* When using WebGL, only 256 different colors can be used.
* On WebGL2, its value should not be larger than 4096 for
* maintaining compatibility with low-end devices.
*/
paletteSize: number; paletteSize: number;
/**
* When set to `true`, rendering will fall back to WebGL
* even when WebGL2 is present.
*
* Useful for testing compatibility.
*/
ignoreWebGL2: boolean; ignoreWebGL2: boolean;
} }

5
src/graphics/rendering/uniforms-provider.ts
View file

@ -1,9 +1,10 @@
import { mat2d, vec2, vec3, vec4 } from 'gl-matrix'; import { mat2d, vec2, vec3, vec4 } from 'gl-matrix';
import { UniversalRenderingContext } from '../graphics-library/universal-rendering-context'; import { UniversalRenderingContext } from '../graphics-library/universal-rendering-context';
/** @internal */
export class UniformsProvider { export class UniformsProvider {
public ambientLight = vec3.fromValues(0.25, 0.15, 0.25); public ambientLight!: vec3;
public _backgroundColor = vec4.fromValues(1, 1, 1, 1); public _backgroundColor!: vec4;
private scaleWorldLengthToNDC = 1; private scaleWorldLengthToNDC = 1;
private transformWorldToNDC = mat2d.create(); private transformWorldToNDC = mat2d.create();

3
src/helper/array.ts
View file

@ -1,3 +1,4 @@
/** @internal */
declare global { declare global {
interface Array<T> { interface Array<T> {
x: number; x: number;
@ -10,6 +11,7 @@ declare global {
} }
} }
/** @internal */
const setIndexAlias = (name: string, index: number, type: any) => { const setIndexAlias = (name: string, index: number, type: any) => {
if (!Object.prototype.hasOwnProperty.call(type.prototype, name)) { if (!Object.prototype.hasOwnProperty.call(type.prototype, name)) {
Object.defineProperty(type.prototype, name, { Object.defineProperty(type.prototype, name, {
@ -23,6 +25,7 @@ const setIndexAlias = (name: string, index: number, type: any) => {
} }
}; };
/** @internal */
export const applyArrayPlugins = () => { export const applyArrayPlugins = () => {
setIndexAlias('x', 0, Array); setIndexAlias('x', 0, Array);
setIndexAlias('y', 1, Array); setIndexAlias('y', 1, Array);

2
src/helper/clamp.ts
View file

@ -1,4 +1,6 @@
/** @internal */
export const clamp = (value: number, min: number, max: number): number => export const clamp = (value: number, min: number, max: number): number =>
Math.min(max, Math.max(min, value)); Math.min(max, Math.max(min, value));
/** @internal */
export const clamp01 = (value: number): number => Math.min(1, Math.max(0, value)); export const clamp01 = (value: number): number => Math.min(1, Math.max(0, value));

1
src/helper/exponential-decay.ts
View file

@ -1,3 +1,4 @@
/** @internal */
export const exponentialDecay = ( export const exponentialDecay = (
accumulator: number, accumulator: number,
nextValue: number, nextValue: number,

1
src/helper/get-combinations.ts
View file

@ -1,3 +1,4 @@
/** @internal */
export const getCombinations = (values: Array<Array<number>>): Array<Array<number>> => { export const getCombinations = (values: Array<Array<number>>): Array<Array<number>> => {
if (!values.every((a) => a.length > 0)) { if (!values.every((a) => a.length > 0)) {
return []; return [];

1
src/helper/last.ts
View file

@ -1,3 +1,4 @@
/** @internal */
export function last<T>(a: Array<T>): T | null { export function last<T>(a: Array<T>): T | null {
return a.length > 0 ? a[a.length - 1] : null; return a.length > 0 ? a[a.length - 1] : null;
} }

1
src/helper/mix.ts
View file

@ -1 +1,2 @@
/** @internal */
export const mix = (from: number, to: number, q: number) => from + (to - from) * q; export const mix = (from: number, to: number, q: number) => from + (to - from) * q;

1
src/helper/ms-to-string.ts
View file

@ -1 +1,2 @@
/** @internal */
export const msToString = (value: number) => `${value.toFixed(3)} ms`; export const msToString = (value: number) => `${value.toFixed(3)} ms`;

1
src/helper/wait.ts
View file

@ -1,3 +1,4 @@
/** @internal */
export const wait = (ms: number): Promise<void> => { export const wait = (ms: number): Promise<void> => {
return new Promise<void>((resolve, _) => setTimeout(resolve, ms)); return new Promise<void>((resolve, _) => setTimeout(resolve, ms));
}; };

9
src/main.ts
View file

@ -13,6 +13,7 @@ import { Renderer } from './graphics/rendering/renderer/renderer';
import { StartupSettings } from './graphics/rendering/settings/startup-settings'; import { StartupSettings } from './graphics/rendering/settings/startup-settings';
import { applyArrayPlugins } from './helper/array'; import { applyArrayPlugins } from './helper/array';
/** @internal */
declare global { declare global {
interface Array<T> { interface Array<T> {
x: number; x: number;
@ -29,8 +30,8 @@ applyArrayPlugins();
/** /**
* Compiles a new renderer instance. There can multiple renderers on a single page. * Compiles a new renderer instance. There can multiple renderers on a single page.
* > Asynchronous behaviour is required for paralell shader compiling. * > Asynchronous behaviour is required for parallel shader compiling.
* > Trying to draw before the returned promise resolves results in no action taken. * > Trying to draw before the returned promise resolves, results in no action taken.
* > Settings can be set before promise resolution and they will be applied later. * > Settings can be set before promise resolution and they will be applied later.
* *
* The descriptors of every to-be-drawn objects are required before creating the renderer, * The descriptors of every to-be-drawn objects are required before creating the renderer,
@ -48,9 +49,7 @@ applyArrayPlugins();
* @param canvas The returned renderer will only be able to draw to this canvas. * @param canvas The returned renderer will only be able to draw to this canvas.
* @param descriptors The descriptor of every single object (and light) that * @param descriptors The descriptor of every single object (and light) that
* ever needs to be drawn by this renderer has to be given before compiling. * ever needs to be drawn by this renderer has to be given before compiling.
* @param settingsOverrides Sensible defaults are provided, but these can be overriden. * @param settingsOverrides Sensible defaults are provided, but these can be overridden.
*
* @category Startup
*/ */
export async function compile( export async function compile(
canvas: HTMLCanvasElement, canvas: HTMLCanvasElement,

2
typedoc.json
View file

@ -13,5 +13,5 @@
"inputFiles": "src", "inputFiles": "src",
"ignoreCompilerErrors": true, "ignoreCompilerErrors": true,
"listInvalidSymbolLinks": true, "listInvalidSymbolLinks": true,
"readme": "docs-source/README.md" "readme": "documentation-readme.md"
} }