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

Generate documentation

Browse source
This commit is contained in:
schmelczerandras 2020-10-27 11:09:45 +01:00
parent 6a78033764
commit 18f23a8d65
29 changed files with 313 additions and 283 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/interfaces/startupsettings.html
View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>StartupSettings | SDF-2D - v0.6.2</title>
<meta name="description" content="Documentation for SDF-2D - v0.6.2">
<title>StartupSettings | SDF-2D - v0.6.3</title>
<meta name="description" content="Documentation for SDF-2D - v0.6.3">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="icon" href="../favicon.ico" />
@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">SDF-2D - v0.6.2</a>
<a href="../index.html" class="title">SDF-2D - v0.6.3</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -88,6 +88,7 @@
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="startupsettings.html#backgroundcolor" class="tsd-kind-icon">background<wbr>Color</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="startupsettings.html#enablecontextlostsimulator" class="tsd-kind-icon">enable<wbr>Context<wbr>Lost<wbr>Simulator</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="startupsettings.html#enablestopwatch" class="tsd-kind-icon">enable<wbr>Stopwatch</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="startupsettings.html#ignorewebgl2" class="tsd-kind-icon">ignore<wbr>WebGL2</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="startupsettings.html#lightpenetrationratio" class="tsd-kind-icon">light<wbr>Penetration<wbr>Ratio</a></li>
@ -106,7 +107,7 @@
<div class="tsd-signature tsd-kind-icon">background<wbr>Color<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec3</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">vec4</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/graphics/rendering/settings/startup-settings.ts#L47">graphics/rendering/settings/startup-settings.ts:47</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/graphics/rendering/settings/startup-settings.ts#L54">graphics/rendering/settings/startup-settings.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -115,13 +116,29 @@
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="enablecontextlostsimulator" class="tsd-anchor"></a>
<h3>enable<wbr>Context<wbr>Lost<wbr>Simulator</h3>
<div class="tsd-signature tsd-kind-icon">enable<wbr>Context<wbr>Lost<wbr>Simulator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/graphics/rendering/settings/startup-settings.ts#L49">graphics/rendering/settings/startup-settings.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Many context lost event will be simulated when enabled.</p>
</div>
<p>Useful for testing.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="enablestopwatch" class="tsd-anchor"></a>
<h3>enable<wbr>Stopwatch</h3>
<div class="tsd-signature tsd-kind-icon">enable<wbr>Stopwatch<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/graphics/rendering/settings/startup-settings.ts#L16">graphics/rendering/settings/startup-settings.ts:16</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/graphics/rendering/settings/startup-settings.ts#L16">graphics/rendering/settings/startup-settings.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -138,7 +155,7 @@
<div class="tsd-signature tsd-kind-icon">ignore<wbr>WebGL2<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/graphics/rendering/settings/startup-settings.ts#L55">graphics/rendering/settings/startup-settings.ts:55</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/graphics/rendering/settings/startup-settings.ts#L62">graphics/rendering/settings/startup-settings.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -155,7 +172,7 @@
<div class="tsd-signature tsd-kind-icon">light<wbr>Penetration<wbr>Ratio<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/graphics/rendering/settings/startup-settings.ts#L33">graphics/rendering/settings/startup-settings.ts:33</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/graphics/rendering/settings/startup-settings.ts#L33">graphics/rendering/settings/startup-settings.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -172,7 +189,7 @@
<div class="tsd-signature tsd-kind-icon">palette<wbr>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/graphics/rendering/settings/startup-settings.ts#L42">graphics/rendering/settings/startup-settings.ts:42</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/graphics/rendering/settings/startup-settings.ts#L42">graphics/rendering/settings/startup-settings.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -190,7 +207,7 @@
<div class="tsd-signature tsd-kind-icon">shadow<wbr>Trace<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/8eff33e/src/graphics/rendering/settings/startup-settings.ts#L25">graphics/rendering/settings/startup-settings.ts:25</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/6a78033/src/graphics/rendering/settings/startup-settings.ts#L25">graphics/rendering/settings/startup-settings.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -222,6 +239,9 @@
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="startupsettings.html#backgroundcolor" class="tsd-kind-icon">background<wbr>Color</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="startupsettings.html#enablecontextlostsimulator" class="tsd-kind-icon">enable<wbr>Context<wbr>Lost<wbr>Simulator</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="startupsettings.html#enablestopwatch" class="tsd-kind-icon">enable<wbr>Stopwatch</a>
</li>