<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: iDataBuffer Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iDataBuffer Struct Reference<br>
<small>
[<a class="el" href="group__util.html">Utilities</a>]</small>
</h1><!-- doxytag: class="iDataBuffer" --><!-- doxytag: inherits="iBase" -->The <a class="el" href="structiDataBuffer.html" title="The iDataBuffer interface can be used to exchange buffers with abstract data between...">iDataBuffer</a> interface can be used to exchange buffers with abstract data between plugins.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="databuff_8h-source.html">iutil/databuff.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iDataBuffer:</div>
<div class="dynsection">
<p><center><img src="structiDataBuffer__inherit__graph.png" border="0" usemap="#iDataBuffer__inherit__map" alt="Inheritance graph"></center>
<map name="iDataBuffer__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< CS::DataBuffer\< Allocator \>, iDataBuffer \>" alt="" coords="256,5,707,32"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csParasiticDataBufferBase, iDataBuffer \>" alt="" coords="263,56,700,83"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="5,31,61,57"><area shape="rect" href="classcsParasiticDataBufferBase.html" title="Base class for pooled and unpooled parasitic data buffer." alt="" coords="755,56,949,83"><area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csParasiticDataBuffer, csParasiticDataBufferBase \>" alt="" coords="1020,31,1545,57"><area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csParasiticDataBufferPooled, csParasiticDataBufferBase \>" alt="" coords="999,81,1567,108"><area shape="rect" href="classcsParasiticDataBuffer.html" title="A databuffer pointing into another databuffer." alt="" coords="1917,31,2080,57"><area shape="rect" href="classscfImplementationPooled.html" title="scfImplementationPooled\< scfImplementationExt0\< csParasiticDataBufferPooled, csParasiticDataBufferBase \> \>" alt="" coords="1617,81,2380,108"><area shape="rect" href="classcsParasiticDataBufferPooled.html" title="A databuffer pointing into another databuffer, pooled version." alt="" coords="2431,81,2636,108"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiDataBuffer-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDataBuffer.html#fa904d74bb662c7384fdfebf585fb4a1">GetData</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the buffer as an abstract pointer. <a href="#fa904d74bb662c7384fdfebf585fb4a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#ge47c588f3ab8c61121c1c7ab7edc47cd">int8</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDataBuffer.html#bca78757222fc5b3ae5ad9e1a9faf330">GetInt8</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get as an int8 *. <a href="#bca78757222fc5b3ae5ad9e1a9faf330"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDataBuffer.html#939ef02696252badf2b5d0d19d3c9012">GetSize</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query the buffer size. <a href="#939ef02696252badf2b5d0d19d3c9012"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDataBuffer.html#773b3fbb4892aae9c2632190eb463833">GetUint8</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get as an uint8 *. <a href="#773b3fbb4892aae9c2632190eb463833"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiDataBuffer.html#945561e89d3bcf1babcd97733b9082ee">operator *</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the buffer as an (char *) pointer. <a href="#945561e89d3bcf1babcd97733b9082ee"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="structiDataBuffer.html" title="The iDataBuffer interface can be used to exchange buffers with abstract data between...">iDataBuffer</a> interface can be used to exchange buffers with abstract data between plugins.
<p>
The object does not care about the contents of the buffer; it just can perform several simple operations on them. The interface is designed to be light-weight, as an alternative to the heavy <a class="el" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a> interface.
<p>Definition at line <a class="el" href="databuff_8h-source.html#l00037">37</a> of file <a class="el" href="databuff_8h-source.html">databuff.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="fa904d74bb662c7384fdfebf585fb4a1"></a><!-- doxytag: member="iDataBuffer::GetData" ref="fa904d74bb662c7384fdfebf585fb4a1" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual char* iDataBuffer::GetData </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the buffer as an abstract pointer.
<p>
<p>Implemented in <a class="el" href="classcsParasiticDataBufferBase.html#45fb374e0fd1661f3784a55d8f152b89">csParasiticDataBufferBase</a>.</p>
<p>Referenced by <a class="el" href="databuf_8h-source.html#l00080">CS::DataBuffer< Allocator >::DataBuffer()</a>, <a class="el" href="databuff_8h-source.html#l00048">GetInt8()</a>, <a class="el" href="databuff_8h-source.html#l00051">GetUint8()</a>, and <a class="el" href="databuff_8h-source.html#l00045">operator *()</a>.</p>
</div>
</div><p>
<a class="anchor" name="bca78757222fc5b3ae5ad9e1a9faf330"></a><!-- doxytag: member="iDataBuffer::GetInt8" ref="bca78757222fc5b3ae5ad9e1a9faf330" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__util.html#ge47c588f3ab8c61121c1c7ab7edc47cd">int8</a>* iDataBuffer::GetInt8 </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get as an int8 *.
<p>
<p>Reimplemented in <a class="el" href="classcsParasiticDataBufferBase.html#e8daf38dc467368ee68fb61762f17ca7">csParasiticDataBufferBase</a>.</p>
<p>Definition at line <a class="el" href="databuff_8h-source.html#l00048">48</a> of file <a class="el" href="databuff_8h-source.html">databuff.h</a>.</p>
<p>References <a class="el" href="structiDataBuffer.html#fa904d74bb662c7384fdfebf585fb4a1">GetData()</a>.</p>
</div>
</div><p>
<a class="anchor" name="939ef02696252badf2b5d0d19d3c9012"></a><!-- doxytag: member="iDataBuffer::GetSize" ref="939ef02696252badf2b5d0d19d3c9012" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t iDataBuffer::GetSize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query the buffer size.
<p>
<p>Implemented in <a class="el" href="classcsParasiticDataBufferBase.html#90f505cef368118c4ca0349f6df0b0a6">csParasiticDataBufferBase</a>.</p>
<p>Referenced by <a class="el" href="parasiticdatabuffer_8h-source.html#l00043">csParasiticDataBufferBase::SetContents()</a>.</p>
</div>
</div><p>
<a class="anchor" name="773b3fbb4892aae9c2632190eb463833"></a><!-- doxytag: member="iDataBuffer::GetUint8" ref="773b3fbb4892aae9c2632190eb463833" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a>* iDataBuffer::GetUint8 </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get as an uint8 *.
<p>
<p>Reimplemented in <a class="el" href="classcsParasiticDataBufferBase.html#8d7db71ef6d7637c7acccbaa58afb2d4">csParasiticDataBufferBase</a>.</p>
<p>Definition at line <a class="el" href="databuff_8h-source.html#l00051">51</a> of file <a class="el" href="databuff_8h-source.html">databuff.h</a>.</p>
<p>References <a class="el" href="structiDataBuffer.html#fa904d74bb662c7384fdfebf585fb4a1">GetData()</a>.</p>
<p>Referenced by <a class="el" href="parasiticdatabuffer_8h-source.html#l00043">csParasiticDataBufferBase::SetContents()</a>.</p>
</div>
</div><p>
<a class="anchor" name="945561e89d3bcf1babcd97733b9082ee"></a><!-- doxytag: member="iDataBuffer::operator *" ref="945561e89d3bcf1babcd97733b9082ee" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* iDataBuffer::operator * </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the buffer as an (char *) pointer.
<p>
<p>Reimplemented in <a class="el" href="classcsParasiticDataBufferBase.html#668bd1dbf5cb2521bd1bb71db6428ead">csParasiticDataBufferBase</a>.</p>
<p>Definition at line <a class="el" href="databuff_8h-source.html#l00045">45</a> of file <a class="el" href="databuff_8h-source.html">databuff.h</a>.</p>
<p>References <a class="el" href="structiDataBuffer.html#fa904d74bb662c7384fdfebf585fb4a1">GetData()</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iutil/<a class="el" href="databuff_8h-source.html">databuff.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
2875
