Finish documentation
This commit is contained in:
schmelczerandras
parent
49473bf905
commit
31fcfd3d6b
86 changed files with 1383 additions and 8485 deletions
|
|
@ -3,8 +3,8 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Circle | SDF-2D - v0.3.1</title>
|
||||
<meta name="description" content="Documentation for SDF-2D - v0.3.1">
|
||||
<title>Circle | SDF-2D - v0.3.2</title>
|
||||
<meta name="description" content="Documentation for SDF-2D - v0.3.2">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
</head>
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">SDF-2D - v0.3.1</a>
|
||||
<a href="../index.html" class="title">SDF-2D - v0.3.2</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -62,6 +62,10 @@
|
|||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<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">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
|
|
@ -121,7 +125,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<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>
|
||||
</aside>
|
||||
<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>
|
||||
<aside class="tsd-sources">
|
||||
<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>
|
||||
</aside>
|
||||
</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>
|
||||
<aside class="tsd-sources">
|
||||
<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>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -174,7 +178,7 @@
|
|||
<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/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>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -201,7 +205,7 @@
|
|||
<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/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>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -225,7 +229,7 @@
|
|||
<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>
|
||||
<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>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -254,7 +258,7 @@
|
|||
<aside class="tsd-sources">
|
||||
<p>Overrides <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/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>
|
||||
</aside>
|
||||
<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>
|
||||
<aside class="tsd-sources">
|
||||
<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>
|
||||
</aside>
|
||||
</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>
|
||||
<aside class="tsd-sources">
|
||||
<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>
|
||||
</aside>
|
||||
</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"> = "CIRCLE_COUNT"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<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>
|
||||
</aside>
|
||||
</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>
|
||||
<aside class="tsd-sources">
|
||||
<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>
|
||||
</aside>
|
||||
<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"> = "circleCenters"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<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>
|
||||
</aside>
|
||||
</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"> = "circleRadii"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<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>
|
||||
</aside>
|
||||
</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>
|
||||
<aside class="tsd-sources">
|
||||
<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>
|
||||
</aside>
|
||||
<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"> = "circleMinDistance"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<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>
|
||||
</aside>
|
||||
</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"> = `uniform vec2 circleCenters[CIRCLE_COUNT];uniform float circleRadii[CIRCLE_COUNT];float circleMinDistance(vec2 target, out float colorIndex) {colorIndex = 2.0;float minDistance = 1000.0;for (int i = 0; i < CIRCLE_COUNT; i++) {float dist = distance(circleCenters[i], target) - circleRadii[i];minDistance = min(minDistance, dist);}return minDistance;}`</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<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>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -390,6 +394,42 @@
|
|||
</li>
|
||||
</ul>
|
||||
<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>
|
||||
</nav>
|
||||
</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-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-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue