started woking on figuring out doxygen documentation and added readme
This commit is contained in:
herbglitch
parent
c598f3e106
commit
3f0556341c
1192 changed files with 199462 additions and 29 deletions
271
doc/doxygen/html/d1/d55/engine_8h.html
Normal file
271
doc/doxygen/html/d1/d55/engine_8h.html
Normal file
|
|
@ -0,0 +1,271 @@
|
|||
<!-- HTML header for doxygen 1.9.2-->
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" class="dark-mode">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen 1.12.0"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Archeus: /home/herbglitch/programs/archeus/arc/include/arc/engine/engine.h File Reference</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="../../navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="../../navtreedata.js"></script>
|
||||
<script type="text/javascript" src="../../navtree.js"></script>
|
||||
<script type="text/javascript" src="../../resize.js"></script>
|
||||
<script type="text/javascript" src="../../cookie.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>
|
||||
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
|
||||
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="../../doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
|
||||
<link href="../../doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="../../doxygen-awesome-darkmode-toggle.js"></script>
|
||||
</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 id="projectalign" style="padding-left: 0.5em;">
|
||||
<div id="projectname">Archeus<span id="projectnumber"> 0.0.0</span>
|
||||
</div>
|
||||
<div id="projectbrief">A C library and game engine that focuses on documentation</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.12.0 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() { codefold.init(1); });
|
||||
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() {
|
||||
initMenu('../../',true,false,'search.php','Search',true);
|
||||
$(function() { init_search(); });
|
||||
});
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function(){initNavTree('d1/d55/engine_8h.html','../../'); initResizable(true); });
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- 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">
|
||||
<div id="MSearchResults">
|
||||
<div class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div id="SRResults"></div>
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#nested-classes">Data Structures</a> |
|
||||
<a href="#typedef-members">Typedefs</a> |
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle"><div class="title">engine.h File Reference</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock"><code>#include "<a class="el" href="../../d3/df1/window_8h_source.html">arc/graphics/window.h</a>"</code><br />
|
||||
<code>#include "<a class="el" href="../../d6/d85/renderer_8h_source.html">arc/graphics/renderer.h</a>"</code><br />
|
||||
<code>#include "<a class="el" href="../../de/ded/input_8h_source.html">arc/input/input.h</a>"</code><br />
|
||||
<code>#include "<a class="el" href="../../dc/ded/mouse_8h_source.html">arc/input/mouse.h</a>"</code><br />
|
||||
<code>#include "<a class="el" href="../../d6/da0/keyboard_8h_source.html">arc/input/keyboard.h</a>"</code><br />
|
||||
<code>#include "<a class="el" href="../../d2/d91/point_8h_source.html">arc/math/point.h</a>"</code><br />
|
||||
<code>#include "<a class="el" href="../../d8/d77/bool_8h_source.html">arc/std/bool.h</a>"</code><br />
|
||||
<code>#include "<a class="el" href="../../dd/dee/handler_8h_source.html">arc/std/handler.h</a>"</code><br />
|
||||
</div>
|
||||
<p><a href="../../d1/d55/engine_8h_source.html">Go to the source code of this file.</a></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
||||
Data Structures</h2></td></tr>
|
||||
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a></td></tr>
|
||||
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
||||
Typedefs</h2></td></tr>
|
||||
<tr class="memitem:a5f80ada5dfc3cf5b3e5d8aa840c86f6e" id="r_a5f80ada5dfc3cf5b3e5d8aa840c86f6e"><td class="memItemLeft" align="right" valign="top">typedef struct ARC_EngineData </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5f80ada5dfc3cf5b3e5d8aa840c86f6e">ARC_EngineData</a></td></tr>
|
||||
<tr class="memdesc:a5f80ada5dfc3cf5b3e5d8aa840c86f6e"><td class="mdescLeft"> </td><td class="mdescRight">predefien <a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> so as not to get circular reference <br /></td></tr>
|
||||
<tr class="separator:a5f80ada5dfc3cf5b3e5d8aa840c86f6e"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:ad3bfb475a0e9264c87a7423e84778959" id="r_ad3bfb475a0e9264c87a7423e84778959"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad3bfb475a0e9264c87a7423e84778959">ARC_EngineData_Create</a> (<a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> **data, <a class="el" href="../../dd/dee/handler_8h.html#a97613b0958fc34c00446d4dc669737a1">ARC_Handler_CleanDataFn</a> cleanFn, <a class="el" href="../../d2/d9d/structARC__Point.html">ARC_Point</a> windowSize)</td></tr>
|
||||
<tr class="separator:ad3bfb475a0e9264c87a7423e84778959"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad7a41810e95706dad5c6881879339aa2" id="r_ad7a41810e95706dad5c6881879339aa2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad7a41810e95706dad5c6881879339aa2">ARC_EngineData_Destroy</a> (<a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> *data)</td></tr>
|
||||
<tr class="separator:ad7a41810e95706dad5c6881879339aa2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a1318b7466d14187d6648abc7474c1ac7" id="r_a1318b7466d14187d6648abc7474c1ac7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1318b7466d14187d6648abc7474c1ac7">ARC_Engine_RunUncapped</a> (<a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> *data)</td></tr>
|
||||
<tr class="memdesc:a1318b7466d14187d6648abc7474c1ac7"><td class="mdescLeft"> </td><td class="mdescRight">runs ARC_Engine with an uncapped framerate <br /></td></tr>
|
||||
<tr class="separator:a1318b7466d14187d6648abc7474c1ac7"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<h2 class="groupheader">Typedef Documentation</h2>
|
||||
<a id="a5f80ada5dfc3cf5b3e5d8aa840c86f6e" name="a5f80ada5dfc3cf5b3e5d8aa840c86f6e"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a5f80ada5dfc3cf5b3e5d8aa840c86f6e">◆ </a></span>ARC_EngineData</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">typedef struct ARC_EngineData ARC_EngineData</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>predefien <a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> so as not to get circular reference </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="../../d6/d85/renderer_8h_source.html#l00011">11</a> of file <a class="el" href="../../d6/d85/renderer_8h_source.html">renderer.h</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a id="a1318b7466d14187d6648abc7474c1ac7" name="a1318b7466d14187d6648abc7474c1ac7"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a1318b7466d14187d6648abc7474c1ac7">◆ </a></span>ARC_Engine_RunUncapped()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void ARC_Engine_RunUncapped </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> *</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>runs ARC_Engine with an uncapped framerate </p>
|
||||
<dl class="section note"><dt>Note</dt><dd>data must be created before this function </dd>
|
||||
<dd>
|
||||
data should be destroyed after this function</dd></dl>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">data</td><td>engine data that will be used </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ad3bfb475a0e9264c87a7423e84778959" name="ad3bfb475a0e9264c87a7423e84778959"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ad3bfb475a0e9264c87a7423e84778959">◆ </a></span>ARC_EngineData_Create()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void ARC_EngineData_Create </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> **</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="../../dd/dee/handler_8h.html#a97613b0958fc34c00446d4dc669737a1">ARC_Handler_CleanDataFn</a></td> <td class="paramname"><span class="paramname"><em>cleanFn</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"><a class="el" href="../../d2/d9d/structARC__Point.html">ARC_Point</a></td> <td class="paramname"><span class="paramname"><em>windowSize</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>@breif creates an <a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> type to be used when running an ARC_Engine</p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">data</td><td>the <a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> to create </td></tr>
|
||||
<tr><td class="paramname">cleanFn</td><td>the state cleanup function </td></tr>
|
||||
<tr><td class="paramname">windowSIze</td><td>the size of window to create passed as an <a class="el" href="../../d2/d9d/structARC__Point.html">ARC_Point</a> </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ad7a41810e95706dad5c6881879339aa2" name="ad7a41810e95706dad5c6881879339aa2"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ad7a41810e95706dad5c6881879339aa2">◆ </a></span>ARC_EngineData_Destroy()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void ARC_EngineData_Destroy </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"><a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> *</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>@breif destroys an <a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> type</p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">data</td><td>the <a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> to destroy </td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- HTML footer for doxygen 1.9.2-->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul><li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_b29a8eaba25fe5828ebef328b36f3b30.html">engine</a></li><li class="navelem"><a class="el" href="../../d1/d55/engine_8h.html">engine.h</a></li></ul>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
// script for doxygen 1.9.1
|
||||
$(function() {
|
||||
toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
|
||||
toggleButton.title = "Toggle Light/Dark Mode"
|
||||
$(document).ready(function(){
|
||||
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
|
||||
})
|
||||
$(window).resize(function(){
|
||||
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
|
||||
})
|
||||
})
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue