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-25 15:56:47 +01:00
parent 3fb6cc0411
commit 8eff33e181
28 changed files with 489 additions and 287 deletions
Download patch file Download diff file Expand all files Collapse all files

47
docs/interfaces/renderer.html
View file

@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Renderer | SDF-2D - v0.6.0</title>
<meta name="description" content="Documentation for SDF-2D - v0.6.0">
<title>Renderer | SDF-2D - v0.6.1</title>
<meta name="description" content="Documentation for SDF-2D - v0.6.1">
<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.0</a>
<a href="../index.html" class="title">SDF-2D - v0.6.1</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@ -111,16 +111,17 @@
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="canvassize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> canvas<wbr>Size</h3>
<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">ReadonlyVec2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/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/3fb6cc0/src/graphics/rendering/renderer/renderer.ts#L17">graphics/rendering/renderer/renderer.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the actual resolution of the canvas.</p>
<p>Get the actual resolution of the canvas without triggering a reflow.</p>
</div>
<p>A ResizeObserver is utilised fot achieving this.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
@ -129,7 +130,7 @@
<div class="tsd-signature tsd-kind-icon">insights<span class="tsd-signature-symbol">:</span> <a href="rendererinfo.html" class="tsd-signature-type">RendererInfo</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L95">graphics/rendering/renderer/renderer.ts:95</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/renderer/renderer.ts#L97">graphics/rendering/renderer/renderer.ts:97</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -143,10 +144,10 @@
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="viewareasize" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> view<wbr>Area<wbr>Size</h3>
<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">ReadonlyVec2</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L22">graphics/rendering/renderer/renderer.ts:22</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/renderer/renderer.ts#L24">graphics/rendering/renderer/renderer.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -169,7 +170,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L69">graphics/rendering/renderer/renderer.ts:69</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/renderer/renderer.ts#L71">graphics/rendering/renderer/renderer.ts:71</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -207,7 +208,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L85">graphics/rendering/renderer/renderer.ts:85</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/renderer/renderer.ts#L87">graphics/rendering/renderer/renderer.ts:87</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -225,13 +226,13 @@
<a name="displaytoworldcoordinates" class="tsd-anchor"></a>
<h3>display<wbr>ToWorld<wbr>Coordinates</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">display<wbr>ToWorld<wbr>Coordinates<span class="tsd-signature-symbol">(</span>displayCoordinates<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>
<li class="tsd-signature tsd-kind-icon">display<wbr>ToWorld<wbr>Coordinates<span class="tsd-signature-symbol">(</span>displayCoordinates<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadonlyVec2</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/06dfd59/src/graphics/rendering/renderer/renderer.ts#L44">graphics/rendering/renderer/renderer.ts:44</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/renderer/renderer.ts#L46">graphics/rendering/renderer/renderer.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -245,7 +246,7 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>displayCoordinates: <span class="tsd-signature-type">vec2</span></h5>
<h5>displayCoordinates: <span class="tsd-signature-type">ReadonlyVec2</span></h5>
<div class="tsd-comment tsd-typography">
<p>The origin is in the display&#39;s top left corner.
Just as in mouse events&#39; clientX and clientY.</p>
@ -266,7 +267,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L77">graphics/rendering/renderer/renderer.ts:77</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/renderer/renderer.ts#L79">graphics/rendering/renderer/renderer.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -290,7 +291,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/06dfd59/src/graphics/rendering/renderer/renderer.ts#L61">graphics/rendering/renderer/renderer.ts:61</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/renderer/renderer.ts#L63">graphics/rendering/renderer/renderer.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -314,13 +315,13 @@
<a name="setviewarea" class="tsd-anchor"></a>
<h3>set<wbr>View<wbr>Area</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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>
<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">ReadonlyVec2</span>, size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadonlyVec2</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/06dfd59/src/graphics/rendering/renderer/renderer.ts#L31">graphics/rendering/renderer/renderer.ts:31</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/renderer/renderer.ts#L33">graphics/rendering/renderer/renderer.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -331,13 +332,13 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>topLeft: <span class="tsd-signature-type">vec2</span></h5>
<h5>topLeft: <span class="tsd-signature-type">ReadonlyVec2</span></h5>
<div class="tsd-comment tsd-typography">
<p>top (!) left. By default, equals to [0, canvasHeight].</p>
</div>
</li>
<li>
<h5>size: <span class="tsd-signature-type">vec2</span></h5>
<h5>size: <span class="tsd-signature-type">ReadonlyVec2</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>
@ -352,13 +353,13 @@
<a name="worldtodisplaycoordinates" class="tsd-anchor"></a>
<h3>world<wbr>ToDisplay<wbr>Coordinates</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">world<wbr>ToDisplay<wbr>Coordinates<span class="tsd-signature-symbol">(</span>worldCoordinates<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>
<li class="tsd-signature tsd-kind-icon">world<wbr>ToDisplay<wbr>Coordinates<span class="tsd-signature-symbol">(</span>worldCoordinates<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadonlyVec2</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/06dfd59/src/graphics/rendering/renderer/renderer.ts#L55">graphics/rendering/renderer/renderer.ts:55</a></li>
<li>Defined in <a href="https://github.com/schmelczerandras/sdf-2d/blob/3fb6cc0/src/graphics/rendering/renderer/renderer.ts#L57">graphics/rendering/renderer/renderer.ts:57</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@ -372,7 +373,7 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>worldCoordinates: <span class="tsd-signature-type">vec2</span></h5>
<h5>worldCoordinates: <span class="tsd-signature-type">ReadonlyVec2</span></h5>
<div class="tsd-comment tsd-typography">
<p>Coordinates used when drawing objects.</p>
</div>