diff options
Diffstat (limited to '')
| -rw-r--r-- | dev/MinGfx/docs/html/api.html | 168 |
1 files changed, 168 insertions, 0 deletions
diff --git a/dev/MinGfx/docs/html/api.html b/dev/MinGfx/docs/html/api.html new file mode 100644 index 0000000..5e0df60 --- /dev/null +++ b/dev/MinGfx/docs/html/api.html @@ -0,0 +1,168 @@ +<!-- 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: API - MinGfx Programming Reference Organized by Topic</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 +  <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&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&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> +<!-- 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><!-- top --> +<div class="PageDoc"><div class="header"> + <div class="headertitle"> +<div class="title">API - MinGfx Programming Reference Organized by Topic </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p><a class="anchor" id="md_doc_api"></a></p> +<h1><a class="anchor" id="autotoc_md0"></a> +API by Topic</h1> +<table class="markdownTable"> +<tr class="markdownTableHead"> +<th class="markdownTableHeadNone">Application Class </th></tr> +<tr class="markdownTableRowOdd"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_graphics_app.html">GraphicsApp</a> </td></tr> +</table> +<table class="markdownTable"> +<tr class="markdownTableHead"> +<th class="markdownTableHeadNone">3D Models </th></tr> +<tr class="markdownTableRowOdd"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_quick_shapes.html">QuickShapes</a> </td></tr> +<tr class="markdownTableRowEven"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_mesh.html">Mesh</a> </td></tr> +</table> +<table class="markdownTable"> +<tr class="markdownTableHead"> +<th class="markdownTableHeadNone">Color and Textures </th></tr> +<tr class="markdownTableRowOdd"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_color.html">Color</a> </td></tr> +<tr class="markdownTableRowEven"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_texture2_d.html">Texture2D</a> </td></tr> +</table> +<table class="markdownTable"> +<tr class="markdownTableHead"> +<th class="markdownTableHeadNone">Graphics Math </th></tr> +<tr class="markdownTableRowOdd"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_matrix4.html">Matrix4</a> </td></tr> +<tr class="markdownTableRowEven"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_point2.html">Point2</a> </td></tr> +<tr class="markdownTableRowOdd"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_point3.html">Point3</a> </td></tr> +<tr class="markdownTableRowEven"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_vector2.html">Vector2</a> </td></tr> +<tr class="markdownTableRowOdd"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_vector3.html">Vector3</a> </td></tr> +<tr class="markdownTableRowEven"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_ray.html">Ray</a> </td></tr> +<tr class="markdownTableRowOdd"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_quaternion.html">Quaternion</a> </td></tr> +<tr class="markdownTableRowEven"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_gfx_math.html">GfxMath</a> </td></tr> +</table> +<table class="markdownTable"> +<tr class="markdownTableHead"> +<th class="markdownTableHeadNone">Shader Programs </th></tr> +<tr class="markdownTableRowOdd"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_default_shader.html">DefaultShader</a> </td></tr> +<tr class="markdownTableRowEven"> +<td class="markdownTableBodyNone">- <a class="el" href="classmingfx_1_1_default_shader_1_1_light_properties.html">DefaultShader::LightProperties</a> </td></tr> +<tr class="markdownTableRowOdd"> +<td class="markdownTableBodyNone">- <a class="el" href="classmingfx_1_1_default_shader_1_1_material_properties.html">DefaultShader::MaterialProperties</a> </td></tr> +<tr class="markdownTableRowEven"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_shader_program.html">ShaderProgram</a> </td></tr> +</table> +<table class="markdownTable"> +<tr class="markdownTableHead"> +<th class="markdownTableHeadNone">User Interface </th></tr> +<tr class="markdownTableRowOdd"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_craft_cam.html">CraftCam</a> </td></tr> +<tr class="markdownTableRowEven"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_uni_cam.html">UniCam</a> </td></tr> +</table> +<table class="markdownTable"> +<tr class="markdownTableHead"> +<th class="markdownTableHeadNone">File I/O and System Routines </th></tr> +<tr class="markdownTableRowOdd"> +<td class="markdownTableBodyNone"><a class="el" href="classmingfx_1_1_platform.html">Platform</a> </td></tr> +</table> +<h1><a class="anchor" id="autotoc_md1"></a> +Coding Style</h1> +<p>The library follows the <a href="https://google.github.io/styleguide/cppguide.html">Google C++ Style Guide</a>, in part as an example for students, since this style is also used in several courses. There are several things that programmers who are not familiar with the Google style might find unusual. These are the most common style rules to note:</p><ul> +<li>C++ source filenames are all lowercase with underscores, and a .cc extension is used instead of .cpp.</li> +<li>Variable names are all lowercase with underscores.</li> +<li>Class member variables are named the same as regular variables but with a trailing _, as in my_member_var_.</li> +<li>Functions start with capital letters unless they are small getter or setter methods.</li> +<li>There are many other rules, a solid discussion of pros/cons, and an automated style checker <a href="https://google.github.io/styleguide/cppguide.html">here</a>. </li> +</ul> +</div></div><!-- contents --> +</div><!-- PageDoc --> +<!-- HTML footer for doxygen 1.8.9.1--> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.9.1 +</small></address> +</body> +</html> |