Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 3891

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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: iTextureList 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&nbsp;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&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>iTextureList Struct Reference<br>
<small>
[<a class="el" href="group__engine3d__textures.html">Textures &amp; Materials</a>]</small>
</h1><!-- doxytag: class="iTextureList" --><!-- doxytag: inherits="iBase" -->This class represents a list of texture wrappers.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="iengine_2texture_8h-source.html">iengine/texture.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iTextureList:</div>
<div class="dynsection">
<p><center><img src="structiTextureList__inherit__graph.png" border="0" usemap="#iTextureList__inherit__map" alt="Inheritance graph"></center>
<map name="iTextureList__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="24,7,80,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiTextureList-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 int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTextureList.html#d69829e0ab17a82641036d42ec02aeaf">Add</a> (<a class="el" href="structiTextureWrapper.html">iTextureWrapper</a> *obj)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add a texture.  <a href="#d69829e0ab17a82641036d42ec02aeaf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTextureList.html#a8087318e337bb00f0f3d4f49dcf6f37">Find</a> (<a class="el" href="structiTextureWrapper.html">iTextureWrapper</a> *obj) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find a texture and return its index.  <a href="#a8087318e337bb00f0f3d4f49dcf6f37"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiTextureWrapper.html">iTextureWrapper</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTextureList.html#4e78c7b3d36ce1f0d27d81ccda66f24f">FindByName</a> (const char *Name) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Find a texture by name.  <a href="#4e78c7b3d36ce1f0d27d81ccda66f24f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiTextureWrapper.html">iTextureWrapper</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTextureList.html#f9693ebed133137f64f7bfad30d72573">Get</a> (int n) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a texture by index.  <a href="#f9693ebed133137f64f7bfad30d72573"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTextureList.html#ce0f9b9d4bbb9a2d9ac8b4f5f4116d90">GetCount</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of textures in this list.  <a href="#ce0f9b9d4bbb9a2d9ac8b4f5f4116d90"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiTextureWrapper.html">iTextureWrapper</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTextureList.html#bc0fafcf2620b968ede889bef03fd306">NewTexture</a> (<a class="el" href="structiTextureHandle.html">iTextureHandle</a> *ith)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a engine wrapper for a pre-prepared <a class="el" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a> The handle will be IncRefed.  <a href="#bc0fafcf2620b968ede889bef03fd306"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiTextureWrapper.html">iTextureWrapper</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTextureList.html#e3f43c9df12b3d9412d1810dd3399ef8">NewTexture</a> (<a class="el" href="structiImage.html">iImage</a> *image)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new texture.  <a href="#e3f43c9df12b3d9412d1810dd3399ef8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTextureList.html#f33e099323a88059e708cadf166ef434">Remove</a> (int n)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove the nth texture.  <a href="#f33e099323a88059e708cadf166ef434"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTextureList.html#7710740c54d82cd8f6cc5bf3034aba26">Remove</a> (<a class="el" href="structiTextureWrapper.html">iTextureWrapper</a> *obj)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove a texture.  <a href="#7710740c54d82cd8f6cc5bf3034aba26"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiTextureList.html#434a7dc6cca9c0cf8bdd2a6011339ee2">RemoveAll</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove all textures.  <a href="#434a7dc6cca9c0cf8bdd2a6011339ee2"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class represents a list of texture wrappers. 
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="structiEngine.html#c2f26b8078a49f84a76166edfd2b35ac" title="Get the list of all textures.">iEngine::GetTextureList()</a> </li></ul>

<p>Definition at line <a class="el" href="iengine_2texture_8h-source.html#l00176">176</a> of file <a class="el" href="iengine_2texture_8h-source.html">texture.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d69829e0ab17a82641036d42ec02aeaf"></a><!-- doxytag: member="iTextureList::Add" ref="d69829e0ab17a82641036d42ec02aeaf" args="(iTextureWrapper *obj)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int iTextureList::Add           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiTextureWrapper.html">iTextureWrapper</a> *&nbsp;</td>
          <td class="paramname"> <em>obj</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a texture. 
