<!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: iStreamSource 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>iStreamSource Struct Reference<br>
<small>
[<a class="el" href="group__loadsave.html">Loading & Saving support</a>]</small>
</h1><!-- doxytag: class="iStreamSource" --><!-- doxytag: inherits="iBase" -->This interface represents a stream source.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="streamsource_8h-source.html">imap/streamsource.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iStreamSource:</div>
<div class="dynsection">
<p><center><img src="structiStreamSource__inherit__graph.png" border="0" usemap="#iStreamSource__inherit__map" alt="Inheritance graph"></center>
<map name="iStreamSource__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="36,7,92,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiStreamSource-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 bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiStreamSource.html#4c61c2eb0e488a4fb7f93928b1138888">QueryBuffer</a> (const char *id, <a class="el" href="structiStreamDataCallback.html">iStreamDataCallback</a> *callback)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a buffer given an id. <a href="#4c61c2eb0e488a4fb7f93928b1138888"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiStreamSource.html#91900d67152284b6af3b01beae753f92">SaveBuffer</a> (const char *id, <a class="el" href="structiDataBuffer.html">iDataBuffer</a> *buffer)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save a buffer with some id. <a href="#91900d67152284b6af3b01beae753f92"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This interface represents a stream source.
<p>
This can be implemented by the application to implement faster loading of data. Basically the idea is to have some kind of 'id' that represents a buffer for a mesh. This implementation of this interface can try to load the buffer given that id.
<p>Definition at line <a class="el" href="streamsource_8h-source.html#l00051">51</a> of file <a class="el" href="streamsource_8h-source.html">streamsource.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4c61c2eb0e488a4fb7f93928b1138888"></a><!-- doxytag: member="iStreamSource::QueryBuffer" ref="4c61c2eb0e488a4fb7f93928b1138888" args="(const char *id, iStreamDataCallback *callback)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iStreamSource::QueryBuffer </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiStreamDataCallback.html">iStreamDataCallback</a> * </td>
<td class="paramname"> <em>callback</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load a buffer given an id.
<p>
This will fire the callback as soon as the buffer is ready. Note that some implementations that don't support asynchronious loading may call the callback immediatelly from within this function. <dl class="return" compact><dt><b>Returns:</b></dt><dd>false if we can't find the buffer (early error). The error should be placed on the reporter. </dd></dl>
</div>
</div><p>
<a class="anchor" name="91900d67152284b6af3b01beae753f92"></a><!-- doxytag: member="iStreamSource::SaveBuffer" ref="91900d67152284b6af3b01beae753f92" args="(const char *id, iDataBuffer *buffer)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iStreamSource::SaveBuffer </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiDataBuffer.html">iDataBuffer</a> * </td>
<td class="paramname"> <em>buffer</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save a buffer with some id.
<p>
Returns false if the buffer couldn't be saved for some reason. The error should be reported on the reporter by this function.
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>imap/<a class="el" href="streamsource_8h-source.html">streamsource.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
>
3810
