<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audaspace: Buffer Class 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="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" />
</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">Audaspace
 <span id="projectnumber">1.3.0</span>
</div>
<div id="projectbrief">A high level audio library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classBuffer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Buffer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class is a simple buffer in RAM which is 32 Byte aligned and provides resize functionality.
<a href="classBuffer.html#details">More...</a></p>
<p><code>#include <<a class="el" href="Buffer_8h_source.html">Buffer.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Buffer:</div>
<div class="dyncontent">
<div class="center"><img src="classBuffer__inherit__graph.png" border="0" usemap="#Buffer_inherit__map" alt="Inheritance graph"/></div>
<map name="Buffer_inherit__map" id="Buffer_inherit__map">
<area shape="rect" title="This class is a simple buffer in RAM which is 32 Byte aligned and provides resize functionality." alt="" coords="51,5,110,32"/>
<area shape="rect" href="classAnimateableProperty.html" title="This class saves animation data for float properties." alt="" coords="5,80,156,107"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a107a6350a44e026306fb6c94a427ab55"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBuffer.html#a107a6350a44e026306fb6c94a427ab55">Buffer</a> (int size=0)</td></tr>
<tr class="memdesc:a107a6350a44e026306fb6c94a427ab55"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new buffer. <a href="#a107a6350a44e026306fb6c94a427ab55">More...</a><br /></td></tr>
<tr class="separator:a107a6350a44e026306fb6c94a427ab55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59b8743e4a5f731bdd0c4185c9ef263b"><td class="memItemLeft" align="right" valign="top"><a id="a59b8743e4a5f731bdd0c4185c9ef263b"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classBuffer.html#a59b8743e4a5f731bdd0c4185c9ef263b">~Buffer</a> ()</td></tr>
<tr class="memdesc:a59b8743e4a5f731bdd0c4185c9ef263b"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the buffer. <br /></td></tr>
<tr class="separator:a59b8743e4a5f731bdd0c4185c9ef263b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39e20d6741a24980d3cb988ae078eaba"><td class="memItemLeft" align="right" valign="top"><a id="a39e20d6741a24980d3cb988ae078eaba"></a>
<a class="el" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classBuffer.html#a39e20d6741a24980d3cb988ae078eaba">getBuffer</a> () const</td></tr>
<tr class="memdesc:a39e20d6741a24980d3cb988ae078eaba"><td class="mdescLeft"> </td><td class="mdescRight">Returns the pointer to the buffer in memory. <br /></td></tr>
<tr class="separator:a39e20d6741a24980d3cb988ae078eaba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f38e7e96d97aaf224d711ba6a6ddf80"><td class="memItemLeft" align="right" valign="top"><a id="a2f38e7e96d97aaf224d711ba6a6ddf80"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classBuffer.html#a2f38e7e96d97aaf224d711ba6a6ddf80">getSize</a> () const</td></tr>
<tr class="memdesc:a2f38e7e96d97aaf224d711ba6a6ddf80"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of the buffer in bytes. <br /></td></tr>
<tr class="separator:a2f38e7e96d97aaf224d711ba6a6ddf80"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab12d3ea518d10e03f8fb83247c913a0e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBuffer.html#ab12d3ea518d10e03f8fb83247c913a0e">resize</a> (int size, bool keep=false)</td></tr>
<tr class="memdesc:ab12d3ea518d10e03f8fb83247c913a0e"><td class="mdescLeft"> </td><td class="mdescRight">Resizes the buffer. <a href="#ab12d3ea518d10e03f8fb83247c913a0e">More...</a><br /></td></tr>
<tr class="separator:ab12d3ea518d10e03f8fb83247c913a0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ff33fb43ce68bde563260e31670c4b1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBuffer.html#a8ff33fb43ce68bde563260e31670c4b1">assureSize</a> (int size, bool keep=false)</td></tr>
<tr class="memdesc:a8ff33fb43ce68bde563260e31670c4b1"><td class="mdescLeft"> </td><td class="mdescRight">Makes sure the buffer has a minimum size. <a href="#a8ff33fb43ce68bde563260e31670c4b1">More...</a><br /></td></tr>
<tr class="separator:a8ff33fb43ce68bde563260e31670c4b1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class is a simple buffer in RAM which is 32 Byte aligned and provides resize functionality. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a107a6350a44e026306fb6c94a427ab55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a107a6350a44e026306fb6c94a427ab55">◆ </a></span>Buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Buffer::Buffer </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>The size of the buffer in bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8ff33fb43ce68bde563260e31670c4b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ff33fb43ce68bde563260e31670c4b1">◆ </a></span>assureSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Buffer::assureSize </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>keep</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes sure the buffer has a minimum size. </p>
<p>If size is >= current size, nothing will happen. Otherwise the buffer is resized with keep as parameter. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>The new minimum size of the buffer, measured in bytes. </td></tr>
<tr><td class="paramname">keep</td><td>Whether to keep the old data. If the new buffer is smaller, the data at the end will be lost. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab12d3ea518d10e03f8fb83247c913a0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab12d3ea518d10e03f8fb83247c913a0e">◆ </a></span>resize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Buffer::resize </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>keep</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resizes the buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>The new size of the buffer, measured in bytes. </td></tr>
<tr><td class="paramname">keep</td><td>Whether to keep the old data. If the new buffer is smaller, the data at the end will be lost. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>util/<a class="el" href="Buffer_8h_source.html">Buffer.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
4f48f620eaa1d8b8f904a92a0540d40f
>
files
>
847
