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

243
doc/doxygen/html/d5/d5d/structARC__Mouse.html Normal file
View file

@ -0,0 +1,243 @@
<!-- 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: ARC_Mouse Struct 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">&#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',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&amp;dn=expat.txt MIT */
$(function(){initNavTree('d5/d5d/structARC__Mouse.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="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">ARC_Mouse Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../de/d26/packages_2input_2sdl_2mouse_8h_source.html">mouse.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a4d833aeda5162e447737260d53df3403" id="r_a4d833aeda5162e447737260d53df3403"><td class="memItemLeft" align="right" valign="top">SDL_Event *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4d833aeda5162e447737260d53df3403">event</a></td></tr>
<tr class="separator:a4d833aeda5162e447737260d53df3403"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31e63976b6269306d6fd179069fd68da" id="r_a31e63976b6269306d6fd179069fd68da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d2/d9d/structARC__Point.html">ARC_Point</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a31e63976b6269306d6fd179069fd68da">coords</a></td></tr>
<tr class="separator:a31e63976b6269306d6fd179069fd68da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78bbe86d5c0bb8b1a96f7aeabce544c1" id="r_a78bbe86d5c0bb8b1a96f7aeabce544c1"><td class="memItemLeft" align="right" valign="top">int32_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a78bbe86d5c0bb8b1a96f7aeabce544c1">scrollY</a></td></tr>
<tr class="separator:a78bbe86d5c0bb8b1a96f7aeabce544c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42b96c586671fae45884ab8a2ef49726" id="r_a42b96c586671fae45884ab8a2ef49726"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d4/d4c/include_2arc_2input_2mouse_8h.html#a52d94336e2c510bb6d634595ad41fa89">ARC_MouseState</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a42b96c586671fae45884ab8a2ef49726">buttons</a></td></tr>
<tr class="separator:a42b96c586671fae45884ab8a2ef49726"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a908cf40d4166521162e012456a73d76d" id="r_a908cf40d4166521162e012456a73d76d"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a908cf40d4166521162e012456a73d76d">buttonsReleased</a></td></tr>
<tr class="separator:a908cf40d4166521162e012456a73d76d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="../../de/d26/packages_2input_2sdl_2mouse_8h_source.html#l00008">8</a> of file <a class="el" href="../../de/d26/packages_2input_2sdl_2mouse_8h_source.html">mouse.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a42b96c586671fae45884ab8a2ef49726" name="a42b96c586671fae45884ab8a2ef49726"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42b96c586671fae45884ab8a2ef49726">&#9670;&#160;</a></span>buttons</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d4/d4c/include_2arc_2input_2mouse_8h.html#a52d94336e2c510bb6d634595ad41fa89">ARC_MouseState</a>* ARC_Mouse::buttons</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../de/d26/packages_2input_2sdl_2mouse_8h_source.html#l00013">13</a> of file <a class="el" href="../../de/d26/packages_2input_2sdl_2mouse_8h_source.html">mouse.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00031">ARC_Mouse_Destroy()</a>, <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00099">ARC_Mouse_GetState()</a>, <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00061">ARC_Mouse_Update()</a>, and <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00041">ARC_Mouse_UpdateButton()</a>.</p>
</div>
</div>
<a id="a908cf40d4166521162e012456a73d76d" name="a908cf40d4166521162e012456a73d76d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a908cf40d4166521162e012456a73d76d">&#9670;&#160;</a></span>buttonsReleased</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* ARC_Mouse::buttonsReleased</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../de/d26/packages_2input_2sdl_2mouse_8h_source.html#l00014">14</a> of file <a class="el" href="../../de/d26/packages_2input_2sdl_2mouse_8h_source.html">mouse.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00031">ARC_Mouse_Destroy()</a>, <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00061">ARC_Mouse_Update()</a>, and <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00041">ARC_Mouse_UpdateButton()</a>.</p>
</div>
</div>
<a id="a31e63976b6269306d6fd179069fd68da" name="a31e63976b6269306d6fd179069fd68da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31e63976b6269306d6fd179069fd68da">&#9670;&#160;</a></span>coords</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d2/d9d/structARC__Point.html">ARC_Point</a>* ARC_Mouse::coords</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../de/d26/packages_2input_2sdl_2mouse_8h_source.html#l00010">10</a> of file <a class="el" href="../../de/d26/packages_2input_2sdl_2mouse_8h_source.html">mouse.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00031">ARC_Mouse_Destroy()</a>, <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00095">ARC_Mouse_GetCoords()</a>, and <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00061">ARC_Mouse_Update()</a>.</p>
</div>
</div>
<a id="a4d833aeda5162e447737260d53df3403" name="a4d833aeda5162e447737260d53df3403"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d833aeda5162e447737260d53df3403">&#9670;&#160;</a></span>event</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SDL_Event* ARC_Mouse::event</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../de/d26/packages_2input_2sdl_2mouse_8h_source.html#l00009">9</a> of file <a class="el" href="../../de/d26/packages_2input_2sdl_2mouse_8h_source.html">mouse.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00012">ARC_Mouse_CreateWithInput()</a>, and <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00061">ARC_Mouse_Update()</a>.</p>
</div>
</div>
<a id="a78bbe86d5c0bb8b1a96f7aeabce544c1" name="a78bbe86d5c0bb8b1a96f7aeabce544c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78bbe86d5c0bb8b1a96f7aeabce544c1">&#9670;&#160;</a></span>scrollY</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t* ARC_Mouse::scrollY</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../de/d26/packages_2input_2sdl_2mouse_8h_source.html#l00011">11</a> of file <a class="el" href="../../de/d26/packages_2input_2sdl_2mouse_8h_source.html">mouse.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00031">ARC_Mouse_Destroy()</a>, <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00103">ARC_Mouse_GetScrollY()</a>, and <a class="el" href="../../d1/de1/packages_2input_2sdl_2mouse_8c_source.html#l00061">ARC_Mouse_Update()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/home/herbglitch/programs/archeus/arc/packages/input/sdl/<a class="el" href="../../de/d26/packages_2input_2sdl_2mouse_8h_source.html">mouse.h</a></li>
</ul>
</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="../../d5/d5d/structARC__Mouse.html">ARC_Mouse</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>

8
doc/doxygen/html/d5/d5d/structARC__Mouse.js Normal file
View file

@ -0,0 +1,8 @@
var structARC__Mouse =
[
[ "buttons", "d5/d5d/structARC__Mouse.html#a42b96c586671fae45884ab8a2ef49726", null ],
[ "buttonsReleased", "d5/d5d/structARC__Mouse.html#a908cf40d4166521162e012456a73d76d", null ],
[ "coords", "d5/d5d/structARC__Mouse.html#a31e63976b6269306d6fd179069fd68da", null ],
[ "event", "d5/d5d/structARC__Mouse.html#a4d833aeda5162e447737260d53df3403", null ],
[ "scrollY", "d5/d5d/structARC__Mouse.html#a78bbe86d5c0bb8b1a96f7aeabce544c1", null ]
];