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,130 @@
<!-- 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/packages/graphics/opengl/text.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>
<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('d6/d94/packages_2graphics_2opengl_2text_8c.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">text.c File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="../../d6/d94/packages_2graphics_2opengl_2text_8c_source.html">Go to the source code of this file.</a></p>
</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_93501a11e921083efbd154e0cdff5f10.html">packages</a></li><li class="navelem"><a class="el" href="../../dir_af6e6c3357835c7f766dfcaf351d30ad.html">graphics</a></li><li class="navelem"><a class="el" href="../../dir_ad51ffe8b33deed52e38849f403bcdb5.html">opengl</a></li><li class="navelem"><a class="el" href="../../d6/d94/packages_2graphics_2opengl_2text_8c.html">text.c</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>

View file

@ -0,0 +1,165 @@
<!-- 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/packages/graphics/opengl/text.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>
<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('d6/d94/packages_2graphics_2opengl_2text_8c_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">text.c</div></div>
</div><!--header-->
<div class="contents">
<a href="../../d6/d94/packages_2graphics_2opengl_2text_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">#ifdef ARC_OPENGL_GRAPHICS</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &quot;<a class="code" href="../../d8/da9/include_2arc_2graphics_2text_8h.html">arc/graphics/text.h</a>&quot;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;stdio.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="keywordtype">void</span> <a class="code hl_function" href="../../d8/da9/include_2arc_2graphics_2text_8h.html#a317688d3c7ed9dc82fdef7dd136fd462">ARC_Text_Create</a>(<a class="code hl_struct" href="../../dc/d7a/structARC__Text.html">ARC_Text</a> **text, <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *path, int32_t size, <a class="code hl_struct" href="../../d2/d30/structARC__Color.html">ARC_Color</a> color){</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> printf(<span class="stringliteral">&quot;OpenGL Backend Selected\n&quot;</span>);</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span>}</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><span class="keywordtype">void</span> <a class="code hl_function" href="../../d8/da9/include_2arc_2graphics_2text_8h.html#a81e08f1c4210a1d33a6b5be4ff2bde8c">ARC_Text_Destroy</a>(<a class="code hl_struct" href="../../dc/d7a/structARC__Text.html">ARC_Text</a> *font){</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> printf(<span class="stringliteral">&quot;OpenGL Backend Selected\n&quot;</span>);</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span>}</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d8/da9/include_2arc_2graphics_2text_8h.html#a2d5bfd55a4035453bcf751514e04f362">ARC_Text_SetString</a>(<a class="code hl_struct" href="../../dc/d7a/structARC__Text.html">ARC_Text</a> *text, <a class="code hl_typedef" href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *renderer, <a class="code hl_struct" href="../../df/d06/structARC__String.html">ARC_String</a> *<span class="keywordtype">string</span>){</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> printf(<span class="stringliteral">&quot;OpenGL Backend Selected\n&quot;</span>);</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>}</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d8/da9/include_2arc_2graphics_2text_8h.html#a8fb85afa64d8e337f475db6eaa23bbcb">ARC_Text_Render</a>(<a class="code hl_struct" href="../../dc/d7a/structARC__Text.html">ARC_Text</a> *text, <a class="code hl_typedef" href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *renderer){</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> printf(<span class="stringliteral">&quot;OpenGL Backend Selected\n&quot;</span>);</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span>}</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d8/da9/include_2arc_2graphics_2text_8h.html#acaf60a21f71839044b1eaa775c443db7">ARC_Text_SetPos</a>(<a class="code hl_struct" href="../../dc/d7a/structARC__Text.html">ARC_Text</a> *text, <a class="code hl_struct" href="../../d2/d9d/structARC__Point.html">ARC_Point</a> pos){</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> printf(<span class="stringliteral">&quot;OpenGL Backend Selected\n&quot;</span>);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>}</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#endif </span><span class="comment">// !ARC_OPENGL_GRAPHICS</span></div>
<div class="ttc" id="ainclude_2arc_2graphics_2renderer_8h_html_a2b82366dc421b3e80aace49f3ae8639a"><div class="ttname"><a href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a></div><div class="ttdeci">struct ARC_RendererType ARC_Renderer</div><div class="ttdef"><b>Definition</b> <a href="../../d1/dc6/include_2arc_2graphics_2renderer_8h_source.html#l00016">renderer.h:16</a></div></div>
<div class="ttc" id="ainclude_2arc_2graphics_2text_8h_html"><div class="ttname"><a href="../../d8/da9/include_2arc_2graphics_2text_8h.html">text.h</a></div></div>
<div class="ttc" id="ainclude_2arc_2graphics_2text_8h_html_a2d5bfd55a4035453bcf751514e04f362"><div class="ttname"><a href="../../d8/da9/include_2arc_2graphics_2text_8h.html#a2d5bfd55a4035453bcf751514e04f362">ARC_Text_SetString</a></div><div class="ttdeci">void ARC_Text_SetString(ARC_Text *text, ARC_Renderer *renderer, ARC_String *string)</div><div class="ttdef"><b>Definition</b> <a href="../../db/dc8/packages_2graphics_2sdl_2text_8c_source.html#l00034">text.c:34</a></div></div>
<div class="ttc" id="ainclude_2arc_2graphics_2text_8h_html_a317688d3c7ed9dc82fdef7dd136fd462"><div class="ttname"><a href="../../d8/da9/include_2arc_2graphics_2text_8h.html#a317688d3c7ed9dc82fdef7dd136fd462">ARC_Text_Create</a></div><div class="ttdeci">void ARC_Text_Create(ARC_Text **text, ARC_String *path, int32_t size, ARC_Color color)</div><div class="ttdef"><b>Definition</b> <a href="../../db/dc8/packages_2graphics_2sdl_2text_8c_source.html#l00011">text.c:11</a></div></div>
<div class="ttc" id="ainclude_2arc_2graphics_2text_8h_html_a81e08f1c4210a1d33a6b5be4ff2bde8c"><div class="ttname"><a href="../../d8/da9/include_2arc_2graphics_2text_8h.html#a81e08f1c4210a1d33a6b5be4ff2bde8c">ARC_Text_Destroy</a></div><div class="ttdeci">void ARC_Text_Destroy(ARC_Text *font)</div><div class="ttdef"><b>Definition</b> <a href="../../db/dc8/packages_2graphics_2sdl_2text_8c_source.html#l00026">text.c:26</a></div></div>
<div class="ttc" id="ainclude_2arc_2graphics_2text_8h_html_a8fb85afa64d8e337f475db6eaa23bbcb"><div class="ttname"><a href="../../d8/da9/include_2arc_2graphics_2text_8h.html#a8fb85afa64d8e337f475db6eaa23bbcb">ARC_Text_Render</a></div><div class="ttdeci">void ARC_Text_Render(ARC_Text *text, ARC_Renderer *renderer)</div><div class="ttdef"><b>Definition</b> <a href="../../db/dc8/packages_2graphics_2sdl_2text_8c_source.html#l00052">text.c:52</a></div></div>
<div class="ttc" id="ainclude_2arc_2graphics_2text_8h_html_acaf60a21f71839044b1eaa775c443db7"><div class="ttname"><a href="../../d8/da9/include_2arc_2graphics_2text_8h.html#acaf60a21f71839044b1eaa775c443db7">ARC_Text_SetPos</a></div><div class="ttdeci">void ARC_Text_SetPos(ARC_Text *text, ARC_Point pos)</div><div class="ttdef"><b>Definition</b> <a href="../../db/dc8/packages_2graphics_2sdl_2text_8c_source.html#l00061">text.c:61</a></div></div>
<div class="ttc" id="astructARC__Color_html"><div class="ttname"><a href="../../d2/d30/structARC__Color.html">ARC_Color</a></div><div class="ttdef"><b>Definition</b> <a href="../../da/dec/color_8h_source.html#l00010">color.h:10</a></div></div>
<div class="ttc" id="astructARC__Point_html"><div class="ttname"><a href="../../d2/d9d/structARC__Point.html">ARC_Point</a></div><div class="ttdef"><b>Definition</b> <a href="../../d2/d91/point_8h_source.html#l00010">point.h:10</a></div></div>
<div class="ttc" id="astructARC__String_html"><div class="ttname"><a href="../../df/d06/structARC__String.html">ARC_String</a></div><div class="ttdoc">substring position within a string</div><div class="ttdef"><b>Definition</b> <a href="../../da/d66/string_8h_source.html#l00014">string.h:14</a></div></div>
<div class="ttc" id="astructARC__Text_html"><div class="ttname"><a href="../../dc/d7a/structARC__Text.html">ARC_Text</a></div><div class="ttdef"><b>Definition</b> <a href="../../d5/d90/packages_2graphics_2sdl_2text_8h_source.html#l00010">text.h:10</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_93501a11e921083efbd154e0cdff5f10.html">packages</a></li><li class="navelem"><a class="el" href="../../dir_af6e6c3357835c7f766dfcaf351d30ad.html">graphics</a></li><li class="navelem"><a class="el" href="../../dir_ad51ffe8b33deed52e38849f403bcdb5.html">opengl</a></li><li class="navelem"><a class="el" href="../../d6/d94/packages_2graphics_2opengl_2text_8c.html">text.c</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>