<html>
<head>
<title>Ogre::VertexData::SoftwareBlendInfo class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::VertexData::SoftwareBlendInfo Class Reference</h1>Software vertex blend information.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>></code>
<p>
<a href="classOgre_1_1VertexData_1_1SoftwareBlendInfo-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1VertexData_1_1SoftwareBlendInfo.html#Ogre_1_1VertexData_1_1SoftwareBlendInfoa0">SoftwareBlendInfo</a> ()</td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1VertexData_1_1SoftwareBlendInfo.html#Ogre_1_1VertexData_1_1SoftwareBlendInfoa1">~SoftwareBlendInfo</a> ()</td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1VertexData_1_1SoftwareBlendInfo.html#Ogre_1_1VertexData_1_1SoftwareBlendInfom0">automaticBlend</a></td></tr>
<tr><td> </td><td><font size=-1><em>If true, the <a class="el" href="classOgre_1_1RenderSystem.html">RenderSystem</a> will automatically apply the blend when rendering with this vertexData, otherwise the user of the vertex data must call RenderSystem::sofwareVertexBlend manually as required.</em> <a href="#Ogre_1_1VertexData_1_1SoftwareBlendInfom0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1VertexData_1_1SoftwareBlendInfo.html#Ogre_1_1VertexData_1_1SoftwareBlendInfom1">pSrcPositions</a></td></tr>
<tr><td> </td><td><font size=-1><em>System-memory pointer to source positions, note this will be deleted when this class is destroyed.</em> <a href="#Ogre_1_1VertexData_1_1SoftwareBlendInfom1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1VertexData_1_1SoftwareBlendInfo.html#Ogre_1_1VertexData_1_1SoftwareBlendInfom2">pSrcNormals</a></td></tr>
<tr><td> </td><td><font size=-1><em>System-memory pointer to source normals, can be null if vertexData does not include normals , note this will be deleted when this class is destroyed.</em> <a href="#Ogre_1_1VertexData_1_1SoftwareBlendInfom2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>unsigned short </td><td valign=bottom><a class="el" href="classOgre_1_1VertexData_1_1SoftwareBlendInfo.html#Ogre_1_1VertexData_1_1SoftwareBlendInfom3">numWeightsPerVertex</a></td></tr>
<tr><td> </td><td><font size=-1><em>The number of blending weights per vertex, will be deleted on destruction.</em> <a href="#Ogre_1_1VertexData_1_1SoftwareBlendInfom3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1VertexData_1_1SoftwareBlendInfo.html#Ogre_1_1VertexData_1_1SoftwareBlendInfom4">pBlendWeights</a></td></tr>
<tr><td> </td><td><font size=-1><em>Pointer to blending weights, will be deleted on destruction.</em> <a href="#Ogre_1_1VertexData_1_1SoftwareBlendInfom4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>unsigned char * </td><td valign=bottom><a class="el" href="classOgre_1_1VertexData_1_1SoftwareBlendInfo.html#Ogre_1_1VertexData_1_1SoftwareBlendInfom5">pBlendIndexes</a></td></tr>
<tr><td> </td><td><font size=-1><em>Pointer to blending indexes (index into world matrices).</em> <a href="#Ogre_1_1VertexData_1_1SoftwareBlendInfom5"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Software vertex blend information.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
This data is here in order to allow the creator of the <a class="el" href="classOgre_1_1VertexData.html">VertexData</a> to request a software vertex blend, ie a blend using information which you do not want to be passed to the GPU.
<p>
The assumption here is that you have a VES_POSITION and VES_NORMAL elements in your declaration which you wish to update with a blended version of positions / normals from a system-memory location. We advise that if you're blending a lot, you set the hardware vertex buffer to HBU_DYNAMIC_WRITE_ONLY, with no shadow buffer.
<p>
Note that future versions of the engine are likely to support vertex shader based animation so there will be a hardware alternative; however, note that sometimes you may still want to perform blending in software, for example when you need to read back the blended positions in applications such as shadow volume construction.
<p>
In order to apply this blending, the world matrices must be set and <a class="el" href="classOgre_1_1RenderSystem.html#Ogre_1_1RenderSystema67">RenderSystem::softwareVertexBlend</a> called. This is done automatically for skeletally animated entities, but this can be done manually if required. After calling this method, the vertex buffers are updated with the blended positions and the blend does not need to be called again unless it's basis changes. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00083">83</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1VertexData_1_1SoftwareBlendInfoa0" doxytag="Ogre::VertexData::SoftwareBlendInfo::SoftwareBlendInfo"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::VertexData::SoftwareBlendInfo::SoftwareBlendInfo </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00103">103</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1VertexData_1_1SoftwareBlendInfoa1" doxytag="Ogre::VertexData::SoftwareBlendInfo::~SoftwareBlendInfo"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Ogre::VertexData::SoftwareBlendInfo::~SoftwareBlendInfo </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="OgreVertexIndexData_8cpp-source.html#l00132">132</a> of file <a class="el" href="OgreVertexIndexData_8cpp-source.html">OgreVertexIndexData.cpp</a>.
<p>
References <a class="el" href="OgreVertexIndexData_8h-source.html#l00101">pBlendIndexes</a>, <a class="el" href="OgreVertexIndexData_8h-source.html#l00099">pBlendWeights</a>, <a class="el" href="OgreVertexIndexData_8h-source.html#l00095">pSrcNormals</a>, and <a class="el" href="OgreVertexIndexData_8h-source.html#l00091">pSrcPositions</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1VertexData_1_1SoftwareBlendInfom0" doxytag="Ogre::VertexData::SoftwareBlendInfo::automaticBlend"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool Ogre::VertexData::SoftwareBlendInfo::automaticBlend
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
If true, the <a class="el" href="classOgre_1_1RenderSystem.html">RenderSystem</a> will automatically apply the blend when rendering with this vertexData, otherwise the user of the vertex data must call RenderSystem::sofwareVertexBlend manually as required.
<p>
<p>
Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00089">89</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.
<p>
Referenced by <a class="el" href="OgreVertexIndexData_8cpp-source.html#l00061">Ogre::VertexData::clone</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1VertexData_1_1SoftwareBlendInfom3" doxytag="Ogre::VertexData::SoftwareBlendInfo::numWeightsPerVertex"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned short Ogre::VertexData::SoftwareBlendInfo::numWeightsPerVertex
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The number of blending weights per vertex, will be deleted on destruction.
<p>
<p>
Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00097">97</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.
<p>
Referenced by <a class="el" href="OgreVertexIndexData_8cpp-source.html#l00061">Ogre::VertexData::clone</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1VertexData_1_1SoftwareBlendInfom5" doxytag="Ogre::VertexData::SoftwareBlendInfo::pBlendIndexes"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> unsigned char* Ogre::VertexData::SoftwareBlendInfo::pBlendIndexes
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Pointer to blending indexes (index into world matrices).
<p>
<p>
Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00101">101</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.
<p>
Referenced by <a class="el" href="OgreVertexIndexData_8cpp-source.html#l00061">Ogre::VertexData::clone</a>(), and <a class="el" href="OgreVertexIndexData_8cpp-source.html#l00132">~SoftwareBlendInfo</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1VertexData_1_1SoftwareBlendInfom4" doxytag="Ogre::VertexData::SoftwareBlendInfo::pBlendWeights"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a>* Ogre::VertexData::SoftwareBlendInfo::pBlendWeights
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Pointer to blending weights, will be deleted on destruction.
<p>
<p>
Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00099">99</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.
<p>
Referenced by <a class="el" href="OgreVertexIndexData_8cpp-source.html#l00061">Ogre::VertexData::clone</a>(), and <a class="el" href="OgreVertexIndexData_8cpp-source.html#l00132">~SoftwareBlendInfo</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1VertexData_1_1SoftwareBlendInfom2" doxytag="Ogre::VertexData::SoftwareBlendInfo::pSrcNormals"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a>* Ogre::VertexData::SoftwareBlendInfo::pSrcNormals
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
System-memory pointer to source normals, can be null if vertexData does not include normals , note this will be deleted when this class is destroyed.
<p>
<p>
Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00095">95</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.
<p>
Referenced by <a class="el" href="OgreVertexIndexData_8cpp-source.html#l00061">Ogre::VertexData::clone</a>(), and <a class="el" href="OgreVertexIndexData_8cpp-source.html#l00132">~SoftwareBlendInfo</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1VertexData_1_1SoftwareBlendInfom1" doxytag="Ogre::VertexData::SoftwareBlendInfo::pSrcPositions"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a349">Real</a>* Ogre::VertexData::SoftwareBlendInfo::pSrcPositions
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
System-memory pointer to source positions, note this will be deleted when this class is destroyed.
<p>
<p>
Definition at line <a class="el" href="OgreVertexIndexData_8h-source.html#l00091">91</a> of file <a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a>.
<p>
Referenced by <a class="el" href="OgreVertexIndexData_8cpp-source.html#l00061">Ogre::VertexData::clone</a>(), and <a class="el" href="OgreVertexIndexData_8cpp-source.html#l00132">~SoftwareBlendInfo</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreVertexIndexData_8h-source.html">OgreVertexIndexData.h</a><li><a class="el" href="OgreVertexIndexData_8cpp-source.html">OgreVertexIndexData.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:21:13 2004
</p>
</body>
</html>
