summaryrefslogtreecommitdiffstats
path: root/dev/MinGfx/docs/html/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'dev/MinGfx/docs/html/index.html')
-rw-r--r--dev/MinGfx/docs/html/index.html120
1 files changed, 120 insertions, 0 deletions
diff --git a/dev/MinGfx/docs/html/index.html b/dev/MinGfx/docs/html/index.html
new file mode 100644
index 0000000..f2bd267
--- /dev/null
+++ b/dev/MinGfx/docs/html/index.html
@@ -0,0 +1,120 @@
+<!-- HTML header for doxygen 1.8.9.1-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.9.1"/>
+<title>MinGfx Toolkit: MinGfx Toolkit Documentation</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/x-mathjax-config">
+ MathJax.Hub.Config({
+ extensions: ["tex2jax.js"],
+ jax: ["input/TeX","output/HTML-CSS"],
+});
+</script>
+<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+ <td style="padding-left: 0.5em;">
+ <div id="projectname">MinGfx Toolkit
+ &#160;<span id="projectnumber">1.0</span>
+ </div>
+ <div id="projectbrief">A minimal library for writing cross-platform (Windows, OSX, linux) graphics programs.</div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.9.1 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(function() {
+ initMenu('',true,false,'search.php','Search');
+ $(document).ready(function() { init_search(); });
+});
+/* @license-end */</script>
+<div id="main-nav"></div>
+</div><!-- top -->
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0"
+ name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="PageDoc"><div class="header">
+ <div class="headertitle">
+<div class="title">MinGfx Toolkit Documentation </div> </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><p><a class="anchor" id="mainpage"></a></p>
+<h1><a class="anchor" id="autotoc_md11"></a>
+Getting Started</h1>
+<ol type="1">
+<li><a class="el" href="installation.html">libMinGfx Installation Guide</a></li>
+<li><a class="el" href="installation.html#example">Create Your Own Graphics Program by Copying an Example</a></li>
+<li><a class="el" href="api.html">Bookmark the API - The MinGfx Programming Reference Organized by Topic</a></li>
+</ol>
+<h1><a class="anchor" id="autotoc_md12"></a>
+Programming Guide</h1>
+<ul>
+<li><a class="el" href="api.html">MinGfx Programming Reference</a></li>
+<li>Adding NanoGUI Elements (buttons, sliders, other GUI widgets)<ul>
+<li><a href="https://nanogui.readthedocs.io/en/latest/">NanoGUI Documentation</a></li>
+<li><a href="https://github.com/wjakob/nanogui">NanoGUI GitHub Repo</a></li>
+</ul>
+</li>
+<li>Drawing Using NanoVG (for 2D vector graphics)<ul>
+<li><a href="https://github.com/memononen/NanoVG">NanoVG Documentation</a></li>
+<li><a href="https://github.com/memononen/nanovg/blob/master/src/nanovg.h">nanovg.h &ndash; the best place to see all the possible commands</a></li>
+</ul>
+</li>
+<li>Drawing Using OpenGL (for 3D graphics)<ul>
+<li><a href="https://learnopengl.com/Introduction">learnopengl.com</a></li>
+<li><a href="https://www.google.com/search?q=opengl+3.3+guide">Google for OpenGL 3.3 Guide</a></li>
+</ul>
+</li>
+</ul>
+<h1><a class="anchor" id="autotoc_md13"></a>
+Overview</h1>
+<p>The MinGfx Toolkit is a minimal library for writing cross-platform (Windows, OSX, linux) graphics programs with modern OpenGL 3.3+ support. Application programmers should subclass from MinGfx::GraphicsApp, which provides callbacks for several styles of rendering and user interfaces. On-screen graphical user interfaces can be created with built-in support for NanoGUI. 2D vector graphics rendering is supported by linking with NanoVG. 3D graphics rendering is supported via MinGfx::Mesh, MinGfx::Shader, MinGfx::Texture2D, and related classes. Additionally, application programmers can do whatever custom 2D or 3D rendering is needed with direct calls to OpenGL.</p>
+<p>The library is maintained by Prof. Daniel Keefe (<a href="#" onclick="location.href='mai'+'lto:'+'dfk'+'@u'+'mn.'+'ed'+'u'; return false;">dfk@u<span style="display: none;">.nosp@m.</span>mn.e<span style="display: none;">.nosp@m.</span>du</a>) and is used for instructional purposes in UMN computer science courses (CSci-4611, CSci-3081W, ...) as well as some research projects. See LICENSE.txt for additional details. </p>
+</div></div><!-- PageDoc -->
+</div><!-- contents -->
+<!-- HTML footer for doxygen 1.8.9.1-->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.9.1
+</small></address>
+</body>
+</html>