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

193
doc/doxygen/html/d3/d66/math_2obround_8h_source.html Normal file
View file

@ -0,0 +1,193 @@
<!-- 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/math/obround.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/d66/math_2obround_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">obround.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../d3/d66/math_2obround_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_MATH_OBROUND_H_</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_MATH_OBROUND_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">#include &lt;stdint.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="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="foldopen" id="foldopen00010" data-start="{" data-end="};">
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="../../d4/d06/structARC__Obround.html"> 10</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="../../d4/d06/structARC__Obround.html">ARC_Obround</a> {</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="../../d4/d06/structARC__Obround.html#aa76f24b7b9ed595509ce86e814ce2e5c"> 11</a></span> int32_t <a class="code hl_variable" href="../../d4/d06/structARC__Obround.html#aa76f24b7b9ed595509ce86e814ce2e5c">x</a>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="../../d4/d06/structARC__Obround.html#aaf9160914e7d76682f8507afed6679de"> 12</a></span> int32_t <a class="code hl_variable" href="../../d4/d06/structARC__Obround.html#aaf9160914e7d76682f8507afed6679de">y</a>;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="../../d4/d06/structARC__Obround.html#a3d884224975dfd2fc8fbd5a4cdaedea6"> 13</a></span> int32_t <a class="code hl_variable" href="../../d4/d06/structARC__Obround.html#a3d884224975dfd2fc8fbd5a4cdaedea6">r</a>;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="../../d4/d06/structARC__Obround.html#aed164dae5e8ad2ba41f06b97375aa368"> 14</a></span> int32_t <a class="code hl_variable" href="../../d4/d06/structARC__Obround.html#aed164dae5e8ad2ba41f06b97375aa368">h</a>;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="../../d3/d66/math_2obround_8h.html#a08e2c243d41eb6776855db6a92fc6d4e"> 15</a></span>} <a class="code hl_typedef" href="../../d3/d66/math_2obround_8h.html#a08e2c243d41eb6776855db6a92fc6d4e">ARC_Obround</a>;</div>
</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="foldopen" id="foldopen00017" data-start="{" data-end="};">
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="../../dc/d00/structARC__FObround.html"> 17</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="../../dc/d00/structARC__FObround.html">ARC_FObround</a> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="../../dc/d00/structARC__FObround.html#a29c335c6916947305759b4bfd2668b54"> 18</a></span> <span class="keywordtype">float</span> <a class="code hl_variable" href="../../dc/d00/structARC__FObround.html#a29c335c6916947305759b4bfd2668b54">x</a>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="../../dc/d00/structARC__FObround.html#a11afe731f51dbba3e709fc5a117eb650"> 19</a></span> <span class="keywordtype">float</span> <a class="code hl_variable" href="../../dc/d00/structARC__FObround.html#a11afe731f51dbba3e709fc5a117eb650">y</a>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="../../dc/d00/structARC__FObround.html#a6472337d23d18a48dddf43e50824ecbe"> 20</a></span> <span class="keywordtype">float</span> <a class="code hl_variable" href="../../dc/d00/structARC__FObround.html#a6472337d23d18a48dddf43e50824ecbe">r</a>;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="../../dc/d00/structARC__FObround.html#a224ead9c93ca729a1eb6e7e04d0169d6"> 21</a></span> <span class="keywordtype">float</span> <a class="code hl_variable" href="../../dc/d00/structARC__FObround.html#a224ead9c93ca729a1eb6e7e04d0169d6">h</a>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="../../d3/d66/math_2obround_8h.html#a46896e6717b8e3a9924b9c96d2ea6629"> 22</a></span>} <a class="code hl_typedef" href="../../d3/d66/math_2obround_8h.html#a46896e6717b8e3a9924b9c96d2ea6629">ARC_FObround</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 casts Obround to FObround</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"> * @param obround ARC_Obround to be casted</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment"> * </span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"> * @return ARC_FObround</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"> */</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="../../d3/d66/math_2obround_8h.html#acf56c47f95620e4645316a46e7046606"> 31</a></span><a class="code hl_struct" href="../../dc/d00/structARC__FObround.html">ARC_FObround</a> <a class="code hl_function" href="../../d3/d66/math_2obround_8h.html#acf56c47f95620e4645316a46e7046606">ARC_Obround_CastToFObround</a>(<a class="code hl_struct" href="../../d4/d06/structARC__Obround.html">ARC_Obround</a> *obround);</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"> 33</span><span class="comment">/**</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> * @brief casts FObround to Obround</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"> * @param obround ARC_FObround to be casted</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"> 38</span><span class="comment"> * @return ARC_Obround</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> */</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="../../d3/d66/math_2obround_8h.html#acc0ba97a943dba9998a65156da2a8e7f"> 40</a></span><a class="code hl_struct" href="../../d4/d06/structARC__Obround.html">ARC_Obround</a> <a class="code hl_function" href="../../d3/d66/math_2obround_8h.html#acc0ba97a943dba9998a65156da2a8e7f">ARC_FObround_CastToObround</a>(<a class="code hl_struct" href="../../dc/d00/structARC__FObround.html">ARC_FObround</a> *obround);</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">#ifdef __cplusplus</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></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="preprocessor">#endif </span><span class="comment">// ARC_MATH_OBROUND_H_</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="ttc" id="amath_2obround_8h_html_a08e2c243d41eb6776855db6a92fc6d4e"><div class="ttname"><a href="../../d3/d66/math_2obround_8h.html#a08e2c243d41eb6776855db6a92fc6d4e">ARC_Obround</a></div><div class="ttdeci">struct ARC_Obround ARC_Obround</div></div>
<div class="ttc" id="amath_2obround_8h_html_a46896e6717b8e3a9924b9c96d2ea6629"><div class="ttname"><a href="../../d3/d66/math_2obround_8h.html#a46896e6717b8e3a9924b9c96d2ea6629">ARC_FObround</a></div><div class="ttdeci">struct ARC_FObround ARC_FObround</div></div>
<div class="ttc" id="amath_2obround_8h_html_acc0ba97a943dba9998a65156da2a8e7f"><div class="ttname"><a href="../../d3/d66/math_2obround_8h.html#acc0ba97a943dba9998a65156da2a8e7f">ARC_FObround_CastToObround</a></div><div class="ttdeci">ARC_Obround ARC_FObround_CastToObround(ARC_FObround *obround)</div><div class="ttdoc">casts FObround to Obround</div></div>
<div class="ttc" id="amath_2obround_8h_html_acf56c47f95620e4645316a46e7046606"><div class="ttname"><a href="../../d3/d66/math_2obround_8h.html#acf56c47f95620e4645316a46e7046606">ARC_Obround_CastToFObround</a></div><div class="ttdeci">ARC_FObround ARC_Obround_CastToFObround(ARC_Obround *obround)</div><div class="ttdoc">casts Obround to FObround</div></div>
<div class="ttc" id="astructARC__FObround_html"><div class="ttname"><a href="../../dc/d00/structARC__FObround.html">ARC_FObround</a></div><div class="ttdef"><b>Definition</b> <a href="#l00017">obround.h:17</a></div></div>
<div class="ttc" id="astructARC__FObround_html_a11afe731f51dbba3e709fc5a117eb650"><div class="ttname"><a href="../../dc/d00/structARC__FObround.html#a11afe731f51dbba3e709fc5a117eb650">ARC_FObround::y</a></div><div class="ttdeci">float y</div><div class="ttdef"><b>Definition</b> <a href="#l00019">obround.h:19</a></div></div>
<div class="ttc" id="astructARC__FObround_html_a224ead9c93ca729a1eb6e7e04d0169d6"><div class="ttname"><a href="../../dc/d00/structARC__FObround.html#a224ead9c93ca729a1eb6e7e04d0169d6">ARC_FObround::h</a></div><div class="ttdeci">float h</div><div class="ttdef"><b>Definition</b> <a href="#l00021">obround.h:21</a></div></div>
<div class="ttc" id="astructARC__FObround_html_a29c335c6916947305759b4bfd2668b54"><div class="ttname"><a href="../../dc/d00/structARC__FObround.html#a29c335c6916947305759b4bfd2668b54">ARC_FObround::x</a></div><div class="ttdeci">float x</div><div class="ttdef"><b>Definition</b> <a href="#l00018">obround.h:18</a></div></div>
<div class="ttc" id="astructARC__FObround_html_a6472337d23d18a48dddf43e50824ecbe"><div class="ttname"><a href="../../dc/d00/structARC__FObround.html#a6472337d23d18a48dddf43e50824ecbe">ARC_FObround::r</a></div><div class="ttdeci">float r</div><div class="ttdef"><b>Definition</b> <a href="#l00020">obround.h:20</a></div></div>
<div class="ttc" id="astructARC__Obround_html"><div class="ttname"><a href="../../d4/d06/structARC__Obround.html">ARC_Obround</a></div><div class="ttdef"><b>Definition</b> <a href="#l00010">obround.h:10</a></div></div>
<div class="ttc" id="astructARC__Obround_html_a3d884224975dfd2fc8fbd5a4cdaedea6"><div class="ttname"><a href="../../d4/d06/structARC__Obround.html#a3d884224975dfd2fc8fbd5a4cdaedea6">ARC_Obround::r</a></div><div class="ttdeci">int32_t r</div><div class="ttdef"><b>Definition</b> <a href="#l00013">obround.h:13</a></div></div>
<div class="ttc" id="astructARC__Obround_html_aa76f24b7b9ed595509ce86e814ce2e5c"><div class="ttname"><a href="../../d4/d06/structARC__Obround.html#aa76f24b7b9ed595509ce86e814ce2e5c">ARC_Obround::x</a></div><div class="ttdeci">int32_t x</div><div class="ttdef"><b>Definition</b> <a href="#l00011">obround.h:11</a></div></div>
<div class="ttc" id="astructARC__Obround_html_aaf9160914e7d76682f8507afed6679de"><div class="ttname"><a href="../../d4/d06/structARC__Obround.html#aaf9160914e7d76682f8507afed6679de">ARC_Obround::y</a></div><div class="ttdeci">int32_t y</div><div class="ttdef"><b>Definition</b> <a href="#l00012">obround.h:12</a></div></div>
<div class="ttc" id="astructARC__Obround_html_aed164dae5e8ad2ba41f06b97375aa368"><div class="ttname"><a href="../../d4/d06/structARC__Obround.html#aed164dae5e8ad2ba41f06b97375aa368">ARC_Obround::h</a></div><div class="ttdeci">int32_t h</div><div class="ttdef"><b>Definition</b> <a href="#l00014">obround.h:14</a></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_8600ea1c4b892b5b70355aa785f2ac76.html">math</a></li><li class="navelem"><a class="el" href="../../d3/d66/math_2obround_8h.html">obround.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>