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

135
doc/doxygen/html/de/dbd/keyboard_8c_source.html Normal file
View file

@ -0,0 +1,135 @@
<!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/keyboard.c Source File</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="headertitle"><div class="title">keyboard.c</div></div>
</div><!--header-->
<div class="contents">
<a href="../../de/dbd/keyboard_8c.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifdef ARC_NONE_INPUT</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &quot;<a class="code" href="../../d6/da0/keyboard_8h.html">arc/input/keyboard.h</a>&quot;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;stdio.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d6/da0/keyboard_8h.html#a6cea48ed04bc3e8a3f72bc48e1994e68">ARC_Keyboard_CreateWithInput</a>(<a class="code hl_typedef" href="../../d6/da0/keyboard_8h.html#acec0a71060ec7186a323710608bd93e7">ARC_Keyboard</a> **keyboard, <a class="code hl_typedef" href="../../de/ded/input_8h.html#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a> *input){</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> printf(<span class="stringliteral">&quot;No Input Backend Selected\n&quot;</span>);</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span>}</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d6/da0/keyboard_8h.html#aaeaa42ad6e69566dfee40058003a053b">ARC_Keyboard_Destroy</a>(<a class="code hl_typedef" href="../../d6/da0/keyboard_8h.html#acec0a71060ec7186a323710608bd93e7">ARC_Keyboard</a> *keyboard){</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> printf(<span class="stringliteral">&quot;No Input Backend Selected\n&quot;</span>);</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span>}</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d6/da0/keyboard_8h.html#a46406fb1b5a846ff9c984ea3ad8dba14">ARC_Keyboard_Update</a>(<a class="code hl_typedef" href="../../d6/da0/keyboard_8h.html#acec0a71060ec7186a323710608bd93e7">ARC_Keyboard</a> *keyboard){</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> printf(<span class="stringliteral">&quot;No Input Backend Selected\n&quot;</span>);</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>}</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><a class="code hl_enumeration" href="../../d6/da0/keyboard_8h.html#a4fa42600e63b733ac23ec8ddfe49573f">ARC_KeyboardState</a> <a class="code hl_function" href="../../d6/da0/keyboard_8h.html#aefc45f58e68047bae8a7b4556c461f55">ARC_Keyboard_GetState</a>(<a class="code hl_typedef" href="../../d6/da0/keyboard_8h.html#acec0a71060ec7186a323710608bd93e7">ARC_Keyboard</a> *keyboard, <span class="keyword">enum</span> <a class="code hl_enumeration" href="../../d6/da0/keyboard_8h.html#a423a1a3409074e8d4fde41990ceeb342">ARC_KeyboardKey</a> key){</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> printf(<span class="stringliteral">&quot;No Input Backend Selected\n&quot;</span>);</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keywordflow">return</span> <a class="code hl_enumvalue" href="../../d6/da0/keyboard_8h.html#a4fa42600e63b733ac23ec8ddfe49573fae65992df97275326fd4849a9e0ed9eac">ARC_KEY_NONE</a>;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>}</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#endif </span><span class="comment">// !ARC_NONE_INPUT</span></div>
<div class="ttc" id="ainput_8h_html_ab10a17a34031b17d7ed09ca515a91b45"><div class="ttname"><a href="../../de/ded/input_8h.html#ab10a17a34031b17d7ed09ca515a91b45">ARC_Input</a></div><div class="ttdeci">struct ARC_Input ARC_Input</div><div class="ttdoc">predefien ARC_Input so as not to get circular reference</div><div class="ttdef"><b>Definition</b> <a href="../../de/ded/input_8h_source.html#l00017">input.h:17</a></div></div>
<div class="ttc" id="akeyboard_8h_html"><div class="ttname"><a href="../../d6/da0/keyboard_8h.html">keyboard.h</a></div></div>
<div class="ttc" id="akeyboard_8h_html_a423a1a3409074e8d4fde41990ceeb342"><div class="ttname"><a href="../../d6/da0/keyboard_8h.html#a423a1a3409074e8d4fde41990ceeb342">ARC_KeyboardKey</a></div><div class="ttdeci">ARC_KeyboardKey</div><div class="ttdef"><b>Definition</b> <a href="../../d6/da0/keyboard_8h_source.html#l00032">keyboard.h:32</a></div></div>
<div class="ttc" id="akeyboard_8h_html_a46406fb1b5a846ff9c984ea3ad8dba14"><div class="ttname"><a href="../../d6/da0/keyboard_8h.html#a46406fb1b5a846ff9c984ea3ad8dba14">ARC_Keyboard_Update</a></div><div class="ttdeci">void ARC_Keyboard_Update(ARC_Keyboard *keyboard)</div></div>
<div class="ttc" id="akeyboard_8h_html_a4fa42600e63b733ac23ec8ddfe49573f"><div class="ttname"><a href="../../d6/da0/keyboard_8h.html#a4fa42600e63b733ac23ec8ddfe49573f">ARC_KeyboardState</a></div><div class="ttdeci">ARC_KeyboardState</div><div class="ttdef"><b>Definition</b> <a href="../../d6/da0/keyboard_8h_source.html#l00019">keyboard.h:19</a></div></div>
<div class="ttc" id="akeyboard_8h_html_a4fa42600e63b733ac23ec8ddfe49573fae65992df97275326fd4849a9e0ed9eac"><div class="ttname"><a href="../../d6/da0/keyboard_8h.html#a4fa42600e63b733ac23ec8ddfe49573fae65992df97275326fd4849a9e0ed9eac">ARC_KEY_NONE</a></div><div class="ttdeci">@ ARC_KEY_NONE</div><div class="ttdef"><b>Definition</b> <a href="../../d6/da0/keyboard_8h_source.html#l00020">keyboard.h:20</a></div></div>
<div class="ttc" id="akeyboard_8h_html_a6cea48ed04bc3e8a3f72bc48e1994e68"><div class="ttname"><a href="../../d6/da0/keyboard_8h.html#a6cea48ed04bc3e8a3f72bc48e1994e68">ARC_Keyboard_CreateWithInput</a></div><div class="ttdeci">void ARC_Keyboard_CreateWithInput(ARC_Keyboard **keyboard, ARC_Input *input)</div></div>
<div class="ttc" id="akeyboard_8h_html_aaeaa42ad6e69566dfee40058003a053b"><div class="ttname"><a href="../../d6/da0/keyboard_8h.html#aaeaa42ad6e69566dfee40058003a053b">ARC_Keyboard_Destroy</a></div><div class="ttdeci">void ARC_Keyboard_Destroy(ARC_Keyboard *keyboard)</div></div>
<div class="ttc" id="akeyboard_8h_html_acec0a71060ec7186a323710608bd93e7"><div class="ttname"><a href="../../d6/da0/keyboard_8h.html#acec0a71060ec7186a323710608bd93e7">ARC_Keyboard</a></div><div class="ttdeci">struct ARC_Keyboard ARC_Keyboard</div><div class="ttdef"><b>Definition</b> <a href="../../d6/da0/keyboard_8h_source.html#l00015">keyboard.h:15</a></div></div>
<div class="ttc" id="akeyboard_8h_html_aefc45f58e68047bae8a7b4556c461f55"><div class="ttname"><a href="../../d6/da0/keyboard_8h.html#aefc45f58e68047bae8a7b4556c461f55">ARC_Keyboard_GetState</a></div><div class="ttdeci">ARC_KeyboardState ARC_Keyboard_GetState(ARC_Keyboard *keyboard, enum ARC_KeyboardKey key)</div></div>
</div><!-- fragment --></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>