started woking on figuring out doxygen documentation and added readme

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

View file

@ -0,0 +1,138 @@
<!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/math/obround.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_ae9a93452e2a84339148a16bcf2eb561.html">math</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">obround.c</div></div>
</div><!--header-->
<div class="contents">
<a href="../../de/d61/math_2obround_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">#include &quot;<a class="code" href="../../d3/d66/math_2obround_8h.html">arc/math/obround.h</a>&quot;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="foldopen" id="foldopen00003" data-start="{" data-end="}">
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"><a class="line" href="../../d3/d66/math_2obround_8h.html#acf56c47f95620e4645316a46e7046606"> 3</a></span><a class="code hl_struct" href="../../dc/d00/structARC__FObround.html">ARC_FObround</a> <a class="code hl_function" href="../../de/d61/math_2obround_8c.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="l00004" name="l00004"></a><span class="lineno"> 4</span> <span class="keywordflow">return</span> (<a class="code hl_struct" href="../../dc/d00/structARC__FObround.html">ARC_FObround</a>){</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> .x = (float)obround-&gt;<a class="code hl_variable" href="../../d4/d06/structARC__Obround.html#aa76f24b7b9ed595509ce86e814ce2e5c">x</a>,</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> .y = (<span class="keywordtype">float</span>)obround-&gt;<a class="code hl_variable" href="../../d4/d06/structARC__Obround.html#aaf9160914e7d76682f8507afed6679de">y</a>,</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> .r = (float)obround-&gt;<a class="code hl_variable" href="../../d4/d06/structARC__Obround.html#a3d884224975dfd2fc8fbd5a4cdaedea6">r</a>,</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> .h = (<span class="keywordtype">float</span>)obround-&gt;<a class="code hl_variable" href="../../d4/d06/structARC__Obround.html#aed164dae5e8ad2ba41f06b97375aa368">h</a></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>}</div>
</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="foldopen" id="foldopen00012" data-start="{" data-end="}">
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="../../d3/d66/math_2obround_8h.html#acc0ba97a943dba9998a65156da2a8e7f"> 12</a></span><a class="code hl_struct" href="../../d4/d06/structARC__Obround.html">ARC_Obround</a> <a class="code hl_function" href="../../de/d61/math_2obround_8c.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="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keywordflow">return</span> (<a class="code hl_struct" href="../../d4/d06/structARC__Obround.html">ARC_Obround</a>){</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> .x = (int32_t)obround-&gt;<a class="code hl_variable" href="../../dc/d00/structARC__FObround.html#a29c335c6916947305759b4bfd2668b54">x</a>,</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> .y = (int32_t)obround-&gt;<a class="code hl_variable" href="../../dc/d00/structARC__FObround.html#a11afe731f51dbba3e709fc5a117eb650">y</a>,</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> .r = (int32_t)obround-&gt;<a class="code hl_variable" href="../../dc/d00/structARC__FObround.html#a6472337d23d18a48dddf43e50824ecbe">r</a>,</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> .h = (int32_t)obround-&gt;<a class="code hl_variable" href="../../dc/d00/structARC__FObround.html#a224ead9c93ca729a1eb6e7e04d0169d6">h</a></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> };</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>}</div>
</div>
<div class="ttc" id="amath_2obround_8c_html_acc0ba97a943dba9998a65156da2a8e7f"><div class="ttname"><a href="../../de/d61/math_2obround_8c.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 class="ttdef"><b>Definition</b> <a href="#l00012">obround.c:12</a></div></div>
<div class="ttc" id="amath_2obround_8c_html_acf56c47f95620e4645316a46e7046606"><div class="ttname"><a href="../../de/d61/math_2obround_8c.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 class="ttdef"><b>Definition</b> <a href="#l00003">obround.c:3</a></div></div>
<div class="ttc" id="amath_2obround_8h_html"><div class="ttname"><a href="../../d3/d66/math_2obround_8h.html">obround.h</a></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="../../d3/d66/math_2obround_8h_source.html#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="../../d3/d66/math_2obround_8h_source.html#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="../../d3/d66/math_2obround_8h_source.html#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="../../d3/d66/math_2obround_8h_source.html#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="../../d3/d66/math_2obround_8h_source.html#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="../../d3/d66/math_2obround_8h_source.html#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="../../d3/d66/math_2obround_8h_source.html#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="../../d3/d66/math_2obround_8h_source.html#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="../../d3/d66/math_2obround_8h_source.html#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="../../d3/d66/math_2obround_8h_source.html#l00014">obround.h:14</a></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>