herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

started woking on figuring out doxygen documentation and added readme

Browse source
This commit is contained in:
herbglitch 2024-12-24 03:47:16 -07:00
parent c598f3e106
commit 3f0556341c
1192 changed files with 199462 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

252
doc/doxygen/html/d1/d06/input_8c.html Normal file
View file

@ -0,0 +1,252 @@
<!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" lang="en-US">
<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/src/input/input.c 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>
<script type="text/javascript" src="../../clipboard.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<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" />
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">Archeus<span id="projectnumber">&#160;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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="../../dir_d365e15d984c8d0205117ee0c40d6716.html">input</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">input.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="../../de/ded/input_8h_source.html">arc/input/input.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d8/d77/bool_8h_source.html">arc/std/bool.h</a>&quot;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
</div>
<p><a href="../../d1/d06/input_8c_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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ab067b02367e78494a930fcccdd930c0c" id="r_ab067b02367e78494a930fcccdd930c0c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab067b02367e78494a930fcccdd930c0c">ARC_Input_CreateWithEngineData</a> (<a class="el" href="../../de/ded/input_8h.html#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> **input, <a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> *data)</td></tr>
<tr class="separator:ab067b02367e78494a930fcccdd930c0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f88d045f196b8460a62f4c32ee23f54" id="r_a3f88d045f196b8460a62f4c32ee23f54"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3f88d045f196b8460a62f4c32ee23f54">ARC_Input_Destroy</a> (<a class="el" href="../../de/ded/input_8h.html#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *input)</td></tr>
<tr class="separator:a3f88d045f196b8460a62f4c32ee23f54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb3fa56528406720283b62b2b713e118" id="r_afb3fa56528406720283b62b2b713e118"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/d77/bool_8h.html#aad51710c999c22d9440e5ce0ba8e2c45">ARC_Bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afb3fa56528406720283b62b2b713e118">ARC_Input_Update</a> (<a class="el" href="../../de/ded/input_8h.html#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *input)</td></tr>
<tr class="separator:afb3fa56528406720283b62b2b713e118"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33b395c2b23fb459904fef05df97ae5d" id="r_a33b395c2b23fb459904fef05df97ae5d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d6/da0/keyboard_8h.html#acec0a71060ec7186a323710608bd93e7">ARC_Keyboard</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a33b395c2b23fb459904fef05df97ae5d">ARC_Input_GetKeyboard</a> (<a class="el" href="../../de/ded/input_8h.html#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *input)</td></tr>
<tr class="separator:a33b395c2b23fb459904fef05df97ae5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5de153e8f7dd3212cb998ea2ad29c4f6" id="r_a5de153e8f7dd3212cb998ea2ad29c4f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../dc/ded/mouse_8h.html#a902312c6398b8df6994f040d103b507b">ARC_Mouse</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5de153e8f7dd3212cb998ea2ad29c4f6">ARC_Input_GetMouse</a> (<a class="el" href="../../de/ded/input_8h.html#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *input)</td></tr>
<tr class="separator:a5de153e8f7dd3212cb998ea2ad29c4f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ab067b02367e78494a930fcccdd930c0c" name="ab067b02367e78494a930fcccdd930c0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab067b02367e78494a930fcccdd930c0c">&#9670;&#160;</a></span>ARC_Input_CreateWithEngineData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Input_CreateWithEngineData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../de/ded/input_8h.html#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> **</td> <td class="paramname"><span class="paramname"><em>input</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></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>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d1/d06/input_8c_source.html#l00007">7</a> of file <a class="el" href="../../d1/d06/input_8c_source.html">input.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 7</span> {</div>
<div class="line"><span class="lineno"> 8</span> printf(<span class="stringliteral">&quot;No Input Backend Selected\n&quot;</span>);</div>
<div class="line"><span class="lineno"> 9</span>}</div>
</div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="../../dd/d56/engine_8c_source.html#l00017">ARC_EngineData_Create()</a>.</p>
</div>
</div>
<a id="a3f88d045f196b8460a62f4c32ee23f54" name="a3f88d045f196b8460a62f4c32ee23f54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3f88d045f196b8460a62f4c32ee23f54">&#9670;&#160;</a></span>ARC_Input_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Input_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../de/ded/input_8h.html#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *</td> <td class="paramname"><span class="paramname"><em>input</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d1/d06/input_8c_source.html#l00011">11</a> of file <a class="el" href="../../d1/d06/input_8c_source.html">input.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 11</span> {</div>
<div class="line"><span class="lineno"> 12</span> printf(<span class="stringliteral">&quot;No Input Backend Selected\n&quot;</span>);</div>
<div class="line"><span class="lineno"> 13</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a33b395c2b23fb459904fef05df97ae5d" name="a33b395c2b23fb459904fef05df97ae5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33b395c2b23fb459904fef05df97ae5d">&#9670;&#160;</a></span>ARC_Input_GetKeyboard()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d6/da0/keyboard_8h.html#acec0a71060ec7186a323710608bd93e7">ARC_Keyboard</a> * ARC_Input_GetKeyboard </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../de/ded/input_8h.html#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *</td> <td class="paramname"><span class="paramname"><em>input</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d1/d06/input_8c_source.html#l00020">20</a> of file <a class="el" href="../../d1/d06/input_8c_source.html">input.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 20</span> {</div>
<div class="line"><span class="lineno"> 21</span> printf(<span class="stringliteral">&quot;No Input Backend Selected\n&quot;</span>);</div>
<div class="line"><span class="lineno"> 22</span> <span class="keywordflow">return</span> NULL;</div>
<div class="line"><span class="lineno"> 23</span>}</div>
</div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="../../dd/d56/engine_8c_source.html#l00017">ARC_EngineData_Create()</a>.</p>
</div>
</div>
<a id="a5de153e8f7dd3212cb998ea2ad29c4f6" name="a5de153e8f7dd3212cb998ea2ad29c4f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5de153e8f7dd3212cb998ea2ad29c4f6">&#9670;&#160;</a></span>ARC_Input_GetMouse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../dc/ded/mouse_8h.html#a902312c6398b8df6994f040d103b507b">ARC_Mouse</a> * ARC_Input_GetMouse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../de/ded/input_8h.html#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *</td> <td class="paramname"><span class="paramname"><em>input</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d1/d06/input_8c_source.html#l00025">25</a> of file <a class="el" href="../../d1/d06/input_8c_source.html">input.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 25</span> {</div>
<div class="line"><span class="lineno"> 26</span> printf(<span class="stringliteral">&quot;No Input Backend Selected\n&quot;</span>);</div>
<div class="line"><span class="lineno"> 27</span> <span class="keywordflow">return</span> NULL;</div>
<div class="line"><span class="lineno"> 28</span>}</div>
</div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="../../dd/d56/engine_8c_source.html#l00017">ARC_EngineData_Create()</a>.</p>
</div>
</div>
<a id="afb3fa56528406720283b62b2b713e118" name="afb3fa56528406720283b62b2b713e118"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb3fa56528406720283b62b2b713e118">&#9670;&#160;</a></span>ARC_Input_Update()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d8/d77/bool_8h.html#aad51710c999c22d9440e5ce0ba8e2c45">ARC_Bool</a> ARC_Input_Update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../de/ded/input_8h.html#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *</td> <td class="paramname"><span class="paramname"><em>input</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d1/d06/input_8c_source.html#l00015">15</a> of file <a class="el" href="../../d1/d06/input_8c_source.html">input.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 15</span> {</div>
<div class="line"><span class="lineno"> 16</span> printf(<span class="stringliteral">&quot;No Input Backend Selected\n&quot;</span>);</div>
<div class="line"><span class="lineno"> 17</span> <span class="keywordflow">return</span> <a class="code hl_define" href="../../d8/d77/bool_8h.html#aacf339cb8c71b994249ae02c662006cb">ARC_True</a>;</div>
<div class="line"><span class="lineno"> 18</span>}</div>
<div class="ttc" id="abool_8h_html_aacf339cb8c71b994249ae02c662006cb"><div class="ttname"><a href="../../d8/d77/bool_8h.html#aacf339cb8c71b994249ae02c662006cb">ARC_True</a></div><div class="ttdeci">#define ARC_True</div><div class="ttdef"><b>Definition</b> <a href="../../d8/d77/bool_8h_source.html#l00011">bool.h:11</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="../../d8/d77/bool_8h_source.html#l00011">ARC_True</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../dd/d56/engine_8c_source.html#l00059">ARC_Engine_RunUncapped()</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>