Updated documentation pages.

Author: nthnn

docs/goblin3d_8h.html

@@ -157,7 +157,7 @@
 <li>Pre-calculate the 3D coordinates based on rotation angles.</li>
 <li>Render the 3D objects onto a 2D surface.</li>
 </ul>
-<h2><a class="anchor" id="autotoc_md11"></a>
+<h2><a class="anchor" id="autotoc_md0"></a>
 Usage Example</h2>
 <div class="fragment"><div class="line"><a class="code hl_struct" href="structgoblin3d__obj__t.html">goblin3d_obj_t</a> cube;</div>
 <div class="line"><a class="code hl_function" href="goblin3d_8h.html#ae24db99a854272ed44f23fa50bbc5fda">goblin3d_init</a>(&amp;cube, 8, 12);</div>

docs/index.html

@@ -95,19 +95,19 @@
 </div><!--header-->
 <div class="contents">
 <div class="toc"><h3>Table of Contents</h3>
-<ul><ul><li class="level2"><a href="#autotoc_md0">Features</a></li>
-<li class="level2"><a href="#autotoc_md1">Installation</a><ul><li class="level3"><a href="#autotoc_md2">Arduino Library Manager</a></li>
-<li class="level3"><a href="#autotoc_md3">Manual Installation</a></li>
+<ul><ul><li class="level2"><a href="#autotoc_md1">Features</a></li>
+<li class="level2"><a href="#autotoc_md2">Installation</a><ul><li class="level3"><a href="#autotoc_md3">Arduino Library Manager</a></li>
+<li class="level3"><a href="#autotoc_md4">Manual Installation</a></li>
 </ul>
 </li>
-<li class="level2"><a href="#autotoc_md4">Getting Started</a><ul><li class="level3"><a href="#autotoc_md5">Quick Start</a></li>
-<li class="level3"><a href="#autotoc_md6">Basic Usage</a></li>
+<li class="level2"><a href="#autotoc_md5">Getting Started</a><ul><li class="level3"><a href="#autotoc_md6">Quick Start</a></li>
+<li class="level3"><a href="#autotoc_md7">Basic Usage</a></li>
 </ul>
 </li>
-<li class="level2"><a href="#autotoc_md7">Exporting from Blender</a></li>
-<li class="level2"><a href="#autotoc_md8">Use Cases</a></li>
-<li class="level2"><a href="#autotoc_md9">Contribution and Feedback</a></li>
-<li class="level2"><a href="#autotoc_md10">License</a></li>
+<li class="level2"><a href="#autotoc_md8">Exporting from Blender</a></li>
+<li class="level2"><a href="#autotoc_md9">Use Cases</a></li>
+<li class="level2"><a href="#autotoc_md10">Contribution and Feedback</a></li>
+<li class="level2"><a href="#autotoc_md11">License</a></li>
 </ul>
 </ul>
 </div>
@@ -119,7 +119,7 @@
 <blockquote class="doxtable">
 <p >&zwj;This library is also compatible with desktop environments. You can simply integrate it with SLD2, OpenGL, et cetera. </p>
 </blockquote>
-<h2><a class="anchor" id="autotoc_md0"></a>
+<h2><a class="anchor" id="autotoc_md1"></a>
 Features</h2>
 <ul>
 <li><b>3D Wireframe Rendering</b>: Render basic 3D shapes as wireframes on displays.</li>
@@ -131,32 +131,32 @@ <h2><a class="anchor" id="autotoc_md0"></a>
 </ul>
 <p ><img src="https://raw.githubusercontent.com/nthnn/goblin3d/main/assets/goblin3d_sdl2.png" alt="Goblin3D port with SDL2" class="inline"/> <br  />
  Goblin3D port with SDL2 </p>
-<h2><a class="anchor" id="autotoc_md1"></a>
+<h2><a class="anchor" id="autotoc_md2"></a>
 Installation</h2>
-<h3><a class="anchor" id="autotoc_md2"></a>
+<h3><a class="anchor" id="autotoc_md3"></a>
 Arduino Library Manager</h3>
 <ol type="1">
 <li>Open the Arduino IDE.</li>
 <li>Go to <b>Sketch</b> &gt; <b>Include Library</b> &gt; <b>Manage Libraries...</b></li>
 <li>Search for <b>Goblin3D</b>.</li>
 <li>Click <b>Install</b>.</li>
 </ol>
