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/d1/d03/vector2_8h.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: /home/herbglitch/programs/archeus/arc/include/arc/math/vector2.h 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>
<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('d1/d03/vector2_8h.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="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">vector2.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="../../d1/d03/vector2_8h_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="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../db/d86/structARC__Vector2.html">ARC_Vector2</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/ddb/structARC__DVector2.html">ARC_DVector2</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a72bc5bcc056b357b1f0bd08e36c72c59" id="r_a72bc5bcc056b357b1f0bd08e36c72c59"><td class="memItemLeft" align="right" valign="top">typedef struct ARC_Vector2&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a72bc5bcc056b357b1f0bd08e36c72c59">ARC_Vector2</a></td></tr>
<tr class="separator:a72bc5bcc056b357b1f0bd08e36c72c59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a527e014d732ffba410bead5aab9eea" id="r_a3a527e014d732ffba410bead5aab9eea"><td class="memItemLeft" align="right" valign="top">typedef struct ARC_DVector2&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3a527e014d732ffba410bead5aab9eea">ARC_DVector2</a></td></tr>
<tr class="separator:a3a527e014d732ffba410bead5aab9eea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:ad7827f08a4898d2b8358a407d52dfe9c" id="r_ad7827f08a4898d2b8358a407d52dfe9c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad7827f08a4898d2b8358a407d52dfe9c">ARC_Vector2_Normalize</a> (<a class="el" href="../../db/d86/structARC__Vector2.html">ARC_Vector2</a> *vector)</td></tr>
<tr class="memdesc:ad7827f08a4898d2b8358a407d52dfe9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">normalizes a given <a class="el" href="../../db/d86/structARC__Vector2.html">ARC_Vector2</a> <br /></td></tr>
<tr class="separator:ad7827f08a4898d2b8358a407d52dfe9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37b30084c8ebb416c5bbf621a7362e43" id="r_a37b30084c8ebb416c5bbf621a7362e43"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a37b30084c8ebb416c5bbf621a7362e43">ARC_Vector2_RotateDegree</a> (<a class="el" href="../../db/d86/structARC__Vector2.html">ARC_Vector2</a> *vector, float angle)</td></tr>
<tr class="memdesc:a37b30084c8ebb416c5bbf621a7362e43"><td class="mdescLeft">&#160;</td><td class="mdescRight">rotates a given <a class="el" href="../../db/d86/structARC__Vector2.html">ARC_Vector2</a> by a given angle in degrees <br /></td></tr>
<tr class="separator:a37b30084c8ebb416c5bbf621a7362e43"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a3a527e014d732ffba410bead5aab9eea" name="a3a527e014d732ffba410bead5aab9eea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a527e014d732ffba410bead5aab9eea">&#9670;&#160;</a></span>ARC_DVector2</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct ARC_DVector2 ARC_DVector2</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a72bc5bcc056b357b1f0bd08e36c72c59" name="a72bc5bcc056b357b1f0bd08e36c72c59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72bc5bcc056b357b1f0bd08e36c72c59">&#9670;&#160;</a></span>ARC_Vector2</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct ARC_Vector2 ARC_Vector2</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ad7827f08a4898d2b8358a407d52dfe9c" name="ad7827f08a4898d2b8358a407d52dfe9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7827f08a4898d2b8358a407d52dfe9c">&#9670;&#160;</a></span>ARC_Vector2_Normalize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Vector2_Normalize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../db/d86/structARC__Vector2.html">ARC_Vector2</a> *</td> <td class="paramname"><span class="paramname"><em>vector</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>normalizes a given <a class="el" href="../../db/d86/structARC__Vector2.html">ARC_Vector2</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vector</td><td>the ARC_Vecotr2 to normallize </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a37b30084c8ebb416c5bbf621a7362e43" name="a37b30084c8ebb416c5bbf621a7362e43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37b30084c8ebb416c5bbf621a7362e43">&#9670;&#160;</a></span>ARC_Vector2_RotateDegree()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Vector2_RotateDegree </td>
<td>(</td>
<td class="paramtype"><a class="el" href="../../db/d86/structARC__Vector2.html">ARC_Vector2</a> *</td> <td class="paramname"><span class="paramname"><em>vector</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>angle</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>rotates a given <a class="el" href="../../db/d86/structARC__Vector2.html">ARC_Vector2</a> by a given angle in degrees </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vector</td><td>the <a class="el" href="../../db/d86/structARC__Vector2.html">ARC_Vector2</a> to rotate </td></tr>
<tr><td class="paramname">angle</td><td>the angle in degrees to rotate by </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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="../../d1/d03/vector2_8h.html">vector2.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>