<html>
<head>
<title>Cal3D: CalRenderer Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table width="100%" border="0" cellspacing="0" cellpadding="5" align="center">
<tr>
<td class="md" align="center">
<small>
<b>- Cal3D 0.11 API Reference -</b>
</small>
</td>
</tr>
</table>
<br>
<!-- Generated by Doxygen 1.7.3 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>CalRenderer Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="CalRenderer" -->
<p><a href="classCalRenderer-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#aa78ac07d96d5d4051c2cb522de4e0267">CalRenderer</a> (<a class="el" href="classCalModel.html">CalModel</a> *pModel)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the renderer instance. <a href="#aa78ac07d96d5d4051c2cb522de4e0267"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a6b04fc61c87debc6b62c56289d1880dd">CalRenderer</a> (<a class="el" href="classCalRenderer.html">CalRenderer</a> *pRenderer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy-constructor for the renderer instance. <a href="#a6b04fc61c87debc6b62c56289d1880dd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#ad3d149bdc55ef5891b9e643b0e3d51ab">beginRendering</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes the rendering query phase. <a href="#ad3d149bdc55ef5891b9e643b0e3d51ab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a044ed875bcfcb8cd010e2fdeb7c36e5c">endRendering</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finishes the rendering query phase. <a href="#a044ed875bcfcb8cd010e2fdeb7c36e5c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a489d8bd747e8169986788e354aa843c9">getAmbientColor</a> (unsigned char *pColorBuffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the ambient color. <a href="#a489d8bd747e8169986788e354aa843c9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#ae9f4078253ec34f0c058dd6e42bfc5e0">getDiffuseColor</a> (unsigned char *pColorBuffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the diffuse color. <a href="#ae9f4078253ec34f0c058dd6e42bfc5e0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#acfd31b7550f4b249b3d45d4fcb163157">getFaceCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of faces. <a href="#acfd31b7550f4b249b3d45d4fcb163157"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a02ac0eb4d493105b6909c99b930121d7">getFaces</a> (CalIndex *pFaceBuffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the face data. <a href="#a02ac0eb4d493105b6909c99b930121d7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a0f75fd9dd63f0e788d3d8abc27d960fc">getMapCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of maps. <a href="#a0f75fd9dd63f0e788d3d8abc27d960fc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Cal::UserData </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#ae1f5c03a210f5473137a388d49a161ad">getMapUserData</a> (int mapId)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to a specified map user data. <a href="#ae1f5c03a210f5473137a388d49a161ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#ac992b85a611724351cb5d1c02e7a7920">getMeshCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of attached meshes. <a href="#ac992b85a611724351cb5d1c02e7a7920"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a264e0f4b518e6e0e551c5e582f803728">getNormals</a> (float *pNormalBuffer, int stride=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the normal data. <a href="#a264e0f4b518e6e0e551c5e582f803728"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#ab013d95f90c0475eb89981b487774a30">getShininess</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the shininess factor. <a href="#ab013d95f90c0475eb89981b487774a30"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a269d35a0e36dbab40b3eb81b1102d687">getSpecularColor</a> (unsigned char *pColorBuffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the specular color. <a href="#a269d35a0e36dbab40b3eb81b1102d687"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#aa75bc37a240c536f3467c4280e9a3fed">getSubmeshCount</a> (int meshId)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of submeshes. <a href="#aa75bc37a240c536f3467c4280e9a3fed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a7b7bb1917049bac48d495fc124f8bfe5">getTextureCoordinates</a> (int mapId, float *pTextureCoordinateBuffer, int stride=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the texture coordinate data. <a href="#a7b7bb1917049bac48d495fc124f8bfe5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#ae7e3a1998c518ad17e9d7a4dea0e89ec">getVertexCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of vertices. <a href="#ae7e3a1998c518ad17e9d7a4dea0e89ec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a528cf5f6646954849a9ba410a4d26578">getVertices</a> (float *pVertexBuffer, int stride=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the vertex data. <a href="#a528cf5f6646954849a9ba410a4d26578"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#adef90b4961037ef84de16163fef1eb75">getTangentSpaces</a> (int mapId, float *pTangentSpaceBuffer, int stride=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the tangent space data. <a href="#adef90b4961037ef84de16163fef1eb75"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a0a5bbe6f436ca8fdd250dad94e466166">getVerticesAndNormals</a> (float *pVertexBuffer, int stride=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the submesh data. <a href="#a0a5bbe6f436ca8fdd250dad94e466166"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#a66959d79e408c494844f782d6b44230f">getVerticesNormalsAndTexCoords</a> (float *pVertexBuffer, int NumTexCoords=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the submesh data. <a href="#a66959d79e408c494844f782d6b44230f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#acb840ece54d3daf934ac393ca360041f">isTangentsEnabled</a> (int mapId)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns if tangent are enabled. <a href="#acb840ece54d3daf934ac393ca360041f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#ad6e008adb4c63863076a3baf1934ba02">selectMeshSubmesh</a> (int meshId, int submeshId)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Selects a mesh/submesh for rendering data queries. <a href="#ad6e008adb4c63863076a3baf1934ba02"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCalRenderer.html#aaf319142738931b75685e9c7d07385ee">setNormalization</a> (bool normalize)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the normalization flag to true or false. <a href="#aaf319142738931b75685e9c7d07385ee"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa78ac07d96d5d4051c2cb522de4e0267"></a><!-- doxytag: member="CalRenderer::CalRenderer" ref="aa78ac07d96d5d4051c2cb522de4e0267" args="(CalModel *pModel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalRenderer::CalRenderer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCalModel.html">CalModel</a> * </td>
<td class="paramname"><em>pModel</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs the renderer instance. </p>
<p>This function is the default constructor of the renderer instance. </p>
</div>
</div>
<a class="anchor" id="a6b04fc61c87debc6b62c56289d1880dd"></a><!-- doxytag: member="CalRenderer::CalRenderer" ref="a6b04fc61c87debc6b62c56289d1880dd" args="(CalRenderer *pRenderer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CalRenderer::CalRenderer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCalRenderer.html">CalRenderer</a> * </td>
<td class="paramname"><em>pRenderer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy-constructor for the renderer instance. </p>
<p>This function is the copy constructor of the renderer instance. This is useful for multi-pipe parallel rendering. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad3d149bdc55ef5891b9e643b0e3d51ab"></a><!-- doxytag: member="CalRenderer::beginRendering" ref="ad3d149bdc55ef5891b9e643b0e3d51ab" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalRenderer::beginRendering </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initializes the rendering query phase. </p>
<p>This function initializes the rendering query phase. It must be called before any rendering queries are executed. </p>
</div>
</div>
<a class="anchor" id="a044ed875bcfcb8cd010e2fdeb7c36e5c"></a><!-- doxytag: member="CalRenderer::endRendering" ref="a044ed875bcfcb8cd010e2fdeb7c36e5c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalRenderer::endRendering </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finishes the rendering query phase. </p>
<p>This function finishes the rendering query phase. It must be called after all rendering queries have been executed. </p>
</div>
</div>
<a class="anchor" id="a489d8bd747e8169986788e354aa843c9"></a><!-- doxytag: member="CalRenderer::getAmbientColor" ref="a489d8bd747e8169986788e354aa843c9" args="(unsigned char *pColorBuffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalRenderer::getAmbientColor </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>pColorBuffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the ambient color. </p>
<p>This function returns the ambient color of the material of the selected mesh/submesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pColorBuffer</td><td>A pointer to the user-provided buffer where the color data is written to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae9f4078253ec34f0c058dd6e42bfc5e0"></a><!-- doxytag: member="CalRenderer::getDiffuseColor" ref="ae9f4078253ec34f0c058dd6e42bfc5e0" args="(unsigned char *pColorBuffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalRenderer::getDiffuseColor </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>pColorBuffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the diffuse color. </p>
<p>This function returns the diffuse color of the material of the selected mesh/submesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pColorBuffer</td><td>A pointer to the user-provided buffer where the color data is written to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acfd31b7550f4b249b3d45d4fcb163157"></a><!-- doxytag: member="CalRenderer::getFaceCount" ref="acfd31b7550f4b249b3d45d4fcb163157" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getFaceCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of faces. </p>
<p>This function returns the number of faces in the selected mesh/submesh.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of faces. </dd></dl>
</div>
</div>
<a class="anchor" id="a02ac0eb4d493105b6909c99b930121d7"></a><!-- doxytag: member="CalRenderer::getFaces" ref="a02ac0eb4d493105b6909c99b930121d7" args="(CalIndex *pFaceBuffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getFaces </td>
<td>(</td>
<td class="paramtype">CalIndex * </td>
<td class="paramname"><em>pFaceBuffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the face data. </p>
<p>This function returns the face data (vertex indices) of the selected mesh/submesh. The LOD setting is taken into account.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pFaceBuffer</td><td>A pointer to the user-provided buffer where the face data is written to.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of faces written to the buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a0f75fd9dd63f0e788d3d8abc27d960fc"></a><!-- doxytag: member="CalRenderer::getMapCount" ref="a0f75fd9dd63f0e788d3d8abc27d960fc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getMapCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of maps. </p>
<p>This function returns the number of maps in the selected mesh/submesh.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of maps. </dd></dl>
</div>
</div>
<a class="anchor" id="ae1f5c03a210f5473137a388d49a161ad"></a><!-- doxytag: member="CalRenderer::getMapUserData" ref="ae1f5c03a210f5473137a388d49a161ad" args="(int mapId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cal::UserData CalRenderer::getMapUserData </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>mapId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to a specified map user data. </p>
<p>This function returns the user data stored in the specified map of the material of the selected mesh/submesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">mapId</td><td>The ID of the map.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li>the user data stored in the specified map </li>
<li><b>0</b> if an error happend </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="ac992b85a611724351cb5d1c02e7a7920"></a><!-- doxytag: member="CalRenderer::getMeshCount" ref="ac992b85a611724351cb5d1c02e7a7920" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getMeshCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of attached meshes. </p>
<p>This function returns the number of meshes attached to the renderer instance.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of attached meshes. </dd></dl>
</div>
</div>
<a class="anchor" id="a264e0f4b518e6e0e551c5e582f803728"></a><!-- doxytag: member="CalRenderer::getNormals" ref="a264e0f4b518e6e0e551c5e582f803728" args="(float *pNormalBuffer, int stride=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getNormals </td>
<td>(</td>
<td class="paramtype">float * </td>
<td class="paramname"><em>pNormalBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the normal data. </p>
<p>This function returns the normal data of the selected mesh/submesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pNormalBuffer</td><td>A pointer to the user-provided buffer where the normal data is written to.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of normals written to the buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="ab013d95f90c0475eb89981b487774a30"></a><!-- doxytag: member="CalRenderer::getShininess" ref="ab013d95f90c0475eb89981b487774a30" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float CalRenderer::getShininess </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the shininess factor. </p>
<p>This function returns the shininess factor of the material of the selected mesh/submesh..</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The shininess factor. </dd></dl>
</div>
</div>
<a class="anchor" id="a269d35a0e36dbab40b3eb81b1102d687"></a><!-- doxytag: member="CalRenderer::getSpecularColor" ref="a269d35a0e36dbab40b3eb81b1102d687" args="(unsigned char *pColorBuffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalRenderer::getSpecularColor </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>pColorBuffer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the specular color. </p>
<p>This function returns the specular color of the material of the selected mesh/submesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pColorBuffer</td><td>A pointer to the user-provided buffer where the color data is written to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa75bc37a240c536f3467c4280e9a3fed"></a><!-- doxytag: member="CalRenderer::getSubmeshCount" ref="aa75bc37a240c536f3467c4280e9a3fed" args="(int meshId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getSubmeshCount </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>meshId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of submeshes. </p>
<p>This function returns the number of submeshes in a given mesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">meshId</td><td>The ID of the mesh for which the number of submeshes should be returned..</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of submeshes. </dd></dl>
</div>
</div>
<a class="anchor" id="adef90b4961037ef84de16163fef1eb75"></a><!-- doxytag: member="CalRenderer::getTangentSpaces" ref="adef90b4961037ef84de16163fef1eb75" args="(int mapId, float *pTangentSpaceBuffer, int stride=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getTangentSpaces </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>mapId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"><em>pTangentSpaceBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the tangent space data. </p>
<p>This function returns the tangent space data of the selected mesh/submesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">mapID</td><td></td></tr>
<tr><td class="paramname">pTangentSpaceBuffer</td><td>A pointer to the user-provided buffer where the normal data is written to.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of tangent space written to the buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a7b7bb1917049bac48d495fc124f8bfe5"></a><!-- doxytag: member="CalRenderer::getTextureCoordinates" ref="a7b7bb1917049bac48d495fc124f8bfe5" args="(int mapId, float *pTextureCoordinateBuffer, int stride=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getTextureCoordinates </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>mapId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"><em>pTextureCoordinateBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the texture coordinate data. </p>
<p>This function returns the texture coordinate data for a given map of the selected mesh/submesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">mapId</td><td>The ID of the map to get the texture coordinate data from. </td></tr>
<tr><td class="paramname">pTextureCoordinateBuffer</td><td>A pointer to the user-provided buffer where the texture coordinate data is written to.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of texture coordinates written to the buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="ae7e3a1998c518ad17e9d7a4dea0e89ec"></a><!-- doxytag: member="CalRenderer::getVertexCount" ref="ae7e3a1998c518ad17e9d7a4dea0e89ec" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getVertexCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of vertices. </p>
<p>This function returns the number of vertices in the selected mesh/submesh.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of vertices. </dd></dl>
</div>
</div>
<a class="anchor" id="a528cf5f6646954849a9ba410a4d26578"></a><!-- doxytag: member="CalRenderer::getVertices" ref="a528cf5f6646954849a9ba410a4d26578" args="(float *pVertexBuffer, int stride=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getVertices </td>
<td>(</td>
<td class="paramtype">float * </td>
<td class="paramname"><em>pVertexBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the vertex data. </p>
<p>This function returns the vertex data of the selected mesh/submesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pVertexBuffer</td><td>A pointer to the user-provided buffer where the vertex data is written to.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of vertices written to the buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a0a5bbe6f436ca8fdd250dad94e466166"></a><!-- doxytag: member="CalRenderer::getVerticesAndNormals" ref="a0a5bbe6f436ca8fdd250dad94e466166" args="(float *pVertexBuffer, int stride=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getVerticesAndNormals </td>
<td>(</td>
<td class="paramtype">float * </td>
<td class="paramname"><em>pVertexBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>stride</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the submesh data. </p>
<p>This function returns the vertex and normal data of the selected mesh/submesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pVertexBuffer</td><td>A pointer to the user-provided buffer where the vertex and normal data is written to.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of vertex written to the buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a66959d79e408c494844f782d6b44230f"></a><!-- doxytag: member="CalRenderer::getVerticesNormalsAndTexCoords" ref="a66959d79e408c494844f782d6b44230f" args="(float *pVertexBuffer, int NumTexCoords=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CalRenderer::getVerticesNormalsAndTexCoords </td>
<td>(</td>
<td class="paramtype">float * </td>
<td class="paramname"><em>pVertexBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>NumTexCoords</em> = <code>1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the submesh data. </p>
<p>This function returns the vertex and normal data of the selected mesh/submesh.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pVertexBuffer</td><td>A pointer to the user-provided buffer where the vertex and normal data is written to.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of vertex written to the buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="acb840ece54d3daf934ac393ca360041f"></a><!-- doxytag: member="CalRenderer::isTangentsEnabled" ref="acb840ece54d3daf934ac393ca360041f" args="(int mapId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalRenderer::isTangentsEnabled </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>mapId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns if tangent are enabled. </p>
<p>This function returns if tangent of the current submesh are enabled</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>True is tangent is enabled. </dd></dl>
</div>
</div>
<a class="anchor" id="ad6e008adb4c63863076a3baf1934ba02"></a><!-- doxytag: member="CalRenderer::selectMeshSubmesh" ref="ad6e008adb4c63863076a3baf1934ba02" args="(int meshId, int submeshId)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CalRenderer::selectMeshSubmesh </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>meshId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>submeshId</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Selects a mesh/submesh for rendering data queries. </p>
<p>This function selects a mesh/submesh for further rendering data queries.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">meshId</td><td>The ID of the mesh that should be used for further rendering data queries. </td></tr>
<tr><td class="paramname">submeshId</td><td>The ID of the submesh that should be used for further rendering data queries.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>One of the following values: <ul>
<li><b>true</b> if successful </li>
<li><b>false</b> if an error happend </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="aaf319142738931b75685e9c7d07385ee"></a><!-- doxytag: member="CalRenderer::setNormalization" ref="aaf319142738931b75685e9c7d07385ee" args="(bool normalize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CalRenderer::setNormalization </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>normalize</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the normalization flag to true or false. </p>
<p>This function sets the normalization flag on or off. If off, the normals calculated by Cal3D will not be normalized. Instead, this transform is left up to the user. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="renderer_8h_source.html">renderer.h</a></li>
<li>renderer.cpp</li>
</ul>
</div>
<hr>
<center>
<small>
Generated at Tue Feb 8 2011 08:51:45 by
<a href="http://gna.org/projects/cal3d/">The Cal3D Team</a>
with
<a href="http://www.doxygen.org/index.html">
Doxygen 1.7.3
</a>
</small>
</center>
</body>
</html>