-<h3><a class="anchor" id="autotoc_md3"></a>
+<h3><a class="anchor" id="autotoc_md4"></a>
 Manual Installation</h3>
 <ol type="1">
 <li>Download the latest release from the <a href="https://github.com/nthnn/goblin3d/releases">Releases</a> page.</li>
 <li>Unzip the downloaded file.</li>
 <li>Move the <code>Goblin3D</code> folder to your Arduino libraries directory (typically <code>~/Documents/Arduino/libraries/</code> on Windows and Linux, <code>~/Documents/Arduino/libraries/</code> on macOS).</li>
 <li>Restart the Arduino IDE.</li>
 </ol>
-<h2><a class="anchor" id="autotoc_md4"></a>
+<h2><a class="anchor" id="autotoc_md5"></a>
 Getting Started</h2>
-<h3><a class="anchor" id="autotoc_md5"></a>
+<h3><a class="anchor" id="autotoc_md6"></a>
 Quick Start</h3>
 <p >Goblin3D SDL2 port example is availble on Docker to try it out.</p>
 <div class="fragment"><div class="line">docker pull nthnn/goblin3d</div>
 <div class="line">docker run -it -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix goblin3d</div>
-</div><!-- fragment --><h3><a class="anchor" id="autotoc_md6"></a>
+</div><!-- fragment --><h3><a class="anchor" id="autotoc_md7"></a>
 Basic Usage</h3>
 <p >Here’s a simple example of how to use Goblin3D to load an <code>*.obj</code> file from SD card to TFT ILI9341 display.</p>
 <div class="fragment"><div class="line"><span class="preprocessor">#include &lt;SPI.h&gt;</span>                <span class="comment">// Include the SPI library for SPI communication</span></div>
@@ -237,7 +237,7 @@ <h3><a class="anchor" id="autotoc_md5"></a>
 <div class="ttc" id="astructgoblin3d__obj__t_html_a73211958e688cffbfac2007390e676ce"><div class="ttname"><a href="structgoblin3d__obj__t.html#a73211958e688cffbfac2007390e676ce">goblin3d_obj_t::x_offset</a></div><div class="ttdeci">float x_offset</div><div class="ttdef"><b>Definition:</b> goblin3d.h:78</div></div>
 <div class="ttc" id="astructgoblin3d__obj__t_html_a984579501435e1bf51d915e0a67ce13f"><div class="ttname"><a href="structgoblin3d__obj__t.html#a984579501435e1bf51d915e0a67ce13f">goblin3d_obj_t::x_angle_deg</a></div><div class="ttdeci">float x_angle_deg</div><div class="ttdef"><b>Definition:</b> goblin3d.h:81</div></div>
 <div class="ttc" id="astructgoblin3d__obj__t_html_ad102db071d1e1ded4dc4b1951443ff57"><div class="ttname"><a href="structgoblin3d__obj__t.html#ad102db071d1e1ded4dc4b1951443ff57">goblin3d_obj_t::y_angle_deg</a></div><div class="ttdeci">float y_angle_deg</div><div class="ttdef"><b>Definition:</b> goblin3d.h:82</div></div>
-</div><!-- fragment --><h2><a class="anchor" id="autotoc_md7"></a>
+</div><!-- fragment --><h2><a class="anchor" id="autotoc_md8"></a>
 Exporting from Blender</h2>
 <p >Follow these steps to export a 3D scene from Blender in a format compatible with Goblin3D:</p>
 <ol type="1">
@@ -254,7 +254,7 @@ <h3><a class="anchor" id="autotoc_md5"></a>
 <p class="startli">When saving, you do not need to include the Material File (*.mtl) since Goblin3D only renders the wireframe, and materials are not required for this purpose. Simply save the OBJ file, and it's ready for use with Goblin3D.</p>
 </li>
 </ol>
-<h2><a class="anchor" id="autotoc_md8"></a>
+<h2><a class="anchor" id="autotoc_md9"></a>
 Use Cases</h2>
 <ol type="1">
 <li><p class="startli"><b>Low-Power Displays</b></p>
