herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
archeus/doc/doxygen/html/d5/de5/graphics_2view_8h_source.html

203 lines
20 KiB
HTML
Raw Normal View History

started woking on figuring out doxygen documentation and added readme
2024-12-24 03:47:16 -07:00
<!-- 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/view.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('d5/de5/graphics_2view_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">view.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../d5/de5/graphics_2view_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_VIEW_H_</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_GRAPHICS_VIEW_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> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;<a class="code" href="../../d6/d85/renderer_8h.html">arc/graphics/renderer.h</a>&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;<a class="code" href="../../d2/d14/math_2rectangle_8h.html">arc/math/rectangle.h</a>&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="../../dc/d18/structARC__View.html"> 11</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="../../dc/d18/structARC__View.html">ARC_View</a> {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="../../dc/d18/structARC__View.html#a54d5de957f6fa8ff67236cbf7bba7a8e"> 12</a></span> <a class="code hl_typedef" href="../../d6/d85/renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *<a class="code hl_variable" href="../../dc/d18/structARC__View.html#a54d5de957f6fa8ff67236cbf7bba7a8e">renderer</a>;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="../../dc/d18/structARC__View.html#a666c27bd67f669cf2abc0f63efd3934a"> 13</a></span> <a class="code hl_struct" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> <a class="code hl_variable" href="../../dc/d18/structARC__View.html#a666c27bd67f669cf2abc0f63efd3934a">bounds</a>;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="../../d5/de5/graphics_2view_8h.html#a1724ebeb7f950d56c593431e1fbc76f5"> 14</a></span>} <a class="code hl_typedef" href="../../d5/de5/graphics_2view_8h.html#a1724ebeb7f950d56c593431e1fbc76f5">ARC_View</a>;</div>
</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"> 16</span><span class="comment">/**</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * @brief a function for ARC_View where contents of the function will be rendered within a view</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"> * @param data data to be used within ARC_View_RenderFn</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"><a class="line" href="../../d5/de5/graphics_2view_8h.html#ad1ac7d4e1924b60da2f857b59801ec60"> 21</a></span><span class="keyword">typedef</span> void (* <a class="code hl_typedef" href="../../d5/de5/graphics_2view_8h.html#ad1ac7d4e1924b60da2f857b59801ec60">ARC_View_RenderFn</a>)(<span class="keywordtype">void</span> *data);</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"></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"> * @brief creates ARC_View type</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> *</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> * @param view ARC_View to initialize</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment"> * @param renderer ARC_Renderer the view will render to</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment"> * @param bounds ARC_Rect bounds of the view within the renderer </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"><a class="line" href="../../d5/de5/graphics_2view_8h.html#ab6dc86e2534d18462197a7f5631eb6f1"> 30</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d5/de5/graphics_2view_8h.html#ab6dc86e2534d18462197a7f5631eb6f1">ARC_View_Create</a>(<a class="code hl_struct" href="../../dc/d18/structARC__View.html">ARC_View</a> **view, <a class="code hl_typedef" href="../../d6/d85/renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *renderer, <a class="code hl_struct" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> bounds);</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">/**</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * @brief destroys ARC_View type</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> */</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="../../d5/de5/graphics_2view_8h.html#aa4fbfd12f927bd495594828e3b43b561"> 35</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d5/de5/graphics_2view_8h.html#aa4fbfd12f927bd495594828e3b43b561">ARC_View_Destroy</a>(<a class="code hl_struct" href="../../dc/d18/structARC__View.html">ARC_View</a> *view);</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">/**</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"> * @brief renders callbacks contents within an ARC_View</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> * </span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment"> * @param view ARC_View to be renedered to</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"> * @param renderFn function which contents will render to given ARC_View</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"> * @param data data to be used in renderFn</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"><a class="line" href="../../d5/de5/graphics_2view_8h.html#a3ae6e8988b6128f00589aba6183b5f86"> 44</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d5/de5/graphics_2view_8h.html#a3ae6e8988b6128f00589aba6183b5f86">ARC_View_Render</a>(<a class="code hl_struct" href="../../dc/d18/structARC__View.html">ARC_View</a> *view, <a class="code hl_typedef" href="../../d5/de5/graphics_2view_8h.html#ad1ac7d4e1924b60da2f857b59801ec60">ARC_View_RenderFn</a> renderFn, <span class="keywordtype">void</span> *data);</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">/**</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> * @brief gets bounds from ARC_View type</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> *</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> * @param view ARC_View to get bounds from</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> *</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> * @return bounds of the view</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"> */</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="../../d5/de5/graphics_2view_8h.html#a1bfd840c5d19e24cff495ce95c67f18e"> 53</a></span><a class="code hl_struct" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> <a class="code hl_function" href="../../d5/de5/graphics_2view_8h.html#a1bfd840c5d19e24cff495ce95c67f18e">ARC_View_GetBounds</a>(<a class="code hl_struct" href="../../dc/d18/structARC__View.html">ARC_View</a> *view);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>}</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor">#endif </span><span class="comment">// !ARC_GRAPHICS_VIEW_H_</span></div>
<div class="ttc" id="agraphics_2view_8h_html_a1724ebeb7f950d56c593431e1fbc76f5"><div class="ttname"><a href="../../d5/de5/graphics_2view_8h.html#a1724ebeb7f950d56c593431e1fbc76f5">ARC_View</a></div><div class="ttdeci">struct ARC_View ARC_View</div></div>
<div class="ttc" id="agraphics_2view_8h_html_a1bfd840c5d19e24cff495ce95c67f18e"><div class="ttname"><a href="../../d5/de5/graphics_2view_8h.html#a1bfd840c5d19e24cff495ce95c67f18e">ARC_View_GetBounds</a></div><div class="ttdeci">ARC_Rect ARC_View_GetBounds(ARC_View *view)</div><div class="ttdoc">gets bounds from ARC_View type</div></div>
<div class="ttc" id="agraphics_2view_8h_html_a3ae6e8988b6128f00589aba6183b5f86"><div class="ttname"><a href="../../d5/de5/graphics_2view_8h.html#a3ae6e8988b6128f00589aba6183b5f86">ARC_View_Render</a></div><div class="ttdeci">void ARC_View_Render(ARC_View *view, ARC_View_RenderFn renderFn, void *data)</div><div class="ttdoc">renders callbacks contents within an ARC_View</div></div>
<div class="ttc" id="agraphics_2view_8h_html_aa4fbfd12f927bd495594828e3b43b561"><div class="ttname"><a href="../../d5/de5/graphics_2view_8h.html#aa4fbfd12f927bd495594828e3b43b561">ARC_View_Destroy</a></div><div class="ttdeci">void ARC_View_Destroy(ARC_View *view)</div><div class="ttdoc">destroys ARC_View type</div></div>
<div class="ttc" id="agraphics_2view_8h_html_ab6dc86e2534d18462197a7f5631eb6f1"><div class="ttname"><a href="../../d5/de5/graphics_2view_8h.html#ab6dc86e2534d18462197a7f5631eb6f1">ARC_View_Create</a></div><div class="ttdeci">void ARC_View_Create(ARC_View **view, ARC_Renderer *renderer, ARC_Rect bounds)</div><div class="ttdoc">creates ARC_View type</div></div>
<div class="ttc" id="agraphics_2view_8h_html_ad1ac7d4e1924b60da2f857b59801ec60"><div class="ttname"><a href="../../d5/de5/graphics_2view_8h.html#ad1ac7d4e1924b60da2f857b59801ec60">ARC_View_RenderFn</a></div><div class="ttdeci">void(* ARC_View_RenderFn)(void *data)</div><div class="ttdoc">a function for ARC_View where contents of the function will be rendered within a view</div><div class="ttdef"><b>Definition</b> <a href="#l00021">view.h:21</a></div></div>
<div class="ttc" id="amath_2rectangle_8h_html"><div class="ttname"><a href="../../d2/d14/math_2rectangle_8h.html">rectangle.h</a></div></div>
<div class="ttc" id="arenderer_8h_html"><div class="ttname"><a href="../../d6/d85/renderer_8h.html">renderer.h</a></div></div>
<div class="ttc" id="arenderer_8h_html_a2b82366dc421b3e80aace49f3ae8639a"><div class="ttname"><a href="../../d6/d85/renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a></div><div class="ttdeci">struct ARC_RendererType ARC_Renderer</div><div class="ttdef"><b>Definition</b> <a href="../../d6/d85/renderer_8h_source.html#l00016">renderer.h:16</a></div></div>
<div class="ttc" id="astructARC__Rect_html"><div class="ttname"><a href="../../d0/d18/structARC__Rect.html">ARC_Rect</a></div><div class="ttdef"><b>Definition</b> <a href="../../d2/d14/math_2rectangle_8h_source.html#l00012">rectangle.h:12</a></div></div>
<div class="ttc" id="astructARC__View_html"><div class="ttname"><a href="../../dc/d18/structARC__View.html">ARC_View</a></div><div class="ttdef"><b>Definition</b> <a href="#l00011">view.h:11</a></div></div>
<div class="ttc" id="astructARC__View_html_a54d5de957f6fa8ff67236cbf7bba7a8e"><div class="ttname"><a href="../../dc/d18/structARC__View.html#a54d5de957f6fa8ff67236cbf7bba7a8e">ARC_View::renderer</a></div><div class="ttdeci">ARC_Renderer * renderer</div><div class="ttdef"><b>Definition</b> <a href="#l00012">view.h:12</a></div></div>
<div class="ttc" id="astructARC__View_html_a666c27bd67f669cf2abc0f63efd3934a"><div class="ttname"><a href="../../dc/d18/structARC__View.html#a666c27bd67f669cf2abc0f63efd3934a">ARC_View::bounds</a></div><div class="ttdeci">ARC_Rect bounds</div><div class="ttdef"><b>Definition</b> <a href="#l00013">view.h:13</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="../../d5/de5/graphics_2view_8h.html">view.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>
Reference in a new issue Copy permalink