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

182
doc/doxygen/html/d3/df1/window_8h_source.html Normal file
View file

@ -0,0 +1,182 @@
<!-- 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/graphics/window.h 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>
<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('d3/df1/window_8h_source.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="headertitle"><div class="title">window.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../d3/df1/window_8h.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">#ifndef ARC_GRAPHICS_WINDOW_H_</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_GRAPHICS_WINDOW_H_</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">/**</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * @note ARC_WindowType is determined by which window backend you are using</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">*/</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="../../d3/df1/window_8h.html#a306a4335069399f41073b7cc14ab7c38"> 13</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>ARC_WindowType <a class="code hl_typedef" href="../../d3/df1/window_8h.html#a306a4335069399f41073b7cc14ab7c38">ARC_Window</a>;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"></span> </div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">/**</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * @note certain parts of ARC_WindowInfo may not be used by your selected backend</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="foldopen" id="foldopen00018" data-start="{" data-end="};">
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="../../d1/d1a/structARC__WindowInfo.html"> 18</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="../../d1/d1a/structARC__WindowInfo.html">ARC_WindowInfo</a> {</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="../../d1/d1a/structARC__WindowInfo.html#adb7dc9a62fd9bc34bb9ee2e1a8fbb812"> 19</a></span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="../../d1/d1a/structARC__WindowInfo.html#adb7dc9a62fd9bc34bb9ee2e1a8fbb812">title</a>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="../../d1/d1a/structARC__WindowInfo.html#af5b0756e36cd244691c3a883fc7ff820"> 20</a></span> int32_t <a class="code hl_variable" href="../../d1/d1a/structARC__WindowInfo.html#af5b0756e36cd244691c3a883fc7ff820">w</a>;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="../../d1/d1a/structARC__WindowInfo.html#a2e8d943e367f5c64db65e21ef92fcfd8"> 21</a></span> int32_t <a class="code hl_variable" href="../../d1/d1a/structARC__WindowInfo.html#a2e8d943e367f5c64db65e21ef92fcfd8">h</a>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="../../d3/df1/window_8h.html#ad9c970ff3c2c05f887c89e5f112e997f"> 22</a></span>} <a class="code hl_typedef" href="../../d3/df1/window_8h.html#ad9c970ff3c2c05f887c89e5f112e997f">ARC_WindowInfo</a>;</div>
</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"></span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">/**</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> * @brief creates ARC_Window type</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> *</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment"> * @note the parameter data is determined by which graphics library you are using</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment"> * please refer to the graphics library section to see what needs to be passed</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"> *</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"> * @param window ARC_Window to initialize</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> * @param info Info on how to create ARC_Window</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> */</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="../../d3/df1/window_8h.html#ac2943b39d2140ae27cd98d362053f27c"> 33</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d3/df1/window_8h.html#ac2943b39d2140ae27cd98d362053f27c">ARC_Window_Create</a>(<a class="code hl_typedef" href="../../d3/df1/window_8h.html#a306a4335069399f41073b7cc14ab7c38">ARC_Window</a> **window, <a class="code hl_struct" href="../../d1/d1a/structARC__WindowInfo.html">ARC_WindowInfo</a> *info);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"></span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment">/**</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment"> * @brief destroys ARC_Window type</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment"> */</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="../../d3/df1/window_8h.html#afb68d49b50117b8cec312c7a5999c1a6"> 38</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d3/df1/window_8h.html#afb68d49b50117b8cec312c7a5999c1a6">ARC_Window_Destroy</a>(<a class="code hl_typedef" href="../../d3/df1/window_8h.html#a306a4335069399f41073b7cc14ab7c38">ARC_Window</a> *window);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>}</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="preprocessor">#endif </span><span class="comment">// !ARC_GRAPHICS_WINDOW_H_</span></div>
<div class="ttc" id="astructARC__WindowInfo_html"><div class="ttname"><a href="../../d1/d1a/structARC__WindowInfo.html">ARC_WindowInfo</a></div><div class="ttdef"><b>Definition</b> <a href="#l00018">window.h:18</a></div></div>
<div class="ttc" id="astructARC__WindowInfo_html_a2e8d943e367f5c64db65e21ef92fcfd8"><div class="ttname"><a href="../../d1/d1a/structARC__WindowInfo.html#a2e8d943e367f5c64db65e21ef92fcfd8">ARC_WindowInfo::h</a></div><div class="ttdeci">int32_t h</div><div class="ttdef"><b>Definition</b> <a href="#l00021">window.h:21</a></div></div>
<div class="ttc" id="astructARC__WindowInfo_html_adb7dc9a62fd9bc34bb9ee2e1a8fbb812"><div class="ttname"><a href="../../d1/d1a/structARC__WindowInfo.html#adb7dc9a62fd9bc34bb9ee2e1a8fbb812">ARC_WindowInfo::title</a></div><div class="ttdeci">char * title</div><div class="ttdef"><b>Definition</b> <a href="#l00019">window.h:19</a></div></div>
<div class="ttc" id="astructARC__WindowInfo_html_af5b0756e36cd244691c3a883fc7ff820"><div class="ttname"><a href="../../d1/d1a/structARC__WindowInfo.html#af5b0756e36cd244691c3a883fc7ff820">ARC_WindowInfo::w</a></div><div class="ttdeci">int32_t w</div><div class="ttdef"><b>Definition</b> <a href="#l00020">window.h:20</a></div></div>
<div class="ttc" id="awindow_8h_html_a306a4335069399f41073b7cc14ab7c38"><div class="ttname"><a href="../../d3/df1/window_8h.html#a306a4335069399f41073b7cc14ab7c38">ARC_Window</a></div><div class="ttdeci">struct ARC_WindowType ARC_Window</div><div class="ttdef"><b>Definition</b> <a href="#l00013">window.h:13</a></div></div>
<div class="ttc" id="awindow_8h_html_ac2943b39d2140ae27cd98d362053f27c"><div class="ttname"><a href="../../d3/df1/window_8h.html#ac2943b39d2140ae27cd98d362053f27c">ARC_Window_Create</a></div><div class="ttdeci">void ARC_Window_Create(ARC_Window **window, ARC_WindowInfo *info)</div><div class="ttdoc">creates ARC_Window type</div></div>
<div class="ttc" id="awindow_8h_html_ad9c970ff3c2c05f887c89e5f112e997f"><div class="ttname"><a href="../../d3/df1/window_8h.html#ad9c970ff3c2c05f887c89e5f112e997f">ARC_WindowInfo</a></div><div class="ttdeci">struct ARC_WindowInfo ARC_WindowInfo</div></div>
<div class="ttc" id="awindow_8h_html_afb68d49b50117b8cec312c7a5999c1a6"><div class="ttname"><a href="../../d3/df1/window_8h.html#afb68d49b50117b8cec312c7a5999c1a6">ARC_Window_Destroy</a></div><div class="ttdeci">void ARC_Window_Destroy(ARC_Window *window)</div><div class="ttdoc">destroys ARC_Window type</div></div>
</div><!-- fragment --></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_169ca87d8ac185e5b51c45f4a68386c0.html">graphics</a></li><li class="navelem"><a class="el" href="../../d3/df1/window_8h.html">window.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>