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

204
doc/doxygen/html/de/d61/math_2obround_8c.html Normal file
View file

@ -0,0 +1,204 @@
<!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 File 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>
<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="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">obround.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="../../d3/d66/math_2obround_8h_source.html">arc/math/obround.h</a>&quot;</code><br />
</div>
<p><a href="../../de/d61/math_2obround_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:acf56c47f95620e4645316a46e7046606" id="r_acf56c47f95620e4645316a46e7046606"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../dc/d00/structARC__FObround.html">ARC_FObround</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acf56c47f95620e4645316a46e7046606">ARC_Obround_CastToFObround</a> (<a class="el" href="../../d4/d06/structARC__Obround.html">ARC_Obround</a> *obround)</td></tr>
<tr class="memdesc:acf56c47f95620e4645316a46e7046606"><td class="mdescLeft">&#160;</td><td class="mdescRight">casts Obround to FObround <br /></td></tr>
<tr class="separator:acf56c47f95620e4645316a46e7046606"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc0ba97a943dba9998a65156da2a8e7f" id="r_acc0ba97a943dba9998a65156da2a8e7f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d4/d06/structARC__Obround.html">ARC_Obround</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acc0ba97a943dba9998a65156da2a8e7f">ARC_FObround_CastToObround</a> (<a class="el" href="../../dc/d00/structARC__FObround.html">ARC_FObround</a> *obround)</td></tr>
<tr class="memdesc:acc0ba97a943dba9998a65156da2a8e7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">casts FObround to Obround <br /></td></tr>
<tr class="separator:acc0ba97a943dba9998a65156da2a8e7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="acc0ba97a943dba9998a65156da2a8e7f" name="acc0ba97a943dba9998a65156da2a8e7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc0ba97a943dba9998a65156da2a8e7f">&#9670;&#160;</a></span>ARC_FObround_CastToObround()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d4/d06/structARC__Obround.html">ARC_Obround</a> ARC_FObround_CastToObround </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../dc/d00/structARC__FObround.html">ARC_FObround</a> *</td> <td class="paramname"><span class="paramname"><em>obround</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>casts FObround to Obround </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obround</td><td><a class="el" href="../../dc/d00/structARC__FObround.html">ARC_FObround</a> to be casted</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="../../d4/d06/structARC__Obround.html">ARC_Obround</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../de/d61/math_2obround_8c_source.html#l00012">12</a> of file <a class="el" href="../../de/d61/math_2obround_8c_source.html">obround.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 12</span> {</div>
<div class="line"><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"><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"><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"><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"><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"><span class="lineno"> 18</span> };</div>
<div class="line"><span class="lineno"> 19</span>}</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><!-- fragment -->
<p class="reference">References <a class="el" href="../../d3/d66/math_2obround_8h_source.html#l00021">ARC_FObround::h</a>, <a class="el" href="../../d3/d66/math_2obround_8h_source.html#l00020">ARC_FObround::r</a>, <a class="el" href="../../d3/d66/math_2obround_8h_source.html#l00018">ARC_FObround::x</a>, and <a class="el" href="../../d3/d66/math_2obround_8h_source.html#l00019">ARC_FObround::y</a>.</p>
</div>
</div>
<a id="acf56c47f95620e4645316a46e7046606" name="acf56c47f95620e4645316a46e7046606"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf56c47f95620e4645316a46e7046606">&#9670;&#160;</a></span>ARC_Obround_CastToFObround()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../dc/d00/structARC__FObround.html">ARC_FObround</a> ARC_Obround_CastToFObround </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../d4/d06/structARC__Obround.html">ARC_Obround</a> *</td> <td class="paramname"><span class="paramname"><em>obround</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>casts Obround to FObround </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obround</td><td><a class="el" href="../../d4/d06/structARC__Obround.html">ARC_Obround</a> to be casted</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="../../dc/d00/structARC__FObround.html">ARC_FObround</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../de/d61/math_2obround_8c_source.html#l00003">3</a> of file <a class="el" href="../../de/d61/math_2obround_8c_source.html">obround.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 3</span> {</div>
<div class="line"><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"><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"><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"><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"><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"><span class="lineno"> 9</span> };</div>
<div class="line"><span class="lineno"> 10</span>}</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__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 -->
<p class="reference">References <a class="el" href="../../d3/d66/math_2obround_8h_source.html#l00014">ARC_Obround::h</a>, <a class="el" href="../../d3/d66/math_2obround_8h_source.html#l00013">ARC_Obround::r</a>, <a class="el" href="../../d3/d66/math_2obround_8h_source.html#l00011">ARC_Obround::x</a>, and <a class="el" href="../../d3/d66/math_2obround_8h_source.html#l00012">ARC_Obround::y</a>.</p>
</div>
</div>
</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>