@@ -270,10 +270,10 @@ <h2><a class="anchor" id="autotoc_md8"></a>
 <p class="startli">Goblin3D can be used to develop retro-style 3D games on resource-constrained devices, where wireframe graphics give a nostalgic feel while minimizing resource usage.</p>
 </li>
 </ol>
-<h2><a class="anchor" id="autotoc_md9"></a>
+<h2><a class="anchor" id="autotoc_md10"></a>
 Contribution and Feedback</h2>
 <p >Contributions and feedback are all welcome to enhance this library. If you encounter any issues, have suggestions for improvements, or would like to contribute code, please do so.</p>
-<h2><a class="anchor" id="autotoc_md10"></a>
+<h2><a class="anchor" id="autotoc_md11"></a>
 License</h2>
 <p >Copyright 2024 - Nathanne Isip</p>
 <p >Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>

docs/navtreedata.js

@@ -26,19 +26,19 @@ var NAVTREE =
 [
   [ "Goblin3D", "index.html", [
     [ "Classes", "annotated.html", [
-      [ "Features", "index.html#autotoc_md0", null ],
-      [ "Installation", "index.html#autotoc_md1", [
-        [ "Arduino Library Manager", "index.html#autotoc_md2", null ],
-        [ "Manual Installation", "index.html#autotoc_md3", null ]
+      [ "Features", "index.html#autotoc_md1", null ],
+      [ "Installation", "index.html#autotoc_md2", [
+        [ "Arduino Library Manager", "index.html#autotoc_md3", null ],
+        [ "Manual Installation", "index.html#autotoc_md4", null ]
       ] ],
-      [ "Getting Started", "index.html#autotoc_md4", [
-        [ "Quick Start", "index.html#autotoc_md5", null ],
-        [ "Basic Usage", "index.html#autotoc_md6", null ]
+      [ "Getting Started", "index.html#autotoc_md5", [
+        [ "Quick Start", "index.html#autotoc_md6", null ],
+        [ "Basic Usage", "index.html#autotoc_md7", null ]
       ] ],
-      [ "Exporting from Blender", "index.html#autotoc_md7", null ],
-      [ "Use Cases", "index.html#autotoc_md8", null ],
-      [ "Contribution and Feedback", "index.html#autotoc_md9", null ],
-      [ "License", "index.html#autotoc_md10", null ],
+      [ "Exporting from Blender", "index.html#autotoc_md8", null ],
+      [ "Use Cases", "index.html#autotoc_md9", null ],
+      [ "Contribution and Feedback", "index.html#autotoc_md10", null ],
+      [ "License", "index.html#autotoc_md11", null ],
       [ "Class List", "annotated.html", "annotated_dup" ],
       [ "Class Index", "classes.html", null ],
       [ "Class Members", "functions.html", [

docs/navtreeindex0.js

@@ -22,17 +22,17 @@ var NAVTREEINDEX0 =
 "goblin3d_8h.html#aff1873324d513c1661b6238fffc44646":[1,0,0,0,2],
 "goblin3d_8h_source.html":[1,0,0,0],
 "index.html":[],
-"index.html#autotoc_md0":[0],
-"index.html#autotoc_md1":[1],
-"index.html#autotoc_md10":[6],
-"index.html#autotoc_md2":[1,0],
-"index.html#autotoc_md3":[1,1],
-"index.html#autotoc_md4":[2],
-"index.html#autotoc_md5":[2,0],
-"index.html#autotoc_md6":[2,1],
-"index.html#autotoc_md7":[3],
-"index.html#autotoc_md8":[4],
-"index.html#autotoc_md9":[5],
+"index.html#autotoc_md1":[0],
+"index.html#autotoc_md10":[5],
+"index.html#autotoc_md11":[6],
+"index.html#autotoc_md2":[1],
+"index.html#autotoc_md3":[1,0],
+"index.html#autotoc_md4":[1,1],
+"index.html#autotoc_md5":[2],
+"index.html#autotoc_md6":[2,0],
+"index.html#autotoc_md7":[2,1],
+"index.html#autotoc_md8":[3],
+"index.html#autotoc_md9":[4],
 "pages.html":[],
 "structgoblin3d__obj__t.html":[0,7,0],
 "structgoblin3d__obj__t.html#a1205c0f08198faf9f32d705672442790":[0,7,0,3],