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

331
doc/doxygen/html/d1/dc6/include_2arc_2graphics_2renderer_8h.html Normal file
View file

@ -0,0 +1,331 @@
<!-- 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/graphics/renderer.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/dc6/include_2arc_2graphics_2renderer_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="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">renderer.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a href="../../d1/dc6/include_2arc_2graphics_2renderer_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="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a2b82366dc421b3e80aace49f3ae8639a" id="r_a2b82366dc421b3e80aace49f3ae8639a"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="../../d1/d2f/packages_2graphics_2sdl_2renderer_8h.html#aa7a168fb194da6ebfd3b0695fdfc15a4">ARC_RendererType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a></td></tr>
<tr class="separator:a2b82366dc421b3e80aace49f3ae8639a"><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:a498204d28a753ae15b67962960ddca04" id="r_a498204d28a753ae15b67962960ddca04"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a498204d28a753ae15b67962960ddca04">ARC_Renderer_CreateWithEngineData</a> (<a class="el" href="#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> **renderer, <a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> *data)</td></tr>
<tr class="memdesc:a498204d28a753ae15b67962960ddca04"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates ARC_Renderer type with <a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> <br /></td></tr>
<tr class="separator:a498204d28a753ae15b67962960ddca04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc868b155fe4429b0569cf07fec57a76" id="r_abc868b155fe4429b0569cf07fec57a76"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abc868b155fe4429b0569cf07fec57a76">ARC_Renderer_Destroy</a> (<a class="el" href="#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *renderer)</td></tr>
<tr class="memdesc:abc868b155fe4429b0569cf07fec57a76"><td class="mdescLeft">&#160;</td><td class="mdescRight">destroys ARC_Renderer type <br /></td></tr>
<tr class="separator:abc868b155fe4429b0569cf07fec57a76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a658b3d0b45be17d35a4ba6f58c6c410d" id="r_a658b3d0b45be17d35a4ba6f58c6c410d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a658b3d0b45be17d35a4ba6f58c6c410d">ARC_Renderer_Clear</a> (<a class="el" href="#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *renderer)</td></tr>
<tr class="separator:a658b3d0b45be17d35a4ba6f58c6c410d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac44af02eacceb9af14f87e8a7f62aad5" id="r_ac44af02eacceb9af14f87e8a7f62aad5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac44af02eacceb9af14f87e8a7f62aad5">ARC_Renderer_Render</a> (<a class="el" href="#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *renderer)</td></tr>
<tr class="memdesc:ac44af02eacceb9af14f87e8a7f62aad5"><td class="mdescLeft">&#160;</td><td class="mdescRight">renders the renderer <br /></td></tr>
<tr class="separator:ac44af02eacceb9af14f87e8a7f62aad5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a2b82366dc421b3e80aace49f3ae8639a" name="a2b82366dc421b3e80aace49f3ae8639a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b82366dc421b3e80aace49f3ae8639a">&#9670;&#160;</a></span>ARC_Renderer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="../../d1/d2f/packages_2graphics_2sdl_2renderer_8h.html#aa7a168fb194da6ebfd3b0695fdfc15a4">ARC_RendererType</a> <a class="el" href="#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section note"><dt>Note</dt><dd>ARC_RendererType is determined by which window library you are using </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../d1/dc6/include_2arc_2graphics_2renderer_8h_source.html#l00016">16</a> of file <a class="el" href="../../d1/dc6/include_2arc_2graphics_2renderer_8h_source.html">renderer.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a658b3d0b45be17d35a4ba6f58c6c410d" name="a658b3d0b45be17d35a4ba6f58c6c410d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a658b3d0b45be17d35a4ba6f58c6c410d">&#9670;&#160;</a></span>ARC_Renderer_Clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Renderer_Clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *</td> <td class="paramname"><span class="paramname"><em>renderer</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>@breif clears the renderer</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">renderer</td><td>the renderer to clear </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d8/d04/packages_2graphics_2sdl_2renderer_8c_source.html#l00032">32</a> of file <a class="el" href="../../d8/d04/packages_2graphics_2sdl_2renderer_8c_source.html">renderer.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 32</span> {</div>
<div class="line"><span class="lineno"> 33</span> <span class="comment">//TODO: changed for school, also need to add the ability to change render draw color</span></div>
<div class="line"><span class="lineno"> 34</span> <span class="comment">//SDL_SetRenderDrawColor((SDL_Renderer *)renderer, 0x1c, 0x2c, 0x3c, 0x00);</span></div>
<div class="line"><span class="lineno"> 35</span> SDL_SetRenderDrawColor((SDL_Renderer *)renderer, 0x15, 0x2a, 0x26, 0x00);</div>
<div class="line"><span class="lineno"> 36</span> SDL_RenderClear((SDL_Renderer *)renderer);</div>
<div class="line"><span class="lineno"> 37</span>}</div>
</div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="../../dd/d56/engine_8c_source.html#l00059">ARC_Engine_RunUncapped()</a>.</p>
</div>
</div>
<a id="a498204d28a753ae15b67962960ddca04" name="a498204d28a753ae15b67962960ddca04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a498204d28a753ae15b67962960ddca04">&#9670;&#160;</a></span>ARC_Renderer_CreateWithEngineData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Renderer_CreateWithEngineData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> **</td> <td class="paramname"><span class="paramname"><em>renderer</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> *</td> <td class="paramname"><span class="paramname"><em>data</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>creates ARC_Renderer type with <a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> </p>
<dl class="section note"><dt>Note</dt><dd>the parameter data is determined by which graphics library you are using please refer to the graphics library section to see what needs to be passed</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">renderer</td><td>ARC_Renderer to initialize </td></tr>
<tr><td class="paramname">data</td><td>the engine data to create from </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d8/d04/packages_2graphics_2sdl_2renderer_8c_source.html#l00010">10</a> of file <a class="el" href="../../d8/d04/packages_2graphics_2sdl_2renderer_8c_source.html">renderer.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 10</span> {</div>
<div class="line"><span class="lineno"> 11</span> <span class="keywordflow">if</span>(!data){</div>
<div class="line"><span class="lineno"> 12</span> <a class="code hl_variable" href="../../d8/dc2/errno_8h.html#a5884aa8cc9b4e733345e49f93b54f75a">arc_errno</a> = <a class="code hl_define" href="../../d8/dc2/errno_8h.html#ab626cdbbebc1ac9abd1548a5f6f6195b">ARC_ERRNO_NULL</a>;</div>
<div class="line"><span class="lineno"> 13</span> <a class="code hl_define" href="../../d8/dc2/errno_8h.html#ad32a4f194b90c9ede4e393c0d4185590">ARC_DEBUG_LOG_ERROR</a>(<span class="stringliteral">&quot;ARC_Renderer_CreateWithEngineData(**renderer, NULL)&quot;</span>);</div>
<div class="line"><span class="lineno"> 14</span> <span class="keywordflow">return</span>;</div>
<div class="line"><span class="lineno"> 15</span> }</div>
<div class="line"><span class="lineno"> 16</span> </div>
<div class="line"><span class="lineno"> 17</span> *renderer = (<a class="code hl_typedef" href="#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *)SDL_CreateRenderer((SDL_Window *)(data-&gt;<a class="code hl_variable" href="../../d5/df0/structARC__EngineData.html#abcdb1fc080bcd9ad137bc3ac8ae69432">window</a>), -1, SDL_RENDERER_ACCELERATED);</div>
<div class="line"><span class="lineno"> 18</span> </div>
<div class="line"><span class="lineno"> 19</span> <span class="keywordflow">if</span>(!*renderer){</div>
<div class="line"><span class="lineno"> 20</span> <a class="code hl_variable" href="../../d8/dc2/errno_8h.html#a5884aa8cc9b4e733345e49f93b54f75a">arc_errno</a> = <a class="code hl_define" href="../../d8/dc2/errno_8h.html#ab626cdbbebc1ac9abd1548a5f6f6195b">ARC_ERRNO_NULL</a>;</div>
<div class="line"><span class="lineno"> 21</span> <a class="code hl_define" href="../../d8/dc2/errno_8h.html#a8cbc7f5b6cb9e20d3993284f0f80ec83">ARC_DEBUG_LOG_ERROR_WITH_VARIABLES</a>(<span class="stringliteral">&quot;SDL_CreateRenderer(%p, %d, %u);&quot;</span>, data-&gt;<a class="code hl_variable" href="../../d5/df0/structARC__EngineData.html#abcdb1fc080bcd9ad137bc3ac8ae69432">window</a>, -1, SDL_RENDERER_ACCELERATED);</div>
<div class="line"><span class="lineno"> 22</span> free(renderer);</div>
<div class="line"><span class="lineno"> 23</span> }</div>
<div class="line"><span class="lineno"> 24</span> </div>
<div class="line"><span class="lineno"> 25</span> SDL_SetRenderDrawBlendMode((SDL_Renderer *)*renderer, SDL_BLENDMODE_BLEND);</div>
<div class="line"><span class="lineno"> 26</span>}</div>
<div class="ttc" id="aerrno_8h_html_a5884aa8cc9b4e733345e49f93b54f75a"><div class="ttname"><a href="../../d8/dc2/errno_8h.html#a5884aa8cc9b4e733345e49f93b54f75a">arc_errno</a></div><div class="ttdeci">int32_t arc_errno</div><div class="ttdef"><b>Definition</b> <a href="../../d0/d90/errno_8c_source.html#l00005">errno.c:5</a></div></div>
<div class="ttc" id="aerrno_8h_html_a8cbc7f5b6cb9e20d3993284f0f80ec83"><div class="ttname"><a href="../../d8/dc2/errno_8h.html#a8cbc7f5b6cb9e20d3993284f0f80ec83">ARC_DEBUG_LOG_ERROR_WITH_VARIABLES</a></div><div class="ttdeci">#define ARC_DEBUG_LOG_ERROR_WITH_VARIABLES(STR,...)</div><div class="ttdef"><b>Definition</b> <a href="../../d8/dc2/errno_8h_source.html#l00040">errno.h:40</a></div></div>
<div class="ttc" id="aerrno_8h_html_ab626cdbbebc1ac9abd1548a5f6f6195b"><div class="ttname"><a href="../../d8/dc2/errno_8h.html#ab626cdbbebc1ac9abd1548a5f6f6195b">ARC_ERRNO_NULL</a></div><div class="ttdeci">#define ARC_ERRNO_NULL</div><div class="ttdef"><b>Definition</b> <a href="../../d8/dc2/errno_8h_source.html#l00006">errno.h:6</a></div></div>
<div class="ttc" id="aerrno_8h_html_ad32a4f194b90c9ede4e393c0d4185590"><div class="ttname"><a href="../../d8/dc2/errno_8h.html#ad32a4f194b90c9ede4e393c0d4185590">ARC_DEBUG_LOG_ERROR</a></div><div class="ttdeci">#define ARC_DEBUG_LOG_ERROR(STR)</div><div class="ttdef"><b>Definition</b> <a href="../../d8/dc2/errno_8h_source.html#l00039">errno.h:39</a></div></div>
<div class="ttc" id="ainclude_2arc_2graphics_2renderer_8h_html_a2b82366dc421b3e80aace49f3ae8639a"><div class="ttname"><a href="#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="astructARC__EngineData_html_abcdb1fc080bcd9ad137bc3ac8ae69432"><div class="ttname"><a href="../../d5/df0/structARC__EngineData.html#abcdb1fc080bcd9ad137bc3ac8ae69432">ARC_EngineData::window</a></div><div class="ttdeci">ARC_Window * window</div><div class="ttdef"><b>Definition</b> <a href="../../d1/d55/engine_8h_source.html#l00018">engine.h:18</a></div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="../../d8/dc2/errno_8h_source.html#l00039">ARC_DEBUG_LOG_ERROR</a>, <a class="el" href="../../d8/dc2/errno_8h_source.html#l00040">ARC_DEBUG_LOG_ERROR_WITH_VARIABLES</a>, <a class="el" href="../../d0/d90/errno_8c_source.html#l00005">arc_errno</a>, <a class="el" href="../../d8/dc2/errno_8h_source.html#l00006">ARC_ERRNO_NULL</a>, and <a class="el" href="../../d1/d55/engine_8h_source.html#l00018">ARC_EngineData::window</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../dd/d56/engine_8c_source.html#l00017">ARC_EngineData_Create()</a>.</p>
</div>
</div>
<a id="abc868b155fe4429b0569cf07fec57a76" name="abc868b155fe4429b0569cf07fec57a76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc868b155fe4429b0569cf07fec57a76">&#9670;&#160;</a></span>ARC_Renderer_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Renderer_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *</td> <td class="paramname"><span class="paramname"><em>renderer</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>destroys ARC_Renderer type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">renderer</td><td>ARC_Renderer to destory </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d8/d04/packages_2graphics_2sdl_2renderer_8c_source.html#l00028">28</a> of file <a class="el" href="../../d8/d04/packages_2graphics_2sdl_2renderer_8c_source.html">renderer.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 28</span> {</div>
<div class="line"><span class="lineno"> 29</span> SDL_DestroyRenderer((SDL_Renderer *) renderer);</div>
<div class="line"><span class="lineno"> 30</span>}</div>
</div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="../../dd/d56/engine_8c_source.html#l00051">ARC_EngineData_Destroy()</a>.</p>
</div>
</div>
<a id="ac44af02eacceb9af14f87e8a7f62aad5" name="ac44af02eacceb9af14f87e8a7f62aad5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac44af02eacceb9af14f87e8a7f62aad5">&#9670;&#160;</a></span>ARC_Renderer_Render()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Renderer_Render </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *</td> <td class="paramname"><span class="paramname"><em>renderer</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>renders the renderer </p>
<dl class="section note"><dt>Note</dt><dd>the renderer will most likely be drawn to from <a class="el" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">renderer</td><td>the renderer to render </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="../../d8/d04/packages_2graphics_2sdl_2renderer_8c_source.html#l00039">39</a> of file <a class="el" href="../../d8/d04/packages_2graphics_2sdl_2renderer_8c_source.html">renderer.c</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 39</span> {</div>
<div class="line"><span class="lineno"> 40</span> SDL_RenderPresent((SDL_Renderer *)renderer);</div>
<div class="line"><span class="lineno"> 41</span>}</div>
</div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="../../dd/d56/engine_8c_source.html#l00059">ARC_Engine_RunUncapped()</a>.</p>
</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_169ca87d8ac185e5b51c45f4a68386c0.html">graphics</a></li><li class="navelem"><a class="el" href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html">renderer.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>

