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

Generate docs

Browse source
This commit is contained in:
schmelczerandras 2020-10-19 12:17:54 +02:00
parent 06dfd593cd
commit c30c66340f
28 changed files with 2288 additions and 2019 deletions
Download patch file Download diff file Expand all files Collapse all files

35
docs/index.html
View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SDF-2D - v0.5.3</title>
<meta name="description" content="Documentation for SDF-2D - v0.5.3">
<title>SDF-2D - v0.6.0</title>
<meta name="description" content="Documentation for SDF-2D - v0.6.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<link rel="icon" href="favicon.ico" />
@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">SDF-2D - v0.5.3</a>
<a href="index.html" class="title">SDF-2D - v0.6.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -53,7 +53,7 @@
<a href="globals.html">Globals</a>
</li>
</ul>
<h1>SDF-2D - v0.5.3</h1>
<h1>SDF-2D - v0.6.0</h1>
</div>
</div>
</header>
@ -75,8 +75,8 @@
<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>
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
<h2>Usage</h2>
<a href="#usage-1st-option" id="usage-1st-option" style="color: inherit; text-decoration: none;">
<h2>Usage (1st option)</h2>
</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>
@ -86,6 +86,11 @@
</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="#usage-2nd-option" id="usage-2nd-option" style="color: inherit; text-decoration: none;">
<h2>Usage (2nd option)</h2>
</a>
<p>If you&#39;re planning on creating animated content, use the <a href="globals.html#runanimation">runAnimation function</a> to spare yourself from writing boilerplate code.
Further documentation on its usage is available in its <a href="globals.html#runanimation">documentation</a>.</p>
<a href="#extending-drawables" id="extending-drawables" style="color: inherit; text-decoration: none;">
<h2>Extending drawables</h2>
</a>
@ -138,6 +143,9 @@
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-namespace">
<a href="modules/__global.html">__global</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
@ -154,6 +162,12 @@
<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/colorfulcircle.html" class="tsd-kind-icon">Colorful<wbr>Circle</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/deltatimecalculator.html" class="tsd-kind-icon">Delta<wbr>Time<wbr>Calculator</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/drawable.html" class="tsd-kind-icon">Drawable</a>
</li>
@ -163,6 +177,9 @@
<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/fpsqualityautoscaler.html" class="tsd-kind-icon">Fps<wbr>Quality<wbr>Autoscaler</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/invertedtunnelbase.html" class="tsd-kind-icon">Inverted<wbr>Tunnel<wbr>Base</a>
</li>
@ -184,6 +201,9 @@
<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/rendererinfo.html" class="tsd-kind-icon">Renderer<wbr>Info</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/runtimesettings.html" class="tsd-kind-icon">Runtime<wbr>Settings</a>
</li>
@ -241,6 +261,9 @@
<li class=" tsd-kind-function">
<a href="globals.html#rgba255" class="tsd-kind-icon">rgba255</a>
</li>
<li class=" tsd-kind-function">
<a href="globals.html#runanimation" class="tsd-kind-icon">run<wbr>Animation</a>
</li>
<li class=" tsd-kind-object-literal">
<a href="globals.html#defaultruntimesettings" class="tsd-kind-icon">default<wbr>Runtime<wbr>Settings</a>
</li>