<html>
<head>
<title>Ogre::FloatGpuParameterControllerValue 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::FloatGpuParameterControllerValue Class Reference</h1>Predefined controller value for setting a single floating- point value in a constant paramter of a vertex or fragment program.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>></code>
<p>
Inheritance diagram for Ogre::FloatGpuParameterControllerValue:<p><center><img src="classOgre_1_1FloatGpuParameterControllerValue__inherit__graph.png" border="0" usemap="#Ogre_1_1FloatGpuParameterControllerValue__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1FloatGpuParameterControllerValue__inherit__map">
<area href="classOgre_1_1ControllerValue.html" shape="rect" coords="40,36,227,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Ogre::FloatGpuParameterControllerValue:<p><center><img src="classOgre_1_1FloatGpuParameterControllerValue__coll__graph.png" border="0" usemap="#Ogre_1_1FloatGpuParameterControllerValue__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1FloatGpuParameterControllerValue__coll__map">
<area href="classOgre_1_1ControllerValue.html" shape="rect" coords="7,127,193,108" alt="">
<area href="classOgre_1_1SharedPtr.html" shape="rect" coords="217,127,492,108" alt="">
<area href="classOgre_1_1GpuProgramParameters.html" shape="rect" coords="259,36,451,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1FloatGpuParameterControllerValue-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_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuea0">FloatGpuParameterControllerValue</a> (<a class="el" href="namespaceOgre.html#a132">GpuProgramParametersSharedPtr</a> params, size_t index)</td></tr>
<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#Ogre_1_1FloatGpuParameterControllerValuea0"></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_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuea1">getValue</a> (void) const</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuea2">setValue</a> (<a class="el" href="namespaceOgre.html#a349">Real</a> value)</td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a132">GpuProgramParametersSharedPtr</a> </td><td valign=bottom><a class="el" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuen0">mParams</a></td></tr>
<tr><td> </td><td><font size=-1><em>The parameters to access.</em> <a href="#Ogre_1_1FloatGpuParameterControllerValuen0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>size_t </td><td valign=bottom><a class="el" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuen1">mParamIndex</a></td></tr>
<tr><td> </td><td><font size=-1><em>The index of the parameter to e read or set.</em> <a href="#Ogre_1_1FloatGpuParameterControllerValuen1"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Predefined controller value for setting a single floating- point value in a constant paramter of a vertex or fragment program.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Any value is accepted, it is propagated into the 'x' component of the constant register identified by the index. If you need to use named parameters, retrieve the index from the param object before setting this controller up. </dl><dl compact><dt><b>
Note: </b><dd>
Retrieving a value from the program parameters is not currently supported, therefore do not use this controller value as a source, only as a target. </dl>
<p>
<p>
Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00128">128</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1FloatGpuParameterControllerValuea0" doxytag="Ogre::FloatGpuParameterControllerValue::FloatGpuParameterControllerValue"></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::FloatGpuParameterControllerValue::FloatGpuParameterControllerValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a132">GpuProgramParametersSharedPtr</a> </td>
<td class="mdname" nowrap> <em>params</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>index</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructor.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>params</em> </td><td>
The parameters object to access </td></tr>
<tr><td valign=top><em>index</em> </td><td>
The index of the parameter to be set </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00175">175</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>.
<p>
References <a class="el" href="OgreGpuProgram_8h-source.html#l00407">Ogre::GpuProgramParametersSharedPtr</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1FloatGpuParameterControllerValuea1" doxytag="Ogre::FloatGpuParameterControllerValue::getValue"></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::FloatGpuParameterControllerValue::getValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea0">Ogre::ControllerValue< Real ></a>.
<p>
Definition at line <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00181">181</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>.
<p>
References <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>. </td>
</tr>
</table>
<a name="Ogre_1_1FloatGpuParameterControllerValuea2" doxytag="Ogre::FloatGpuParameterControllerValue::setValue"></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"> void Ogre::FloatGpuParameterControllerValue::setValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a349">Real</a> </td>
<td class="mdname1" valign="top" nowrap> <em>value</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea1">Ogre::ControllerValue< Real ></a>.
<p>
Definition at line <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00187">187</a> of file <a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a>.
<p>
References <a class="el" href="OgrePredefinedControllers_8h-source.html#l00134">mParamIndex</a>, <a class="el" href="OgrePredefinedControllers_8h-source.html#l00132">mParams</a>, <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>, and <a class="el" href="OgreVector4_8h-source.html#l00042">Ogre::Vector4::x</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1FloatGpuParameterControllerValuen1" doxytag="Ogre::FloatGpuParameterControllerValue::mParamIndex"></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"> size_t Ogre::FloatGpuParameterControllerValue::mParamIndex<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The index of the parameter to e read or set.
<p>
<p>
Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00134">134</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.
<p>
Referenced by <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00187">setValue</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1FloatGpuParameterControllerValuen0" doxytag="Ogre::FloatGpuParameterControllerValue::mParams"></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#a132">GpuProgramParametersSharedPtr</a> Ogre::FloatGpuParameterControllerValue::mParams<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The parameters to access.
<p>
<p>
Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00132">132</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.
<p>
Referenced by <a class="el" href="OgrePredefinedControllers_8cpp-source.html#l00187">setValue</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a><li><a class="el" href="OgrePredefinedControllers_8cpp-source.html">OgrePredefinedControllers.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:16:10 2004
</p>
</body>
</html>
distrib
>
Mandriva
>
10.0
>
i586
>
media
>
contrib
>
by-pkgid
>
06719cf03808e17ae6f0852ca1052dc2
>
files
>
2167