8
doc/doxygen/html/d1/dc6/include_2arc_2graphics_2renderer_8h.js Normal file
View file

@ -0,0 +1,8 @@
var include_2arc_2graphics_2renderer_8h =
[
[ "ARC_Renderer", "d1/dc6/include_2arc_2graphics_2renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a", null ],
[ "ARC_Renderer_Clear", "d1/dc6/include_2arc_2graphics_2renderer_8h.html#a658b3d0b45be17d35a4ba6f58c6c410d", null ],
[ "ARC_Renderer_CreateWithEngineData", "d1/dc6/include_2arc_2graphics_2renderer_8h.html#a498204d28a753ae15b67962960ddca04", null ],
[ "ARC_Renderer_Destroy", "d1/dc6/include_2arc_2graphics_2renderer_8h.html#abc868b155fe4429b0569cf07fec57a76", null ],
[ "ARC_Renderer_Render", "d1/dc6/include_2arc_2graphics_2renderer_8h.html#ac44af02eacceb9af14f87e8a7f62aad5", null ]
];

191
doc/doxygen/html/d1/dc6/include_2arc_2graphics_2renderer_8h_source.html Normal file
View file

@ -0,0 +1,191 @@
<!-- 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/graphics/renderer.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('d1/dc6/include_2arc_2graphics_2renderer_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">renderer.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../d1/dc6/include_2arc_2graphics_2renderer_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_GRAPHICS_RENDERER_H_</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_GRAPHICS_RENDERER_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">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"></span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">/**</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * @brief predefien ARC_EngineData so as not to get circular reference</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">*/</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="../../d1/d55/engine_8h.html#a5f80ada5dfc3cf5b3e5d8aa840c86f6e"> 11</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> <a class="code hl_struct" href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a>;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"></span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">/**</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * @note ARC_RendererType is determined by which window library you are using</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">*/</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a"> 16</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_typedef" href="../../d1/d2f/packages_2graphics_2sdl_2renderer_8h.html#aa7a168fb194da6ebfd3b0695fdfc15a4">ARC_RendererType</a> <a class="code hl_typedef" href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a>;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">/**</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> * @brief creates ARC_Renderer type with ARC_EngineData</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> *</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment"> * @note the parameter data is determined by which graphics library you are using</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * please refer to the graphics library section to see what needs to be passed</span></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"> * @param renderer ARC_Renderer to initialize</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> * @param data the engine data to create from</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="keywordtype">void</span> <a class="code hl_function" href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html#a498204d28a753ae15b67962960ddca04">ARC_Renderer_CreateWithEngineData</a>(<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="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a> *data);</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">/**</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"> * @brief destroys ARC_Renderer type</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> *</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> * @param renderer ARC_Renderer to destory</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="keywordtype">void</span> <a class="code hl_function" href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html#abc868b155fe4429b0569cf07fec57a76">ARC_Renderer_Destroy</a>(<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="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">/**</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment"> * @breif clears the renderer</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"> *</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> * @param renderer the renderer to clear</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment">*/</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html#a658b3d0b45be17d35a4ba6f58c6c410d">ARC_Renderer_Clear</a>(<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="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"></span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment">/**</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment"> * @brief renders the renderer</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"> *</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"> * @note the renderer will most likely be drawn to from ARC_EngineData</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> *</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> * @param renderer the renderer to render</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment">*/</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html#ac44af02eacceb9af14f87e8a7f62aad5">ARC_Renderer_Render</a>(<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="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>}</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="preprocessor">#endif </span><span class="comment">// !ARC_GRAPHICS_RENDERER_H_</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="#l00016">renderer.h:16</a></div></div>
<div class="ttc" id="ainclude_2arc_2graphics_2renderer_8h_html_a498204d28a753ae15b67962960ddca04"><div class="ttname"><a href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html#a498204d28a753ae15b67962960ddca04">ARC_Renderer_CreateWithEngineData</a></div><div class="ttdeci">void ARC_Renderer_CreateWithEngineData(ARC_Renderer **renderer, ARC_EngineData *data)</div><div class="ttdoc">creates ARC_Renderer type with ARC_EngineData</div><div class="ttdef"><b>Definition</b> <a href="../../d8/d04/packages_2graphics_2sdl_2renderer_8c_source.html#l00010">renderer.c:10</a></div></div>
<div class="ttc" id="ainclude_2arc_2graphics_2renderer_8h_html_a658b3d0b45be17d35a4ba6f58c6c410d"><div class="ttname"><a href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html#a658b3d0b45be17d35a4ba6f58c6c410d">ARC_Renderer_Clear</a></div><div class="ttdeci">void ARC_Renderer_Clear(ARC_Renderer *renderer)</div><div class="ttdef"><b>Definition</b> <a href="../../d8/d04/packages_2graphics_2sdl_2renderer_8c_source.html#l00032">renderer.c:32</a></div></div>
<div class="ttc" id="ainclude_2arc_2graphics_2renderer_8h_html_abc868b155fe4429b0569cf07fec57a76"><div class="ttname"><a href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html#abc868b155fe4429b0569cf07fec57a76">ARC_Renderer_Destroy</a></div><div class="ttdeci">void ARC_Renderer_Destroy(ARC_Renderer *renderer)</div><div class="ttdoc">destroys ARC_Renderer type</div><div class="ttdef"><b>Definition</b> <a href="../../d8/d04/packages_2graphics_2sdl_2renderer_8c_source.html#l00028">renderer.c:28</a></div></div>
<div class="ttc" id="ainclude_2arc_2graphics_2renderer_8h_html_ac44af02eacceb9af14f87e8a7f62aad5"><div class="ttname"><a href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html#ac44af02eacceb9af14f87e8a7f62aad5">ARC_Renderer_Render</a></div><div class="ttdeci">void ARC_Renderer_Render(ARC_Renderer *renderer)</div><div class="ttdoc">renders the renderer</div><div class="ttdef"><b>Definition</b> <a href="../../d8/d04/packages_2graphics_2sdl_2renderer_8c_source.html#l00039">renderer.c:39</a></div></div>
<div class="ttc" id="apackages_2graphics_2sdl_2renderer_8h_html_aa7a168fb194da6ebfd3b0695fdfc15a4"><div class="ttname"><a href="../../d1/d2f/packages_2graphics_2sdl_2renderer_8h.html#aa7a168fb194da6ebfd3b0695fdfc15a4">ARC_RendererType</a></div><div class="ttdeci">SDL_Renderer ARC_RendererType</div><div class="ttdef"><b>Definition</b> <a href="../../d1/d2f/packages_2graphics_2sdl_2renderer_8h_source.html#l00008">renderer.h:8</a></div></div>
<div class="ttc" id="astructARC__EngineData_html"><div class="ttname"><a href="../../d5/df0/structARC__EngineData.html">ARC_EngineData</a></div><div class="ttdef"><b>Definition</b> <a href="../../d1/d55/engine_8h_source.html#l00017">engine.h:17</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_169ca87d8ac185e5b51c45f4a68386c0.html">graphics</a></li><li class="navelem"><a class="el" href="../../d1/dc6/include_2arc_2graphics_2renderer_8h.html">renderer.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>