493 lines
27 KiB
HTML
493 lines
27 KiB
HTML
|
<!-- 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"> 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&dn=expat.txt MIT */
|
||
|
|
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&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> |
|
||
|
|
<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 <stdint.h></code><br />
|
||
|
|
<code>#include "<a class="el" href="../../d6/d7e/console_2view_8h_source.html">arc/console/view.h</a>"</code><br />
|
||
|
|
<code>#include "<a class="el" href="../../da/d66/string_8h_source.html">arc/std/string.h</a>"</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> </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"> </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 </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"> </td><td class="mdescRight">creates ARC_ConsoleBuffer type <br /></td></tr>
|
||
|
|
<tr class="separator:a724aa56dd933bc31502a971204467132"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab2a88c30d33e6d3120d98673fd6beec4" id="r_ab2a88c30d33e6d3120d98673fd6beec4"><td class="memItemLeft" align="right" valign="top">void </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"> </td><td class="mdescRight">destroys ARC_ConsoleBuffer type <br /></td></tr>
|
||
|
|
<tr class="separator:ab2a88c30d33e6d3120d98673fd6beec4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:acdc2d574d3bb726cfaa27d8b5768d6f2" id="r_acdc2d574d3bb726cfaa27d8b5768d6f2"><td class="memItemLeft" align="right" valign="top">void </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"> </td><td class="mdescRight">clears the contents of a ARC_ConsoleBuffer <br /></td></tr>
|
||
|
|
<tr class="separator:acdc2d574d3bb726cfaa27d8b5768d6f2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a46ebb41d45ba5aeafa12372f69539458" id="r_a46ebb41d45ba5aeafa12372f69539458"><td class="memItemLeft" align="right" valign="top">void </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"> </td><td class="mdescRight">renders a buffer to a ARC_ConsoleView <br /></td></tr>
|
||
|
|
<tr class="separator:a46ebb41d45ba5aeafa12372f69539458"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a64f378c7d29c6166dcceb4fe90235f14" id="r_a64f378c7d29c6166dcceb4fe90235f14"><td class="memItemLeft" align="right" valign="top">void </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"> </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"> </td></tr>
|
||
|
|
<tr class="memitem:a18ea5885eb623af1ad0bce81886a37ba" id="r_a18ea5885eb623af1ad0bce81886a37ba"><td class="memItemLeft" align="right" valign="top">void </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"> </td><td class="mdescRight">adds a character to the buffer <br /></td></tr>
|
||
|
|
<tr class="separator:a18ea5885eb623af1ad0bce81886a37ba"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa7c09f28e004665675ad529c457f0d19" id="r_aa7c09f28e004665675ad529c457f0d19"><td class="memItemLeft" align="right" valign="top">void </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"> </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"> </td></tr>
|
||
|
|
<tr class="memitem:a87db4e45040059ec8452ae4ed4c9d93c" id="r_a87db4e45040059ec8452ae4ed4c9d93c"><td class="memItemLeft" align="right" valign="top">void </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"> </td><td class="mdescRight">adds a cstring to the buffer <br /></td></tr>
|
||
|
|
<tr class="separator:a87db4e45040059ec8452ae4ed4c9d93c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5c3fbf33ecfa1adae24ee628bccaf64e" id="r_a5c3fbf33ecfa1adae24ee628bccaf64e"><td class="memItemLeft" align="right" valign="top">void </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"> </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"> </td></tr>
|
||
|
|
<tr class="memitem:a590db008192631b4cfc9c53904687018" id="r_a590db008192631b4cfc9c53904687018"><td class="memItemLeft" align="right" valign="top">uint32_t </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"> </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"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
||
|
|
<a id="a04647685671d3c7dbb760fcd1413f7e6" name="a04647685671d3c7dbb760fcd1413f7e6"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a04647685671d3c7dbb760fcd1413f7e6">◆ </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">◆ </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> )</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">◆ </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> )</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">◆ </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> )</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">◆ </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> )</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">◆ </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">◆ </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">◆ </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">◆ </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">◆ </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> )</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">◆ </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> )</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>
|