<p>

</div>
</div><p>
<a class="anchor" name="a8087318e337bb00f0f3d4f49dcf6f37"></a><!-- doxytag: member="iTextureList::Find" ref="a8087318e337bb00f0f3d4f49dcf6f37" args="(iTextureWrapper *obj) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int iTextureList::Find           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiTextureWrapper.html">iTextureWrapper</a> *&nbsp;</td>
          <td class="paramname"> <em>obj</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Find a texture and return its index. 
<p>

</div>
</div><p>
<a class="anchor" name="4e78c7b3d36ce1f0d27d81ccda66f24f"></a><!-- doxytag: member="iTextureList::FindByName" ref="4e78c7b3d36ce1f0d27d81ccda66f24f" args="(const char *Name) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiTextureWrapper.html">iTextureWrapper</a>* iTextureList::FindByName           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>Name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Find a texture by name. 
<p>

</div>
</div><p>
<a class="anchor" name="f9693ebed133137f64f7bfad30d72573"></a><!-- doxytag: member="iTextureList::Get" ref="f9693ebed133137f64f7bfad30d72573" args="(int n) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiTextureWrapper.html">iTextureWrapper</a>* iTextureList::Get           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>n</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return a texture by index. 
<p>

</div>
</div><p>
<a class="anchor" name="ce0f9b9d4bbb9a2d9ac8b4f5f4116d90"></a><!-- doxytag: member="iTextureList::GetCount" ref="ce0f9b9d4bbb9a2d9ac8b4f5f4116d90" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int iTextureList::GetCount           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the number of textures in this list. 
<p>

</div>
</div><p>
<a class="anchor" name="bc0fafcf2620b968ede889bef03fd306"></a><!-- doxytag: member="iTextureList::NewTexture" ref="bc0fafcf2620b968ede889bef03fd306" args="(iTextureHandle *ith)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiTextureWrapper.html">iTextureWrapper</a>* iTextureList::NewTexture           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiTextureHandle.html">iTextureHandle</a> *&nbsp;</td>
          <td class="paramname"> <em>ith</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a engine wrapper for a pre-prepared <a class="el" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a> The handle will be IncRefed. 
<p>

</div>
</div><p>
<a class="anchor" name="e3f43c9df12b3d9412d1810dd3399ef8"></a><!-- doxytag: member="iTextureList::NewTexture" ref="e3f43c9df12b3d9412d1810dd3399ef8" args="(iImage *image)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiTextureWrapper.html">iTextureWrapper</a>* iTextureList::NewTexture           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiImage.html">iImage</a> *&nbsp;</td>
          <td class="paramname"> <em>image</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a new texture. 
<p>

</div>
</div><p>
<a class="anchor" name="f33e099323a88059e708cadf166ef434"></a><!-- doxytag: member="iTextureList::Remove" ref="f33e099323a88059e708cadf166ef434" args="(int n)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iTextureList::Remove           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>n</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Remove the nth texture. 
<p>

</div>
</div><p>
<a class="anchor" name="7710740c54d82cd8f6cc5bf3034aba26"></a><!-- doxytag: member="iTextureList::Remove" ref="7710740c54d82cd8f6cc5bf3034aba26" args="(iTextureWrapper *obj)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iTextureList::Remove           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiTextureWrapper.html">iTextureWrapper</a> *&nbsp;</td>
          <td class="paramname"> <em>obj</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Remove a texture. 
<p>

</div>
</div><p>
<a class="anchor" name="434a7dc6cca9c0cf8bdd2a6011339ee2"></a><!-- doxytag: member="iTextureList::RemoveAll" ref="434a7dc6cca9c0cf8bdd2a6011339ee2" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iTextureList::RemoveAll           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Remove all textures. 
<p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iengine/<a class="el" href="iengine_2texture_8h-source.html">texture.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>