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

492
doc/doxygen/html/d5/d08/buffer_8h.html Normal file
View file

@ -0,0 +1,492 @@
<!-- 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/console/buffer.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('d5/d08/buffer_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">buffer.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
<code>#include &quot;<a class="el" href="../../d6/d7e/console_2view_8h_source.html">arc/console/view.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../da/d66/string_8h_source.html">arc/std/string.h</a>&quot;</code><br />
</div>
<p><a href="../../d5/d08/buffer_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:a04647685671d3c7dbb760fcd1413f7e6" id="r_a04647685671d3c7dbb760fcd1413f7e6"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a></td></tr>
<tr class="separator:a04647685671d3c7dbb760fcd1413f7e6"><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:a724aa56dd933bc31502a971204467132" id="r_a724aa56dd933bc31502a971204467132"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a724aa56dd933bc31502a971204467132">ARC_ConsoleBuffer_Create</a> (<a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> **buffer)</td></tr>
<tr class="memdesc:a724aa56dd933bc31502a971204467132"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates ARC_ConsoleBuffer type <br /></td></tr>
<tr class="separator:a724aa56dd933bc31502a971204467132"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2a88c30d33e6d3120d98673fd6beec4" id="r_ab2a88c30d33e6d3120d98673fd6beec4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab2a88c30d33e6d3120d98673fd6beec4">ARC_ConsoleBuffer_Destroy</a> (<a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer)</td></tr>
<tr class="memdesc:ab2a88c30d33e6d3120d98673fd6beec4"><td class="mdescLeft">&#160;</td><td class="mdescRight">destroys ARC_ConsoleBuffer type <br /></td></tr>
<tr class="separator:ab2a88c30d33e6d3120d98673fd6beec4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdc2d574d3bb726cfaa27d8b5768d6f2" id="r_acdc2d574d3bb726cfaa27d8b5768d6f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acdc2d574d3bb726cfaa27d8b5768d6f2">ARC_ConsoleBuffer_Clear</a> (<a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer)</td></tr>
<tr class="memdesc:acdc2d574d3bb726cfaa27d8b5768d6f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">clears the contents of a ARC_ConsoleBuffer <br /></td></tr>
<tr class="separator:acdc2d574d3bb726cfaa27d8b5768d6f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46ebb41d45ba5aeafa12372f69539458" id="r_a46ebb41d45ba5aeafa12372f69539458"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a46ebb41d45ba5aeafa12372f69539458">ARC_ConsoleBuffer_Render</a> (<a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer, <a class="el" href="../../d6/d7e/console_2view_8h.html#a518bdb9b27a8304e65e60ec49320b18b">ARC_ConsoleView</a> *view)</td></tr>
<tr class="memdesc:a46ebb41d45ba5aeafa12372f69539458"><td class="mdescLeft">&#160;</td><td class="mdescRight">renders a buffer to a ARC_ConsoleView <br /></td></tr>
<tr class="separator:a46ebb41d45ba5aeafa12372f69539458"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64f378c7d29c6166dcceb4fe90235f14" id="r_a64f378c7d29c6166dcceb4fe90235f14"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a64f378c7d29c6166dcceb4fe90235f14">ARC_ConsoleBuffer_RenderSection</a> (<a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer, <a class="el" href="../../d6/d7e/console_2view_8h.html#a518bdb9b27a8304e65e60ec49320b18b">ARC_ConsoleView</a> *view, uint32_t startIndex, uint32_t lines)</td></tr>
<tr class="memdesc:a64f378c7d29c6166dcceb4fe90235f14"><td class="mdescLeft">&#160;</td><td class="mdescRight">renders a section of buffer to a ARC_ConsoleView <br /></td></tr>
<tr class="separator:a64f378c7d29c6166dcceb4fe90235f14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18ea5885eb623af1ad0bce81886a37ba" id="r_a18ea5885eb623af1ad0bce81886a37ba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a18ea5885eb623af1ad0bce81886a37ba">ARC_ConsoleBuffer_AddChar</a> (<a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer, char character)</td></tr>
<tr class="memdesc:a18ea5885eb623af1ad0bce81886a37ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">adds a character to the buffer <br /></td></tr>
<tr class="separator:a18ea5885eb623af1ad0bce81886a37ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7c09f28e004665675ad529c457f0d19" id="r_aa7c09f28e004665675ad529c457f0d19"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa7c09f28e004665675ad529c457f0d19">ARC_ConsoleBuffer_AddString</a> (<a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *string)</td></tr>
<tr class="memdesc:aa7c09f28e004665675ad529c457f0d19"><td class="mdescLeft">&#160;</td><td class="mdescRight">adds an <a class="el" href="../../df/d06/structARC__String.html" title="substring position within a string">ARC_String</a> to the buffer <br /></td></tr>
<tr class="separator:aa7c09f28e004665675ad529c457f0d19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87db4e45040059ec8452ae4ed4c9d93c" id="r_a87db4e45040059ec8452ae4ed4c9d93c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a87db4e45040059ec8452ae4ed4c9d93c">ARC_ConsoleBuffer_AddCString</a> (<a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer, char *cstring, uint64_t length)</td></tr>
<tr class="memdesc:a87db4e45040059ec8452ae4ed4c9d93c"><td class="mdescLeft">&#160;</td><td class="mdescRight">adds a cstring to the buffer <br /></td></tr>
<tr class="separator:a87db4e45040059ec8452ae4ed4c9d93c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c3fbf33ecfa1adae24ee628bccaf64e" id="r_a5c3fbf33ecfa1adae24ee628bccaf64e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c3fbf33ecfa1adae24ee628bccaf64e">ARC_ConsoleBuffer_AddCStringWithStrlen</a> (<a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer, char *cstring)</td></tr>
<tr class="memdesc:a5c3fbf33ecfa1adae24ee628bccaf64e"><td class="mdescLeft">&#160;</td><td class="mdescRight">adds a cstring to the buffer with the cstrings string length <br /></td></tr>
<tr class="separator:a5c3fbf33ecfa1adae24ee628bccaf64e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a590db008192631b4cfc9c53904687018" id="r_a590db008192631b4cfc9c53904687018"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a590db008192631b4cfc9c53904687018">ARC_ConsoleBuffer_GetLineNumbers</a> (<a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer)</td></tr>
<tr class="memdesc:a590db008192631b4cfc9c53904687018"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets the number of lines from a console line buffer <br /></td></tr>
<tr class="separator:a590db008192631b4cfc9c53904687018"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a04647685671d3c7dbb760fcd1413f7e6" name="a04647685671d3c7dbb760fcd1413f7e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04647685671d3c7dbb760fcd1413f7e6">&#9670;&#160;</a></span>ARC_ConsoleBuffer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> <a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d5/d08/buffer_8h_source.html#l00015">15</a> of file <a class="el" href="../../d5/d08/buffer_8h_source.html">buffer.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a18ea5885eb623af1ad0bce81886a37ba" name="a18ea5885eb623af1ad0bce81886a37ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18ea5885eb623af1ad0bce81886a37ba">&#9670;&#160;</a></span>ARC_ConsoleBuffer_AddChar()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_ConsoleBuffer_AddChar </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char</td> <td class="paramname"><span class="paramname"><em>character</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>adds a character to the buffer </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>ARC_ConsoleBuffer to add character to </td></tr>
<tr><td class="paramname">character</td><td>char to add to ARC_ConsoleBuffer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a87db4e45040059ec8452ae4ed4c9d93c" name="a87db4e45040059ec8452ae4ed4c9d93c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87db4e45040059ec8452ae4ed4c9d93c">&#9670;&#160;</a></span>ARC_ConsoleBuffer_AddCString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_ConsoleBuffer_AddCString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>cstring</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint64_t</td> <td class="paramname"><span class="paramname"><em>length</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>adds a cstring to the buffer </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>ARC_ConsoleBuffer to add character to </td></tr>
<tr><td class="paramname">string</td><td>cstring to add to ARC_ConsoleBuffer </td></tr>
<tr><td class="paramname">length</td><td>the length of the c string to add </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5c3fbf33ecfa1adae24ee628bccaf64e" name="a5c3fbf33ecfa1adae24ee628bccaf64e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c3fbf33ecfa1adae24ee628bccaf64e">&#9670;&#160;</a></span>ARC_ConsoleBuffer_AddCStringWithStrlen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_ConsoleBuffer_AddCStringWithStrlen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>cstring</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>adds a cstring to the buffer with the cstrings string length </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>ARC_ConsoleBuffer to add character to </td></tr>
<tr><td class="paramname">string</td><td>cstring to add to ARC_ConsoleBuffer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa7c09f28e004665675ad529c457f0d19" name="aa7c09f28e004665675ad529c457f0d19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7c09f28e004665675ad529c457f0d19">&#9670;&#160;</a></span>ARC_ConsoleBuffer_AddString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_ConsoleBuffer_AddString </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>string</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>adds an <a class="el" href="../../df/d06/structARC__String.html" title="substring position within a string">ARC_String</a> to the buffer </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>ARC_ConsoleBuffer to add character to </td></tr>
<tr><td class="paramname">string</td><td><a class="el" href="../../df/d06/structARC__String.html" title="substring position within a string">ARC_String</a> to add to ARC_ConsoleBuffer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acdc2d574d3bb726cfaa27d8b5768d6f2" name="acdc2d574d3bb726cfaa27d8b5768d6f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdc2d574d3bb726cfaa27d8b5768d6f2">&#9670;&#160;</a></span>ARC_ConsoleBuffer_Clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_ConsoleBuffer_Clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>clears the contents of a ARC_ConsoleBuffer </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>ARC_ConsoleBuffer to clear </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a724aa56dd933bc31502a971204467132" name="a724aa56dd933bc31502a971204467132"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a724aa56dd933bc31502a971204467132">&#9670;&#160;</a></span>ARC_ConsoleBuffer_Create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_ConsoleBuffer_Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> **</td> <td class="paramname"><span class="paramname"><em>buffer</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>creates ARC_ConsoleBuffer type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>ARC_ConsoleBuffer to create </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab2a88c30d33e6d3120d98673fd6beec4" name="ab2a88c30d33e6d3120d98673fd6beec4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2a88c30d33e6d3120d98673fd6beec4">&#9670;&#160;</a></span>ARC_ConsoleBuffer_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_ConsoleBuffer_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>destroys ARC_ConsoleBuffer type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>ARC_ConsoleBuffer to destroy </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a590db008192631b4cfc9c53904687018" name="a590db008192631b4cfc9c53904687018"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a590db008192631b4cfc9c53904687018">&#9670;&#160;</a></span>ARC_ConsoleBuffer_GetLineNumbers()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARC_ConsoleBuffer_GetLineNumbers </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets the number of lines from a console line buffer </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>ARC_ConsoleBuffer get number of lines from</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of lines within an ARC_ConsoleBuffer </dd></dl>
</div>
</div>
<a id="a46ebb41d45ba5aeafa12372f69539458" name="a46ebb41d45ba5aeafa12372f69539458"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46ebb41d45ba5aeafa12372f69539458">&#9670;&#160;</a></span>ARC_ConsoleBuffer_Render()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_ConsoleBuffer_Render </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d6/d7e/console_2view_8h.html#a518bdb9b27a8304e65e60ec49320b18b">ARC_ConsoleView</a> *</td> <td class="paramname"><span class="paramname"><em>view</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>renders a buffer to a ARC_ConsoleView </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>ARC_ConsoleBuffer to render </td></tr>
<tr><td class="paramname">view</td><td>ARC_ConsoleView to render the buffer contents to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a64f378c7d29c6166dcceb4fe90235f14" name="a64f378c7d29c6166dcceb4fe90235f14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64f378c7d29c6166dcceb4fe90235f14">&#9670;&#160;</a></span>ARC_ConsoleBuffer_RenderSection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_ConsoleBuffer_RenderSection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *</td> <td class="paramname"><span class="paramname"><em>buffer</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d6/d7e/console_2view_8h.html#a518bdb9b27a8304e65e60ec49320b18b">ARC_ConsoleView</a> *</td> <td class="paramname"><span class="paramname"><em>view</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>startIndex</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>lines</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>renders a section of buffer to a ARC_ConsoleView </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>ARC_ConsoleBuffer to render </td></tr>
<tr><td class="paramname">view</td><td>ARC_ConsoleView to render the buffer contents to </td></tr>
<tr><td class="paramname">startIndex</td><td>start index of buffer to render </td></tr>
<tr><td class="paramname">lines</td><td>the number of lines of buffer to render </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_beba8fde51bfc57b68b9250b4fe33f5c.html">console</a></li><li class="navelem"><a class="el" href="../../d5/d08/buffer_8h.html">buffer.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>

14
doc/doxygen/html/d5/d08/buffer_8h.js Normal file
View file

@ -0,0 +1,14 @@
var buffer_8h =
[
[ "ARC_ConsoleBuffer", "d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6", null ],
[ "ARC_ConsoleBuffer_AddChar", "d5/d08/buffer_8h.html#a18ea5885eb623af1ad0bce81886a37ba", null ],
[ "ARC_ConsoleBuffer_AddCString", "d5/d08/buffer_8h.html#a87db4e45040059ec8452ae4ed4c9d93c", null ],
[ "ARC_ConsoleBuffer_AddCStringWithStrlen", "d5/d08/buffer_8h.html#a5c3fbf33ecfa1adae24ee628bccaf64e", null ],
[ "ARC_ConsoleBuffer_AddString", "d5/d08/buffer_8h.html#aa7c09f28e004665675ad529c457f0d19", null ],
[ "ARC_ConsoleBuffer_Clear", "d5/d08/buffer_8h.html#acdc2d574d3bb726cfaa27d8b5768d6f2", null ],
[ "ARC_ConsoleBuffer_Create", "d5/d08/buffer_8h.html#a724aa56dd933bc31502a971204467132", null ],
[ "ARC_ConsoleBuffer_Destroy", "d5/d08/buffer_8h.html#ab2a88c30d33e6d3120d98673fd6beec4", null ],
[ "ARC_ConsoleBuffer_GetLineNumbers", "d5/d08/buffer_8h.html#a590db008192631b4cfc9c53904687018", null ],
[ "ARC_ConsoleBuffer_Render", "d5/d08/buffer_8h.html#a46ebb41d45ba5aeafa12372f69539458", null ],
[ "ARC_ConsoleBuffer_RenderSection", "d5/d08/buffer_8h.html#a64f378c7d29c6166dcceb4fe90235f14", null ]
];

245
doc/doxygen/html/d5/d08/buffer_8h_source.html Normal file
View file

@ -0,0 +1,245 @@
<!-- 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/console/buffer.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/d08/buffer_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">buffer.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../d5/d08/buffer_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_CONSOLE_LINE_BUFFER_H_</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_CONSOLE_LINE_BUFFER_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 &lt;stdint.h&gt;</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="../../d6/d7e/console_2view_8h.html">arc/console/view.h</a>&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;<a class="code" href="../../da/d66/string_8h.html">arc/std/string.h</a>&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"></span> </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"> * @brief</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">*/</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6"> 15</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_typedef" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> <a class="code hl_typedef" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a>;</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">/**</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> * @brief creates ARC_ConsoleBuffer type</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> *</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> * @param buffer ARC_ConsoleBuffer to create</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">*/</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="../../d5/d08/buffer_8h.html#a724aa56dd933bc31502a971204467132"> 22</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d5/d08/buffer_8h.html#a724aa56dd933bc31502a971204467132">ARC_ConsoleBuffer_Create</a>(<a class="code hl_typedef" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> **buffer);</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">/**</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> * @brief destroys ARC_ConsoleBuffer type</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="comment"> * @param buffer ARC_ConsoleBuffer to destroy</span></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"><a class="line" href="../../d5/d08/buffer_8h.html#ab2a88c30d33e6d3120d98673fd6beec4"> 29</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d5/d08/buffer_8h.html#ab2a88c30d33e6d3120d98673fd6beec4">ARC_ConsoleBuffer_Destroy</a>(<a class="code hl_typedef" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"></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"> * @brief clears the contents of a ARC_ConsoleBuffer</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="comment"> * @param buffer ARC_ConsoleBuffer to clear</span></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"><a class="line" href="../../d5/d08/buffer_8h.html#acdc2d574d3bb726cfaa27d8b5768d6f2"> 36</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d5/d08/buffer_8h.html#acdc2d574d3bb726cfaa27d8b5768d6f2">ARC_ConsoleBuffer_Clear</a>(<a class="code hl_typedef" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer);</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">/**</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> * @brief renders a buffer to a ARC_ConsoleView</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="comment"> * @param buffer ARC_ConsoleBuffer to render</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"> * @param view ARC_ConsoleView to render the buffer contents to</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/d08/buffer_8h.html#a46ebb41d45ba5aeafa12372f69539458"> 44</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d5/d08/buffer_8h.html#a46ebb41d45ba5aeafa12372f69539458">ARC_ConsoleBuffer_Render</a>(<a class="code hl_typedef" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer, <a class="code hl_typedef" href="../../d6/d7e/console_2view_8h.html#a518bdb9b27a8304e65e60ec49320b18b">ARC_ConsoleView</a> *view);</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 renders a section of buffer to a ARC_ConsoleView</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 buffer ARC_ConsoleBuffer to render</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> * @param view ARC_ConsoleView to render the buffer contents to</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> * @param startIndex start index of buffer to render</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"> * @param lines the number of lines of buffer to render</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment">*/</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="../../d5/d08/buffer_8h.html#a64f378c7d29c6166dcceb4fe90235f14"> 54</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d5/d08/buffer_8h.html#a64f378c7d29c6166dcceb4fe90235f14">ARC_ConsoleBuffer_RenderSection</a>(<a class="code hl_typedef" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer, <a class="code hl_typedef" href="../../d6/d7e/console_2view_8h.html#a518bdb9b27a8304e65e60ec49320b18b">ARC_ConsoleView</a> *view, uint32_t startIndex, uint32_t lines);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment"></span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment">/**</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment"> * @brief adds a character to the buffer</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment"> *</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment"> * @param buffer ARC_ConsoleBuffer to add character to</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment"> * @param character char to add to ARC_ConsoleBuffer</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment">*/</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="../../d5/d08/buffer_8h.html#a18ea5885eb623af1ad0bce81886a37ba"> 62</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d5/d08/buffer_8h.html#a18ea5885eb623af1ad0bce81886a37ba">ARC_ConsoleBuffer_AddChar</a>(<a class="code hl_typedef" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer, <span class="keywordtype">char</span> character);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment"></span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment">/**</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment"> * @brief adds an ARC_String to the buffer</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment"> *</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment"> * @param buffer ARC_ConsoleBuffer to add character to</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment"> * @param string ARC_String to add to ARC_ConsoleBuffer</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment">*/</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="../../d5/d08/buffer_8h.html#aa7c09f28e004665675ad529c457f0d19"> 70</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d5/d08/buffer_8h.html#aa7c09f28e004665675ad529c457f0d19">ARC_ConsoleBuffer_AddString</a>(<a class="code hl_typedef" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer, <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="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="comment"></span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment">/**</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment"> * @brief adds a cstring to the buffer</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment"> *</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"> * @param buffer ARC_ConsoleBuffer to add character to</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment"> * @param string cstring to add to ARC_ConsoleBuffer</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"> * @param length the length of the c string to add</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment">*/</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="../../d5/d08/buffer_8h.html#a87db4e45040059ec8452ae4ed4c9d93c"> 79</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d5/d08/buffer_8h.html#a87db4e45040059ec8452ae4ed4c9d93c">ARC_ConsoleBuffer_AddCString</a>(<a class="code hl_typedef" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer, <span class="keywordtype">char</span> *cstring, uint64_t length);</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"></span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment">/**</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment"> * @brief adds a cstring to the buffer with the cstrings string length</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment"> *</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"> * @param buffer ARC_ConsoleBuffer to add character to</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment"> * @param string cstring to add to ARC_ConsoleBuffer</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment">*/</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"><a class="line" href="../../d5/d08/buffer_8h.html#a5c3fbf33ecfa1adae24ee628bccaf64e"> 87</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../d5/d08/buffer_8h.html#a5c3fbf33ecfa1adae24ee628bccaf64e">ARC_ConsoleBuffer_AddCStringWithStrlen</a>(<a class="code hl_typedef" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer, <span class="keywordtype">char</span> *cstring);</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment"></span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment">/**</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment"> * @brief gets the number of lines from a console line buffer</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment"> *</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="comment"> * @param buffer ARC_ConsoleBuffer get number of lines from</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="comment"> *</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment"> * @return the number of lines within an ARC_ConsoleBuffer</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="comment">*/</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="../../d5/d08/buffer_8h.html#a590db008192631b4cfc9c53904687018"> 96</a></span>uint32_t <a class="code hl_function" href="../../d5/d08/buffer_8h.html#a590db008192631b4cfc9c53904687018">ARC_ConsoleBuffer_GetLineNumbers</a>(<a class="code hl_typedef" href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a> *buffer);</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span>}</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="preprocessor">#endif </span><span class="comment">//!ARC_CONSOLE_LINE_BUFFER_H_</span></div>
<div class="ttc" id="abuffer_8h_html_a04647685671d3c7dbb760fcd1413f7e6"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#a04647685671d3c7dbb760fcd1413f7e6">ARC_ConsoleBuffer</a></div><div class="ttdeci">struct ARC_ConsoleBuffer ARC_ConsoleBuffer</div><div class="ttdef"><b>Definition</b> <a href="#l00015">buffer.h:15</a></div></div>
<div class="ttc" id="abuffer_8h_html_a18ea5885eb623af1ad0bce81886a37ba"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#a18ea5885eb623af1ad0bce81886a37ba">ARC_ConsoleBuffer_AddChar</a></div><div class="ttdeci">void ARC_ConsoleBuffer_AddChar(ARC_ConsoleBuffer *buffer, char character)</div><div class="ttdoc">adds a character to the buffer</div></div>
<div class="ttc" id="abuffer_8h_html_a46ebb41d45ba5aeafa12372f69539458"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#a46ebb41d45ba5aeafa12372f69539458">ARC_ConsoleBuffer_Render</a></div><div class="ttdeci">void ARC_ConsoleBuffer_Render(ARC_ConsoleBuffer *buffer, ARC_ConsoleView *view)</div><div class="ttdoc">renders a buffer to a ARC_ConsoleView</div></div>
<div class="ttc" id="abuffer_8h_html_a590db008192631b4cfc9c53904687018"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#a590db008192631b4cfc9c53904687018">ARC_ConsoleBuffer_GetLineNumbers</a></div><div class="ttdeci">uint32_t ARC_ConsoleBuffer_GetLineNumbers(ARC_ConsoleBuffer *buffer)</div><div class="ttdoc">gets the number of lines from a console line buffer</div></div>
<div class="ttc" id="abuffer_8h_html_a5c3fbf33ecfa1adae24ee628bccaf64e"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#a5c3fbf33ecfa1adae24ee628bccaf64e">ARC_ConsoleBuffer_AddCStringWithStrlen</a></div><div class="ttdeci">void ARC_ConsoleBuffer_AddCStringWithStrlen(ARC_ConsoleBuffer *buffer, char *cstring)</div><div class="ttdoc">adds a cstring to the buffer with the cstrings string length</div></div>
<div class="ttc" id="abuffer_8h_html_a64f378c7d29c6166dcceb4fe90235f14"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#a64f378c7d29c6166dcceb4fe90235f14">ARC_ConsoleBuffer_RenderSection</a></div><div class="ttdeci">void ARC_ConsoleBuffer_RenderSection(ARC_ConsoleBuffer *buffer, ARC_ConsoleView *view, uint32_t startIndex, uint32_t lines)</div><div class="ttdoc">renders a section of buffer to a ARC_ConsoleView</div></div>
<div class="ttc" id="abuffer_8h_html_a724aa56dd933bc31502a971204467132"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#a724aa56dd933bc31502a971204467132">ARC_ConsoleBuffer_Create</a></div><div class="ttdeci">void ARC_ConsoleBuffer_Create(ARC_ConsoleBuffer **buffer)</div><div class="ttdoc">creates ARC_ConsoleBuffer type</div></div>
<div class="ttc" id="abuffer_8h_html_a87db4e45040059ec8452ae4ed4c9d93c"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#a87db4e45040059ec8452ae4ed4c9d93c">ARC_ConsoleBuffer_AddCString</a></div><div class="ttdeci">void ARC_ConsoleBuffer_AddCString(ARC_ConsoleBuffer *buffer, char *cstring, uint64_t length)</div><div class="ttdoc">adds a cstring to the buffer</div></div>
<div class="ttc" id="abuffer_8h_html_aa7c09f28e004665675ad529c457f0d19"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#aa7c09f28e004665675ad529c457f0d19">ARC_ConsoleBuffer_AddString</a></div><div class="ttdeci">void ARC_ConsoleBuffer_AddString(ARC_ConsoleBuffer *buffer, ARC_String *string)</div><div class="ttdoc">adds an ARC_String to the buffer</div></div>
<div class="ttc" id="abuffer_8h_html_ab2a88c30d33e6d3120d98673fd6beec4"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#ab2a88c30d33e6d3120d98673fd6beec4">ARC_ConsoleBuffer_Destroy</a></div><div class="ttdeci">void ARC_ConsoleBuffer_Destroy(ARC_ConsoleBuffer *buffer)</div><div class="ttdoc">destroys ARC_ConsoleBuffer type</div></div>
<div class="ttc" id="abuffer_8h_html_acdc2d574d3bb726cfaa27d8b5768d6f2"><div class="ttname"><a href="../../d5/d08/buffer_8h.html#acdc2d574d3bb726cfaa27d8b5768d6f2">ARC_ConsoleBuffer_Clear</a></div><div class="ttdeci">void ARC_ConsoleBuffer_Clear(ARC_ConsoleBuffer *buffer)</div><div class="ttdoc">clears the contents of a ARC_ConsoleBuffer</div></div>
<div class="ttc" id="aconsole_2view_8h_html"><div class="ttname"><a href="../../d6/d7e/console_2view_8h.html">view.h</a></div></div>
<div class="ttc" id="aconsole_2view_8h_html_a518bdb9b27a8304e65e60ec49320b18b"><div class="ttname"><a href="../../d6/d7e/console_2view_8h.html#a518bdb9b27a8304e65e60ec49320b18b">ARC_ConsoleView</a></div><div class="ttdeci">struct ARC_ConsoleView ARC_ConsoleView</div><div class="ttdef"><b>Definition</b> <a href="../../d6/d7e/console_2view_8h_source.html#l00018">view.h:18</a></div></div>
<div class="ttc" id="astring_8h_html"><div class="ttname"><a href="../../da/d66/string_8h.html">string.h</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><!-- 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_beba8fde51bfc57b68b9250b4fe33f5c.html">console</a></li><li class="navelem"><a class="el" href="../../d5/d08/buffer_8h.html">buffer.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>