Sophie

Sophie

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

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: iMaterial 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>iMaterial Struct Reference<br>
<small>
[<a class="el" href="group__gfx3d.html">3D</a>]</small>
</h1><!-- doxytag: class="iMaterial" --><!-- doxytag: inherits="iShaderVariableContext" -->This class represents a material as seen from the engine view.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="ivideo_2material_8h-source.html">ivideo/material.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iMaterial:</div>
<div class="dynsection">
<p><center><img src="structiMaterial__inherit__graph.png" border="0" usemap="#iMaterial__inherit__map" alt="Inheritance graph"></center>
<map name="iMaterial__inherit__map">
<area shape="rect" href="structiShaderVariableContext.html" title="This is a baseclass for all interfaces which provides shadervariables both dynamically..." alt="" coords="5,84,179,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="64,7,120,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiMaterial-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 <a class="el" href="structiShader.html">iShader</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMaterial.html#f6ee57ee9e7d94be1cb5b51a954a8f49">GetShader</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> type)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get shader associated with a shader type.  <a href="#f6ee57ee9e7d94be1cb5b51a954a8f49"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classcsHash.html">csHash</a><br>
&lt; <a class="el" href="classcsRef.html">csRef</a>&lt; <a class="el" href="structiShader.html">iShader</a> &gt;,<br>
 <a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMaterial.html#563ae6005794891a39a9cff1d2d8fc00">GetShaders</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get all Shaders.  <a href="#563ae6005794891a39a9cff1d2d8fc00"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiTextureHandle.html">iTextureHandle</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMaterial.html#eb47c8de1aba19e372fa47fd03df14ac">GetTexture</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> name)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a texture from the material.  <a href="#eb47c8de1aba19e372fa47fd03df14ac"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiTextureHandle.html">iTextureHandle</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiMaterial.html#200fa30b7715534920b0dec53cb3f92e">GetTexture</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the base ("tex diffuse") texture from the material.  <a href="#200fa30b7715534920b0dec53cb3f92e"></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="structiMaterial.html#6103e8eeb332277a095300bac543197f">SetShader</a> (<a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a> type, <a class="el" href="structiShader.html">iShader</a> *shader)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Associate a shader with a shader type.  <a href="#6103e8eeb332277a095300bac543197f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class represents a material as seen from the engine view. 
<p>
Because it is also a shader variable context it can be used directly for rendering.<p>
Main creators of instances implementing this interface:<ul>
<li><a class="el" href="structiEngine.html#ac6bb2647e8b14f3c283bb795303383d" title="Create a base material that can be used to give to the texture manager.">iEngine::CreateBaseMaterial()</a></li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="structiMaterialWrapper.html#bef1b083ee25e6ba31b945366e06513f" title="Get the original material.">iMaterialWrapper::GetMaterial()</a></li></ul>
<p>
Main users of this interface:<ul>
<li>3D renderer implementations (<a class="el" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>). </li></ul>

<p>Definition at line <a class="el" href="ivideo_2material_8h-source.html#l00057">57</a> of file <a class="el" href="ivideo_2material_8h-source.html">material.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f6ee57ee9e7d94be1cb5b51a954a8f49"></a><!-- doxytag: member="iMaterial::GetShader" ref="f6ee57ee9e7d94be1cb5b51a954a8f49" args="(csStringID type)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiShader.html">iShader</a>* iMaterial::GetShader           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a>&nbsp;</td>
          <td class="paramname"> <em>type</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get shader associated with a shader type. 
<p>

</div>
</div><p>
<a class="anchor" name="563ae6005794891a39a9cff1d2d8fc00"></a><!-- doxytag: member="iMaterial::GetShaders" ref="563ae6005794891a39a9cff1d2d8fc00" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="classcsHash.html">csHash</a>&lt;<a class="el" href="classcsRef.html">csRef</a>&lt;<a class="el" href="structiShader.html">iShader</a>&gt;, <a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a>&gt;&amp; iMaterial::GetShaders           </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>
Get all Shaders. 
<p>

</div>
</div><p>
<a class="anchor" name="eb47c8de1aba19e372fa47fd03df14ac"></a><!-- doxytag: member="iMaterial::GetTexture" ref="eb47c8de1aba19e372fa47fd03df14ac" args="(csStringID name)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiTextureHandle.html">iTextureHandle</a>* iMaterial::GetTexture           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a>&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a texture from the material. 
<p>

</div>
</div><p>
<a class="anchor" name="200fa30b7715534920b0dec53cb3f92e"></a><!-- doxytag: member="iMaterial::GetTexture" ref="200fa30b7715534920b0dec53cb3f92e" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structiTextureHandle.html">iTextureHandle</a>* iMaterial::GetTexture           </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>
Get the base ("tex diffuse") texture from the material. 
<p>

</div>
</div><p>
<a class="anchor" name="6103e8eeb332277a095300bac543197f"></a><!-- doxytag: member="iMaterial::SetShader" ref="6103e8eeb332277a095300bac543197f" args="(csStringID type, iShader *shader)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iMaterial::SetShader           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__util.html#gbe4f44c93bfeee85c507a999dccf21dd">csStringID</a>&nbsp;</td>
          <td class="paramname"> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structiShader.html">iShader</a> *&nbsp;</td>
          <td class="paramname"> <em>shader</em></td><td>&nbsp;</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>
Associate a shader with a shader type. 
<p>

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