<!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: csParasiticDataBufferBase Class 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>csParasiticDataBufferBase Class Reference</h1><!-- doxytag: class="csParasiticDataBufferBase" --><!-- doxytag: inherits="scfImplementation1< csParasiticDataBufferBase, iDataBuffer >" -->Base class for pooled and unpooled parasitic data buffer. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="parasiticdatabuffer_8h-source.html">csutil/parasiticdatabuffer.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for csParasiticDataBufferBase:</div> <div class="dynsection"> <p><center><img src="classcsParasiticDataBufferBase__inherit__graph.png" border="0" usemap="#csParasiticDataBufferBase__inherit__map" alt="Inheritance graph"></center> <map name="csParasiticDataBufferBase__inherit__map"> <area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csParasiticDataBuffer, csParasiticDataBufferBase \>" alt="" coords="1420,5,1945,32"><area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\< csParasiticDataBufferPooled, csParasiticDataBufferBase \>" alt="" coords="1399,56,1967,83"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csParasiticDataBufferBase, iDataBuffer \>" alt="" coords="669,31,1107,57"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csParasiticDataBufferBase \>" alt="" coords="276,5,620,32"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="88,56,144,83"><area shape="rect" href="structiDataBuffer.html" title="The iDataBuffer interface can be used to exchange buffers with abstract data between..." alt="" coords="400,56,496,83"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="5,5,227,32"><area shape="rect" href="classcsParasiticDataBuffer.html" title="A databuffer pointing into another databuffer." alt="" coords="2317,5,2480,32"><area shape="rect" href="classscfImplementationPooled.html" title="scfImplementationPooled\< scfImplementationExt0\< csParasiticDataBufferPooled, csParasiticDataBufferBase \> \>" alt="" coords="2017,56,2780,83"><area shape="rect" href="classcsParasiticDataBufferPooled.html" title="A databuffer pointing into another databuffer, pooled version." alt="" coords="2831,56,3036,83"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="classcsParasiticDataBufferBase-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="classcsParasiticDataBufferBase.html#45fb374e0fd1661f3784a55d8f152b89">GetData</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the buffer as an abstract pointer. <a href="#45fb374e0fd1661f3784a55d8f152b89"></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="classcsParasiticDataBufferBase.html#e8daf38dc467368ee68fb61762f17ca7">GetInt8</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get as an int8 *. <a href="#e8daf38dc467368ee68fb61762f17ca7"></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="classcsParasiticDataBufferBase.html#90f505cef368118c4ca0349f6df0b0a6">GetSize</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Query the buffer size. <a href="#90f505cef368118c4ca0349f6df0b0a6"></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="classcsParasiticDataBufferBase.html#8d7db71ef6d7637c7acccbaa58afb2d4">GetUint8</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get as an uint8 *. <a href="#8d7db71ef6d7637c7acccbaa58afb2d4"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsParasiticDataBufferBase.html#668bd1dbf5cb2521bd1bb71db6428ead">operator *</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the buffer as an (char *) pointer. <a href="#668bd1dbf5cb2521bd1bb71db6428ead"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1ed9f963a509603f9b63543ba82a67c6"></a><!-- doxytag: member="csParasiticDataBufferBase::~csParasiticDataBufferBase" ref="1ed9f963a509603f9b63543ba82a67c6" args="()" --> virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsParasiticDataBufferBase.html#1ed9f963a509603f9b63543ba82a67c6">~csParasiticDataBufferBase</a> ()</td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="58d49fa2340bd6695baf60261903d058"></a><!-- doxytag: member="csParasiticDataBufferBase::csParasiticDataBufferBase" ref="58d49fa2340bd6695baf60261903d058" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsParasiticDataBufferBase.html#58d49fa2340bd6695baf60261903d058">csParasiticDataBufferBase</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5092bc0c8793aa8782863cef9ff8e1a2"></a><!-- doxytag: member="csParasiticDataBufferBase::csParasiticDataBufferBase" ref="5092bc0c8793aa8782863cef9ff8e1a2" args="(iDataBuffer *parent, size_t offs, size_t size=(size_t)~0)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsParasiticDataBufferBase.html#5092bc0c8793aa8782863cef9ff8e1a2">csParasiticDataBufferBase</a> (<a class="el" href="structiDataBuffer.html">iDataBuffer</a> *parent, size_t offs, size_t <a class="el" href="classcsParasiticDataBufferBase.html#fa541c28f62eaab7fec49b887091aa59">size</a>=(size_t)~0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e848878871cad422cb78ca1d65e9a593"></a><!-- doxytag: member="csParasiticDataBufferBase::SetContents" ref="e848878871cad422cb78ca1d65e9a593" args="(iDataBuffer *parent, size_t offs, size_t size)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsParasiticDataBufferBase.html#e848878871cad422cb78ca1d65e9a593">SetContents</a> (<a class="el" href="structiDataBuffer.html">iDataBuffer</a> *parent, size_t offs, size_t <a class="el" href="classcsParasiticDataBufferBase.html#fa541c28f62eaab7fec49b887091aa59">size</a>)</td></tr> <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2c98bd38e90c54fe57611b1ca617163d"></a><!-- doxytag: member="csParasiticDataBufferBase::data" ref="2c98bd38e90c54fe57611b1ca617163d" args="" --> <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsParasiticDataBufferBase.html#2c98bd38e90c54fe57611b1ca617163d">data</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b14a0049bdcb4ed1ff88f55c44f7f212"></a><!-- doxytag: member="csParasiticDataBufferBase::parentBuffer" ref="b14a0049bdcb4ed1ff88f55c44f7f212" args="" --> <a class="el" href="classcsRef.html">csRef</a>< <a class="el" href="structiDataBuffer.html">iDataBuffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsParasiticDataBufferBase.html#b14a0049bdcb4ed1ff88f55c44f7f212">parentBuffer</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fa541c28f62eaab7fec49b887091aa59"></a><!-- doxytag: member="csParasiticDataBufferBase::size" ref="fa541c28f62eaab7fec49b887091aa59" args="" --> size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsParasiticDataBufferBase.html#fa541c28f62eaab7fec49b887091aa59">size</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Base class for pooled and unpooled parasitic data buffer. <p>Definition at line <a class="el" href="parasiticdatabuffer_8h-source.html#l00035">35</a> of file <a class="el" href="parasiticdatabuffer_8h-source.html">parasiticdatabuffer.h</a>.</p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="45fb374e0fd1661f3784a55d8f152b89"></a><!-- doxytag: member="csParasiticDataBufferBase::GetData" ref="45fb374e0fd1661f3784a55d8f152b89" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual char* csParasiticDataBufferBase::GetData </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the buffer as an abstract pointer. <p> <p>Implements <a class="el" href="structiDataBuffer.html#fa904d74bb662c7384fdfebf585fb4a1">iDataBuffer</a>.</p> <p>Definition at line <a class="el" href="parasiticdatabuffer_8h-source.html#l00068">68</a> of file <a class="el" href="parasiticdatabuffer_8h-source.html">parasiticdatabuffer.h</a>.</p> <p>References <a class="el" href="parasiticdatabuffer_8h-source.html#l00040">data</a>.</p> <p>Referenced by <a class="el" href="parasiticdatabuffer_8h-source.html#l00072">GetInt8()</a>, <a class="el" href="parasiticdatabuffer_8h-source.html#l00074">GetUint8()</a>, and <a class="el" href="parasiticdatabuffer_8h-source.html#l00070">operator *()</a>.</p> </div> </div><p> <a class="anchor" name="e8daf38dc467368ee68fb61762f17ca7"></a><!-- doxytag: member="csParasiticDataBufferBase::GetInt8" ref="e8daf38dc467368ee68fb61762f17ca7" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__util.html#ge47c588f3ab8c61121c1c7ab7edc47cd">int8</a>* csParasiticDataBufferBase::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 from <a class="el" href="structiDataBuffer.html#bca78757222fc5b3ae5ad9e1a9faf330">iDataBuffer</a>.</p> <p>Definition at line <a class="el" href="parasiticdatabuffer_8h-source.html#l00072">72</a> of file <a class="el" href="parasiticdatabuffer_8h-source.html">parasiticdatabuffer.h</a>.</p> <p>References <a class="el" href="parasiticdatabuffer_8h-source.html#l00068">GetData()</a>.</p> </div> </div><p> <a class="anchor" name="90f505cef368118c4ca0349f6df0b0a6"></a><!-- doxytag: member="csParasiticDataBufferBase::GetSize" ref="90f505cef368118c4ca0349f6df0b0a6" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual size_t csParasiticDataBufferBase::GetSize </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Query the buffer size. <p> <p>Implements <a class="el" href="structiDataBuffer.html#939ef02696252badf2b5d0d19d3c9012">iDataBuffer</a>.</p> <p>Definition at line <a class="el" href="parasiticdatabuffer_8h-source.html#l00066">66</a> of file <a class="el" href="parasiticdatabuffer_8h-source.html">parasiticdatabuffer.h</a>.</p> <p>References <a class="el" href="parasiticdatabuffer_8h-source.html#l00041">size</a>.</p> </div> </div><p> <a class="anchor" name="8d7db71ef6d7637c7acccbaa58afb2d4"></a><!-- doxytag: member="csParasiticDataBufferBase::GetUint8" ref="8d7db71ef6d7637c7acccbaa58afb2d4" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a>* csParasiticDataBufferBase::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 from <a class="el" href="structiDataBuffer.html#773b3fbb4892aae9c2632190eb463833">iDataBuffer</a>.</p> <p>Definition at line <a class="el" href="parasiticdatabuffer_8h-source.html#l00074">74</a> of file <a class="el" href="parasiticdatabuffer_8h-source.html">parasiticdatabuffer.h</a>.</p> <p>References <a class="el" href="parasiticdatabuffer_8h-source.html#l00068">GetData()</a>.</p> </div> </div><p> <a class="anchor" name="668bd1dbf5cb2521bd1bb71db6428ead"></a><!-- doxytag: member="csParasiticDataBufferBase::operator *" ref="668bd1dbf5cb2521bd1bb71db6428ead" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">char* csParasiticDataBufferBase::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 from <a class="el" href="structiDataBuffer.html#945561e89d3bcf1babcd97733b9082ee">iDataBuffer</a>.</p> <p>Definition at line <a class="el" href="parasiticdatabuffer_8h-source.html#l00070">70</a> of file <a class="el" href="parasiticdatabuffer_8h-source.html">parasiticdatabuffer.h</a>.</p> <p>References <a class="el" href="parasiticdatabuffer_8h-source.html#l00068">GetData()</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>csutil/<a class="el" href="parasiticdatabuffer_8h-source.html">parasiticdatabuffer.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>