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

Add documentation

Browse source
This commit is contained in:
schmelczerandras 2020-10-04 10:48:44 +02:00
parent 7bfad8711b
commit de5dad1e6e
18 changed files with 1344 additions and 211 deletions
Download patch file Download diff file Expand all files Collapse all files

66
docs/interfaces/runtimesettings.html
View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>RuntimeSettings | SDF-2D - v0.3.5</title>
<meta name="description" content="Documentation for SDF-2D - v0.3.5">
<title>RuntimeSettings | SDF-2D - v0.4.0</title>
<meta name="description" content="Documentation for SDF-2D - v0.4.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<link rel="icon" href="../favicon.ico" />
@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">SDF-2D - v0.3.5</a>
<a href="../index.html" class="title">SDF-2D - v0.4.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -93,6 +93,7 @@
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runtimesettings.html#enablehighdpirendering" class="tsd-kind-icon">enable<wbr>High<wbr>Dpi<wbr>Rendering</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runtimesettings.html#isworldinverted" class="tsd-kind-icon">is<wbr>World<wbr>Inverted</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runtimesettings.html#lightcutoffdistance" class="tsd-kind-icon">light<wbr>Cutoff<wbr>Distance</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runtimesettings.html#textures" class="tsd-kind-icon">textures</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="runtimesettings.html#tilemultiplier" class="tsd-kind-icon">tile<wbr>Multiplier</a></li>
</ul>
</section>
@ -107,7 +108,7 @@
<div class="tsd-signature tsd-kind-icon">ambient<wbr>Light<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">vec3</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/runtime-settings.ts#L58">graphics/rendering/settings/runtime-settings.ts:58</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/runtime-settings.ts#L71">graphics/rendering/settings/runtime-settings.ts:71</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -122,7 +123,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/158d2f4/src/graphics/rendering/settings/runtime-settings.ts#L43">graphics/rendering/settings/runtime-settings.ts:43</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/runtime-settings.ts#L44">graphics/rendering/settings/runtime-settings.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -137,7 +138,7 @@
<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">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/runtime-settings.ts#L53">graphics/rendering/settings/runtime-settings.ts:53</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/runtime-settings.ts#L54">graphics/rendering/settings/runtime-settings.ts:54</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -155,7 +156,7 @@
<div class="tsd-signature tsd-kind-icon">enable<wbr>High<wbr>Dpi<wbr>Rendering<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/runtime-settings.ts#L13">graphics/rendering/settings/runtime-settings.ts:13</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/runtime-settings.ts#L14">graphics/rendering/settings/runtime-settings.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -170,7 +171,7 @@
<div class="tsd-signature tsd-kind-icon">is<wbr>World<wbr>Inverted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/runtime-settings.ts#L32">graphics/rendering/settings/runtime-settings.ts:32</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/runtime-settings.ts#L33">graphics/rendering/settings/runtime-settings.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -187,7 +188,7 @@
<div class="tsd-signature tsd-kind-icon">light<wbr>Cutoff<wbr>Distance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/runtime-settings.ts#L38">graphics/rendering/settings/runtime-settings.ts:38</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/runtime-settings.ts#L39">graphics/rendering/settings/runtime-settings.ts:39</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -197,13 +198,40 @@
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="textures" class="tsd-anchor"></a>
<h3>textures</h3>
<div class="tsd-signature tsd-kind-icon">textures<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/runtime-settings.ts#L64">graphics/rendering/settings/runtime-settings.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>It is possible to use your own textures in your SDF definitions.</p>
</div>
<p>The keys of the object should be the name used to reference them in the GLSL code,
and the values should be the textures themselves or a TextureWithOptions specifying
the texture&#39;s <a href="textureoptions.html">TextureOptions</a>.
It can be a canvas, img element, Image and so on.</p>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>textureName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">TexImageSource</span><span class="tsd-signature-symbol"> | </span><a href="../globals.html#texturewithoptions" class="tsd-signature-type">TextureWithOptions</a></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/158d2f4/src/graphics/rendering/settings/runtime-settings.ts#L25">graphics/rendering/settings/runtime-settings.ts:25</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/7bfad87/src/graphics/rendering/settings/runtime-settings.ts#L26">graphics/rendering/settings/runtime-settings.ts:26</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -230,6 +258,12 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum">
<a href="../enums/filteringoptions.html" class="tsd-kind-icon">Filtering<wbr>Options</a>
</li>
<li class=" tsd-kind-enum">
<a href="../enums/wrapoptions.html" class="tsd-kind-icon">Wrap<wbr>Options</a>
</li>
<li class=" tsd-kind-class">
<a href="../classes/circle.html" class="tsd-kind-icon">Circle</a>
</li>
@ -283,6 +317,9 @@
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="runtimesettings.html#lightcutoffdistance" class="tsd-kind-icon">light<wbr>Cutoff<wbr>Distance</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="runtimesettings.html#textures" class="tsd-kind-icon">textures</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="runtimesettings.html#tilemultiplier" class="tsd-kind-icon">tile<wbr>Multiplier</a>
</li>
@ -293,9 +330,18 @@
<li class=" tsd-kind-interface">
<a href="startupsettings.html" class="tsd-kind-icon">Startup<wbr>Settings</a>
</li>
<li class=" tsd-kind-interface">
<a href="textureoptions.html" class="tsd-kind-icon">Texture<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias">
<a href="../globals.html#texturewithoptions" class="tsd-kind-icon">Texture<wbr>With<wbr>Options</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#compile" class="tsd-kind-icon">compile</a>
</li>
<li class=" tsd-kind-function">
<a href="../globals.html#rendernoise" class="tsd-kind-icon">render<wbr>Noise</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="../globals.html#defaultruntimesettings" class="tsd-kind-icon">default<wbr>Runtime<wbr>Settings</a>
</li>