source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1FloatGpuParameterControllerValue.html @ 657

Revision 657, 13.5 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::FloatGpuParameterControllerValue class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<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. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::FloatGpuParameterControllerValue:
16<p><center><img src="classOgre_1_1FloatGpuParameterControllerValue.png" usemap="#Ogre::FloatGpuParameterControllerValue_map" border="0" alt=""></center>
17<map name="Ogre::FloatGpuParameterControllerValue_map">
18<area href="classOgre_1_1ControllerValue.html" alt="Ogre::ControllerValue< Real >" shape="rect" coords="0,0,245,24">
19</map>
20<a href="classOgre_1_1FloatGpuParameterControllerValue-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuea0">FloatGpuParameterControllerValue</a> (<a class="el" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a> *<a class="el" href="OgreGLPrerequisites_8h.html#a74">params</a>, size_t index)</td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#Ogre_1_1FloatGpuParameterControllerValuea0"></a><br><br></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuea1">~FloatGpuParameterControllerValue</a> ()</td></tr>
27
28<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuea2">getValue</a> (void) const </td></tr>
29
30<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuea3">setValue</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> value)</td></tr>
31
32<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
33<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuep0">mParams</a></td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The parameters to access.  <a href="#Ogre_1_1FloatGpuParameterControllerValuep0"></a><br><br></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuep1">mParamIndex</a></td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The index of the parameter to e read or set.  <a href="#Ogre_1_1FloatGpuParameterControllerValuep1"></a><br><br></td></tr>
39</table>
40<hr><a name="_details"></a><h2>Detailed Description</h2>
41Predefined controller value for setting a single floating- point value in a constant paramter of a vertex or fragment program.
42<p>
43<dl compact><dt><b>Remarks:</b></dt><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. </dd></dl>
44<dl compact><dt><b>Note:</b></dt><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. </dd></dl>
45
46<p>
47
48<p>
49Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00131">131</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
50<a class="anchor" name="Ogre_1_1FloatGpuParameterControllerValuea0" doxytag="Ogre::FloatGpuParameterControllerValue::FloatGpuParameterControllerValue" ></a><p>
51<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
52  <tr>
53    <td class="mdRow">
54      <table cellpadding="0" cellspacing="0" border="0">
55        <tr>
56          <td class="md" nowrap valign="top"> Ogre::FloatGpuParameterControllerValue::FloatGpuParameterControllerValue </td>
57          <td class="md" valign="top">(&nbsp;</td>
58          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a> *&nbsp;</td>
59          <td class="mdname" nowrap> <em>params</em>, </td>
60        </tr>
61        <tr>
62          <td class="md" nowrap align="right"></td>
63          <td></td>
64          <td class="md" nowrap>size_t&nbsp;</td>
65          <td class="mdname" nowrap> <em>index</em></td>
66        </tr>
67        <tr>
68          <td></td>
69          <td class="md">)&nbsp;</td>
70          <td class="md" colspan="2"></td>
71        </tr>
72
73      </table>
74    </td>
75  </tr>
76</table>
77<table cellspacing=5 cellpadding=0 border=0>
78  <tr>
79    <td>
80      &nbsp;
81    </td>
82    <td>
83
84<p>
85Constructor.
86<p>
87<dl compact><dt><b>Parameters:</b></dt><dd>
88  <table border="0" cellspacing="2" cellpadding="0">
89    <tr><td valign=top><em>params</em>&nbsp;</td><td>The parameters object to access </td></tr>
90    <tr><td valign=top><em>index</em>&nbsp;</td><td>The index of the parameter to be set </td></tr>
91  </table>
92</dl>
93    </td>
94  </tr>
95</table>
96<a class="anchor" name="Ogre_1_1FloatGpuParameterControllerValuea1" doxytag="Ogre::FloatGpuParameterControllerValue::~FloatGpuParameterControllerValue" ></a><p>
97<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
98  <tr>
99    <td class="mdRow">
100      <table cellpadding="0" cellspacing="0" border="0">
101        <tr>
102          <td class="md" nowrap valign="top"> Ogre::FloatGpuParameterControllerValue::~<a class="el" href="classOgre_1_1FloatGpuParameterControllerValue.html">FloatGpuParameterControllerValue</a> </td>
103          <td class="md" valign="top">(&nbsp;</td>
104          <td class="mdname1" valign="top" nowrap>          </td>
105          <td class="md" valign="top">&nbsp;)&nbsp;</td>
106          <td class="md" nowrap></td>
107        </tr>
108
109      </table>
110    </td>
111  </tr>
112</table>
113<table cellspacing=5 cellpadding=0 border=0>
114  <tr>
115    <td>
116      &nbsp;
117    </td>
118    <td>
119
120<p>
121
122<p>
123Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00148">148</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
124  </tr>
125</table>
126<hr><h2>Member Function Documentation</h2>
127<a class="anchor" name="Ogre_1_1FloatGpuParameterControllerValuea2" doxytag="Ogre::FloatGpuParameterControllerValue::getValue" ></a><p>
128<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
129  <tr>
130    <td class="mdRow">
131      <table cellpadding="0" cellspacing="0" border="0">
132        <tr>
133          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::FloatGpuParameterControllerValue::getValue </td>
134          <td class="md" valign="top">(&nbsp;</td>
135          <td class="md" nowrap valign="top">void&nbsp;</td>
136          <td class="mdname1" valign="top" nowrap>          </td>
137          <td class="md" valign="top">&nbsp;)&nbsp;</td>
138          <td class="md" nowrap> const<code> [virtual]</code></td>
139        </tr>
140
141      </table>
142    </td>
143  </tr>
144</table>
145<table cellspacing=5 cellpadding=0 border=0>
146  <tr>
147    <td>
148      &nbsp;
149    </td>
150    <td>
151
152<p>
153
154<p>
155Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea1">Ogre::ControllerValue&lt; Real &gt;</a>.    </td>
156  </tr>
157</table>
158<a class="anchor" name="Ogre_1_1FloatGpuParameterControllerValuea3" doxytag="Ogre::FloatGpuParameterControllerValue::setValue" ></a><p>
159<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
160  <tr>
161    <td class="mdRow">
162      <table cellpadding="0" cellspacing="0" border="0">
163        <tr>
164          <td class="md" nowrap valign="top"> void Ogre::FloatGpuParameterControllerValue::setValue </td>
165          <td class="md" valign="top">(&nbsp;</td>
166          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
167          <td class="mdname1" valign="top" nowrap> <em>value</em>          </td>
168          <td class="md" valign="top">&nbsp;)&nbsp;</td>
169          <td class="md" nowrap><code> [virtual]</code></td>
170        </tr>
171
172      </table>
173    </td>
174  </tr>
175</table>
176<table cellspacing=5 cellpadding=0 border=0>
177  <tr>
178    <td>
179      &nbsp;
180    </td>
181    <td>
182
183<p>
184
185<p>
186Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea2">Ogre::ControllerValue&lt; Real &gt;</a>.    </td>
187  </tr>
188</table>
189<hr><h2>Member Data Documentation</h2>
190<a class="anchor" name="Ogre_1_1FloatGpuParameterControllerValuep1" doxytag="Ogre::FloatGpuParameterControllerValue::mParamIndex" ></a><p>
191<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
192  <tr>
193    <td class="mdRow">
194      <table cellpadding="0" cellspacing="0" border="0">
195        <tr>
196          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuep1">Ogre::FloatGpuParameterControllerValue::mParamIndex</a><code> [protected]</code>
197      </table>
198    </td>
199  </tr>
200</table>
201<table cellspacing=5 cellpadding=0 border=0>
202  <tr>
203    <td>
204      &nbsp;
205    </td>
206    <td>
207
208<p>
209The index of the parameter to e read or set.
210<p>
211
212<p>
213Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00137">137</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
214  </tr>
215</table>
216<a class="anchor" name="Ogre_1_1FloatGpuParameterControllerValuep0" doxytag="Ogre::FloatGpuParameterControllerValue::mParams" ></a><p>
217<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
218  <tr>
219    <td class="mdRow">
220      <table cellpadding="0" cellspacing="0" border="0">
221        <tr>
222          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a>* <a class="el" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuep0">Ogre::FloatGpuParameterControllerValue::mParams</a><code> [protected]</code>
223      </table>
224    </td>
225  </tr>
226</table>
227<table cellspacing=5 cellpadding=0 border=0>
228  <tr>
229    <td>
230      &nbsp;
231    </td>
232    <td>
233
234<p>
235The parameters to access.
236<p>
237
238<p>
239Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00135">135</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
240  </tr>
241</table>
242<hr>The documentation for this class was generated from the following file:<ul>
243<li><a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a></ul>
244<hr>
245<p>
246Copyright &copy; 2000-2005 by The OGRE Team<br />
247<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
248This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
249                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
250                <Work rdf:about="">
251                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
252        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
253                </Work>
254                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
255
256Last modified Sun Feb 12 13:02:10 2006
257</p>
258</body>
259</html>
Note: See TracBrowser for help on using the repository browser.