Updated documentation pages.

docs/goblin3d_8h.html

@@ -142,7 +142,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_md8"></a>
+<h2><a class="anchor" id="autotoc_md3"></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#a8dcba9fbaaaae19b78d1913c749a5ba9">goblin3d_init</a>(&amp;cube, 8, 12);</div>

docs/index.html

@@ -97,20 +97,23 @@
 <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>
+<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">Basic Usage</a></li>
+<li class="level2"><a href="#autotoc_md5">Getting Started</a><ul><li class="level3"><a href="#autotoc_md6">Basic Usage</a></li>
 </ul>
 </li>
-<li class="level2"><a href="#autotoc_md6">Contribution and Feedback</a></li>
-<li class="level2"><a href="#autotoc_md7">License</a></li>
+<li class="level2"><a href="#autotoc_md7">Contribution and Feedback</a></li>
+<li class="level2"><a href="#autotoc_md8">License</a></li>
 </ul>
 </ul>
 </div>
 <div class="textblock"><div align="center"> <h1>Goblin3D</h1>
-</div><div align="center"> </div><p ><img src="https://github.com/nthnn/goblin3d/actions/workflows/arduino_ci.yml/badge.svg" alt="Arduino CI" style="pointer-events: none;" class="inline"/> <img src="https://github.com/nthnn/goblin3d/actions/workflows/arduino_lint.yml/badge.svg" alt="Arduino Lint" style="pointer-events: none;" class="inline"/> <img src="https://img.shields.io/badge/Library%20Manager-v0.0.1-red?logo=Arduino" alt="Arduino Release" class="inline"/> <a href="https://github.com/nthnn/goblin3d/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT" style="pointer-events: none;" class="inline"/></a></p>
+</div><div align="center"> </div><p ><img src="https://github.com/nthnn/goblin3d/actions/workflows/arduino_ci.yml/badge.svg" alt="Arduino CI" style="pointer-events: none;" class="inline"/> <img src="https://github.com/nthnn/goblin3d/actions/workflows/arduino_lint.yml/badge.svg" alt="Arduino Lint" style="pointer-events: none;" class="inline"/> <img src="https://github.com/nthnn/goblin3d/actions/workflows/sdl2_ci.yml/badge.svg" alt="SDL2 Port CI" style="pointer-events: none;" class="inline"/> <img src="https://img.shields.io/badge/Library%20Manager-v0.0.1-red?logo=Arduino" alt="Arduino Release" class="inline"/> <a href="https://github.com/nthnn/goblin3d/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT" style="pointer-events: none;" class="inline"/></a></p>
 <p ><b>Goblin3D</b> is a lightweight, dependency-free graphics engine designed for rendering 3D wireframes on monochromatic displays and TFT LCDs using the Arduino platform. Goblin3D is perfect for embedded systems where resources are limited but 3D rendering capabilities are desired.</p>
+<p align="center"></p>
+<p ><img src="assets/goblin3d_demo.jpg" alt="Goblin3D demo" width="480" class="inline"/> <br />
+ Goblin3D demo with ESP32 on TFT and OLED. </p>
 <h2><a class="anchor" id="autotoc_md0"></a>
 Features</h2>
 <ul>
@@ -120,6 +123,8 @@ <h2><a class="anchor" id="autotoc_md0"></a>
 <li><b>Customizable Objects</b>: Easily define and manipulate custom 3D objects with your own vertices and edges.</li>
 <li><b>Rotation and Scaling</b>: Support for rotating and scaling objects in 3D space.</li>
 </ul>
+<p ><img src="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>
 Installation</h2>
 <h3><a class="anchor" id="autotoc_md2"></a>
@@ -130,17 +135,17 @@ <h3><a class="anchor" id="autotoc_md2"></a>
 <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>
 Basic Usage</h3>
 <p >Here’s a simple example of how to use Goblin3D to render a rotating 3D house-shape object on an OLED display:</p>
 <div class="fragment"><div class="line"><span class="preprocessor">#include &lt;Adafruit_SSD1306.h&gt;</span> <span class="comment">// Include the library for SSD1306 OLED display</span></div>
@@ -237,10 +242,10 @@ <h3><a class="anchor" id="autotoc_md5"></a>
 <div class="ttc" id="astructgoblin3d__obj__t_html_a8a289a9f43ef503c366710d5a6f51f5d"><div class="ttname"><a href="structgoblin3d__obj__t.html#a8a289a9f43ef503c366710d5a6f51f5d">goblin3d_obj_t::edges</a></div><div class="ttdeci">uint8_t ** edges</div><div class="ttdef"><b>Definition:</b> goblin3d.h:74</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_md6"></a>
+</div><!-- fragment --><h2><a class="anchor" id="autotoc_md7"></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_md7"></a>
+<h2><a class="anchor" id="autotoc_md8"></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

@@ -29,13 +29,13 @@ var NAVTREE =
  [ "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 ]
+ [ "Manual Installation", "index.html#autotoc_md4", null ]
  ] ],
- [ "Getting Started", "index.html#autotoc_md4", [
- [ "Basic Usage", "index.html#autotoc_md5", null ]
+ [ "Getting Started", "index.html#autotoc_md5", [
+ [ "Basic Usage", "index.html#autotoc_md6", null ]
  ] ],
- [ "Contribution and Feedback", "index.html#autotoc_md6", null ],
- [ "License", "index.html#autotoc_md7", null ],
+ [ "Contribution and Feedback", "index.html#autotoc_md7", null ],
+ [ "License", "index.html#autotoc_md8", null ],
  [ "Class List", "annotated.html", "annotated_dup" ],
  [ "Class Index", "classes.html", null ],
  [ "Class Members", "functions.html", [

docs/navtreeindex0.js

@@ -20,11 +20,11 @@ var NAVTREEINDEX0 =
 "index.html#autotoc_md0":[0],
 "index.html#autotoc_md1":[1],
 "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":[3],
-"index.html#autotoc_md7":[4],
+"index.html#autotoc_md4":[1,1],
+"index.html#autotoc_md5":[2],
+"index.html#autotoc_md6":[2,0],
+"index.html#autotoc_md7":[3],
+"index.html#autotoc_md8":[4],
 "pages.html":[],
 "structgoblin3d__obj__t.html":[0,5,0],
 "structgoblin3d__obj__t.html#a1664e18deccebb74fe1aa9860e6f1027":[0,5,0,2],