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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::GpuProgramUsage 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::GpuProgramUsage Class Reference</h1>This class makes the usage of a vertex and fragment programs (low-level or high-level), with a given set of parameters, explicit. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreGpuProgramUsage_8h-source.html">OgreGpuProgramUsage.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1GpuProgramUsage-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagea0">GpuProgramUsage</a> (<a class="el" href="namespaceOgre.html#a653">GpuProgramType</a> gptype)</td></tr>
19
20<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#Ogre_1_1GpuProgramUsagea0"></a><br><br></td></tr>
21<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagea1">GpuProgramUsage</a> (const <a class="el" href="classOgre_1_1GpuProgramUsage.html">GpuProgramUsage</a> &amp;rhs)</td></tr>
22
23<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor.  <a href="#Ogre_1_1GpuProgramUsagea1"></a><br><br></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a653">GpuProgramType</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagea2">getType</a> (void) const </td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the type of program we're trying to link to.  <a href="#Ogre_1_1GpuProgramUsagea2"></a><br><br></td></tr>
27<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagea3">setProgramName</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name, bool resetParams=true)</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the name of the program to use.  <a href="#Ogre_1_1GpuProgramUsagea3"></a><br><br></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagea4">setProgram</a> (<a class="el" href="classOgre_1_1GpuProgramPtr.html">GpuProgramPtr</a> &amp;prog)</td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the program to use.  <a href="#Ogre_1_1GpuProgramUsagea4"></a><br><br></td></tr>
33<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1GpuProgramPtr.html">GpuProgramPtr</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagea5">getProgram</a> () const </td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the program being used.  <a href="#Ogre_1_1GpuProgramUsagea5"></a><br><br></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagea6">getProgramName</a> (void) const </td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the program being used.  <a href="#Ogre_1_1GpuProgramUsagea6"></a><br><br></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagea7">setParameters</a> (<a class="el" href="classOgre_1_1SharedPtr.html">GpuProgramParametersSharedPtr</a> <a class="el" href="OgreGLPrerequisites_8h.html#a74">params</a>)</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the program parameters that should be used; because parameters can be shared between multiple usages for efficiency, this method is here for you to register externally created parameter objects.  <a href="#Ogre_1_1GpuProgramUsagea7"></a><br><br></td></tr>
42<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">GpuProgramParametersSharedPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagea8">getParameters</a> (void)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the parameters being used here.  <a href="#Ogre_1_1GpuProgramUsagea8"></a><br><br></td></tr>
45<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagea9">_load</a> (void)</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Load this usage (and ensure program is loaded).  <a href="#Ogre_1_1GpuProgramUsagea9"></a><br><br></td></tr>
48<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagea10">_unload</a> (void)</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unload this usage.  <a href="#Ogre_1_1GpuProgramUsagea10"></a><br><br></td></tr>
51<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
52<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a653">GpuProgramType</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagep0">mType</a></td></tr>
53
54<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1GpuProgramPtr.html">GpuProgramPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagep1">mProgram</a></td></tr>
55
56<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1SharedPtr.html">GpuProgramParametersSharedPtr</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagep2">mParameters</a></td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">program parameters  <a href="#Ogre_1_1GpuProgramUsagep2"></a><br><br></td></tr>
59</table>
60<hr><a name="_details"></a><h2>Detailed Description</h2>
61This class makes the usage of a vertex and fragment programs (low-level or high-level), with a given set of parameters, explicit.
62<p>
63<dl compact><dt><b>Remarks:</b></dt><dd>Using a vertex or fragment program can get fairly complex; besides the fairly rudimentary process of binding a program to the GPU for rendering, managing usage has few complications, such as: <ul>
64<li>
65Programs can be high level (e.g. Cg, RenderMonkey) or low level (assembler). Using either should be relatively seamless, although high-level programs give you the advantage of being able to use named parameters, instead of just indexed registers </li>
66<li>
67Programs and parameters can be shared between multiple usages, in order to save memory </li>
68<li>
69When you define a user of a program, such as a material, you often want to be able to set up the definition but not load / compile / assemble the program at that stage, because it is not needed just yet. The program should be loaded when it is first needed, or earlier if specifically requested. The program may not be defined at this time, you may want to have scripts that can set up the definitions independent of the order in which those scripts are loaded. </li>
70</ul>
71This class packages up those details so you don't have to worry about them. For example, this class lets you define a high-level program and set up the parameters for it, without having loaded the program (which you normally could not do). When the program is loaded and compiled, this class will then validate the parameters you supplied earlier and turn them into runtime parameters. </dd></dl>
72<dl compact><dt><b></b></dt><dd>Just incase it wasn't clear from the above, this class provides linkage to both <a class="el" href="classOgre_1_1GpuProgram.html">GpuProgram</a> and <a class="el" href="classOgre_1_1HighLevelGpuProgram.html">HighLevelGpuProgram</a>, despite its name. </dd></dl>
73
74<p>
75
76<p>
77Definition at line <a class="el" href="OgreGpuProgramUsage_8h-source.html#l00062">62</a> of file <a class="el" href="OgreGpuProgramUsage_8h-source.html">OgreGpuProgramUsage.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
78<a class="anchor" name="Ogre_1_1GpuProgramUsagea0" doxytag="Ogre::GpuProgramUsage::GpuProgramUsage" ></a><p>
79<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
80  <tr>
81    <td class="mdRow">
82      <table cellpadding="0" cellspacing="0" border="0">
83        <tr>
84          <td class="md" nowrap valign="top"> Ogre::GpuProgramUsage::GpuProgramUsage </td>
85          <td class="md" valign="top">(&nbsp;</td>
86          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a653">GpuProgramType</a>&nbsp;</td>
87          <td class="mdname1" valign="top" nowrap> <em>gptype</em>          </td>
88          <td class="md" valign="top">&nbsp;)&nbsp;</td>
89          <td class="md" nowrap></td>
90        </tr>
91
92      </table>
93    </td>
94  </tr>
95</table>
96<table cellspacing=5 cellpadding=0 border=0>
97  <tr>
98    <td>
99      &nbsp;
100    </td>
101    <td>
102
103<p>
104Default constructor.
105<p>
106<dl compact><dt><b>Parameters:</b></dt><dd>
107  <table border="0" cellspacing="2" cellpadding="0">
108    <tr><td valign=top><em>gptype</em>&nbsp;</td><td>The type of program to link to </td></tr>
109  </table>
110</dl>
111    </td>
112  </tr>
113</table>
114<a class="anchor" name="Ogre_1_1GpuProgramUsagea1" doxytag="Ogre::GpuProgramUsage::GpuProgramUsage" ></a><p>
115<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
116  <tr>
117    <td class="mdRow">
118      <table cellpadding="0" cellspacing="0" border="0">
119        <tr>
120          <td class="md" nowrap valign="top"> Ogre::GpuProgramUsage::GpuProgramUsage </td>
121          <td class="md" valign="top">(&nbsp;</td>
122          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1GpuProgramUsage.html">GpuProgramUsage</a> &amp;&nbsp;</td>
123          <td class="mdname1" valign="top" nowrap> <em>rhs</em>          </td>
124          <td class="md" valign="top">&nbsp;)&nbsp;</td>
125          <td class="md" nowrap></td>
126        </tr>
127
128      </table>
129    </td>
130  </tr>
131</table>
132<table cellspacing=5 cellpadding=0 border=0>
133  <tr>
134    <td>
135      &nbsp;
136    </td>
137    <td>
138
139<p>
140Copy constructor.
141<p>
142    </td>
143  </tr>
144</table>
145<hr><h2>Member Function Documentation</h2>
146<a class="anchor" name="Ogre_1_1GpuProgramUsagea9" doxytag="Ogre::GpuProgramUsage::_load" ></a><p>
147<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
148  <tr>
149    <td class="mdRow">
150      <table cellpadding="0" cellspacing="0" border="0">
151        <tr>
152          <td class="md" nowrap valign="top"> void Ogre::GpuProgramUsage::_load </td>
153          <td class="md" valign="top">(&nbsp;</td>
154          <td class="md" nowrap valign="top">void&nbsp;</td>
155          <td class="mdname1" valign="top" nowrap>          </td>
156          <td class="md" valign="top">&nbsp;)&nbsp;</td>
157          <td class="md" nowrap></td>
158        </tr>
159
160      </table>
161    </td>
162  </tr>
163</table>
164<table cellspacing=5 cellpadding=0 border=0>
165  <tr>
166    <td>
167      &nbsp;
168    </td>
169    <td>
170
171<p>
172Load this usage (and ensure program is loaded).
173<p>
174    </td>
175  </tr>
176</table>
177<a class="anchor" name="Ogre_1_1GpuProgramUsagea10" doxytag="Ogre::GpuProgramUsage::_unload" ></a><p>
178<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
179  <tr>
180    <td class="mdRow">
181      <table cellpadding="0" cellspacing="0" border="0">
182        <tr>
183          <td class="md" nowrap valign="top"> void Ogre::GpuProgramUsage::_unload </td>
184          <td class="md" valign="top">(&nbsp;</td>
185          <td class="md" nowrap valign="top">void&nbsp;</td>
186          <td class="mdname1" valign="top" nowrap>          </td>
187          <td class="md" valign="top">&nbsp;)&nbsp;</td>
188          <td class="md" nowrap></td>
189        </tr>
190
191      </table>
192    </td>
193  </tr>
194</table>
195<table cellspacing=5 cellpadding=0 border=0>
196  <tr>
197    <td>
198      &nbsp;
199    </td>
200    <td>
201
202<p>
203Unload this usage.
204<p>
205    </td>
206  </tr>
207</table>
208<a class="anchor" name="Ogre_1_1GpuProgramUsagea8" doxytag="Ogre::GpuProgramUsage::getParameters" ></a><p>
209<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
210  <tr>
211    <td class="mdRow">
212      <table cellpadding="0" cellspacing="0" border="0">
213        <tr>
214          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">GpuProgramParametersSharedPtr</a> Ogre::GpuProgramUsage::getParameters </td>
215          <td class="md" valign="top">(&nbsp;</td>
216          <td class="md" nowrap valign="top">void&nbsp;</td>
217          <td class="mdname1" valign="top" nowrap>          </td>
218          <td class="md" valign="top">&nbsp;)&nbsp;</td>
219          <td class="md" nowrap></td>
220        </tr>
221
222      </table>
223    </td>
224  </tr>
225</table>
226<table cellspacing=5 cellpadding=0 border=0>
227  <tr>
228    <td>
229      &nbsp;
230    </td>
231    <td>
232
233<p>
234Gets the parameters being used here.
235<p>
236    </td>
237  </tr>
238</table>
239<a class="anchor" name="Ogre_1_1GpuProgramUsagea5" doxytag="Ogre::GpuProgramUsage::getProgram" ></a><p>
240<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
241  <tr>
242    <td class="mdRow">
243      <table cellpadding="0" cellspacing="0" border="0">
244        <tr>
245          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1GpuProgramPtr.html">GpuProgramPtr</a>&amp; Ogre::GpuProgramUsage::getProgram </td>
246          <td class="md" valign="top">(&nbsp;</td>
247          <td class="mdname1" valign="top" nowrap>          </td>
248          <td class="md" valign="top">&nbsp;)&nbsp;</td>
249          <td class="md" nowrap> const</td>
250        </tr>
251
252      </table>
253    </td>
254  </tr>
255</table>
256<table cellspacing=5 cellpadding=0 border=0>
257  <tr>
258    <td>
259      &nbsp;
260    </td>
261    <td>
262
263<p>
264Gets the program being used.
265<p>
266
267<p>
268Definition at line <a class="el" href="OgreGpuProgramUsage_8h-source.html#l00104">104</a> of file <a class="el" href="OgreGpuProgramUsage_8h-source.html">OgreGpuProgramUsage.h</a>.    </td>
269  </tr>
270</table>
271<a class="anchor" name="Ogre_1_1GpuProgramUsagea6" doxytag="Ogre::GpuProgramUsage::getProgramName" ></a><p>
272<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
273  <tr>
274    <td class="mdRow">
275      <table cellpadding="0" cellspacing="0" border="0">
276        <tr>
277          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; Ogre::GpuProgramUsage::getProgramName </td>
278          <td class="md" valign="top">(&nbsp;</td>
279          <td class="md" nowrap valign="top">void&nbsp;</td>
280          <td class="mdname1" valign="top" nowrap>          </td>
281          <td class="md" valign="top">&nbsp;)&nbsp;</td>
282          <td class="md" nowrap> const</td>
283        </tr>
284
285      </table>
286    </td>
287  </tr>
288</table>
289<table cellspacing=5 cellpadding=0 border=0>
290  <tr>
291    <td>
292      &nbsp;
293    </td>
294    <td>
295
296<p>
297Gets the program being used.
298<p>
299
300<p>
301Definition at line <a class="el" href="OgreGpuProgramUsage_8h-source.html#l00106">106</a> of file <a class="el" href="OgreGpuProgramUsage_8h-source.html">OgreGpuProgramUsage.h</a>.
302<p>
303References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
304  </tr>
305</table>
306<a class="anchor" name="Ogre_1_1GpuProgramUsagea2" doxytag="Ogre::GpuProgramUsage::getType" ></a><p>
307<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
308  <tr>
309    <td class="mdRow">
310      <table cellpadding="0" cellspacing="0" border="0">
311        <tr>
312          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a653">GpuProgramType</a> Ogre::GpuProgramUsage::getType </td>
313          <td class="md" valign="top">(&nbsp;</td>
314          <td class="md" nowrap valign="top">void&nbsp;</td>
315          <td class="mdname1" valign="top" nowrap>          </td>
316          <td class="md" valign="top">&nbsp;)&nbsp;</td>
317          <td class="md" nowrap> const</td>
318        </tr>
319
320      </table>
321    </td>
322  </tr>
323</table>
324<table cellspacing=5 cellpadding=0 border=0>
325  <tr>
326    <td>
327      &nbsp;
328    </td>
329    <td>
330
331<p>
332Gets the type of program we're trying to link to.
333<p>
334
335<p>
336Definition at line <a class="el" href="OgreGpuProgramUsage_8h-source.html#l00083">83</a> of file <a class="el" href="OgreGpuProgramUsage_8h-source.html">OgreGpuProgramUsage.h</a>.
337<p>
338References <a class="el" href="OgreGpuProgram_8h-source.html#l00037">Ogre::GpuProgramType</a>.    </td>
339  </tr>
340</table>
341<a class="anchor" name="Ogre_1_1GpuProgramUsagea7" doxytag="Ogre::GpuProgramUsage::setParameters" ></a><p>
342<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
343  <tr>
344    <td class="mdRow">
345      <table cellpadding="0" cellspacing="0" border="0">
346        <tr>
347          <td class="md" nowrap valign="top"> void Ogre::GpuProgramUsage::setParameters </td>
348          <td class="md" valign="top">(&nbsp;</td>
349          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SharedPtr.html">GpuProgramParametersSharedPtr</a>&nbsp;</td>
350          <td class="mdname1" valign="top" nowrap> <em>params</em>          </td>
351          <td class="md" valign="top">&nbsp;)&nbsp;</td>
352          <td class="md" nowrap></td>
353        </tr>
354
355      </table>
356    </td>
357  </tr>
358</table>
359<table cellspacing=5 cellpadding=0 border=0>
360  <tr>
361    <td>
362      &nbsp;
363    </td>
364    <td>
365
366<p>
367Sets the program parameters that should be used; because parameters can be shared between multiple usages for efficiency, this method is here for you to register externally created parameter objects.
368<p>
369Otherwise, the parameters will be created for you when a program is linked.     </td>
370  </tr>
371</table>
372<a class="anchor" name="Ogre_1_1GpuProgramUsagea4" doxytag="Ogre::GpuProgramUsage::setProgram" ></a><p>
373<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
374  <tr>
375    <td class="mdRow">
376      <table cellpadding="0" cellspacing="0" border="0">
377        <tr>
378          <td class="md" nowrap valign="top"> void Ogre::GpuProgramUsage::setProgram </td>
379          <td class="md" valign="top">(&nbsp;</td>
380          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1GpuProgramPtr.html">GpuProgramPtr</a> &amp;&nbsp;</td>
381          <td class="mdname1" valign="top" nowrap> <em>prog</em>          </td>
382          <td class="md" valign="top">&nbsp;)&nbsp;</td>
383          <td class="md" nowrap></td>
384        </tr>
385
386      </table>
387    </td>
388  </tr>
389</table>
390<table cellspacing=5 cellpadding=0 border=0>
391  <tr>
392    <td>
393      &nbsp;
394    </td>
395    <td>
396
397<p>
398Sets the program to use.
399<p>
400<dl compact><dt><b>Remarks:</b></dt><dd>Note that this will create a fresh set of parameters from the new program being linked, so if you had previously set parameters you will have to set them again. </dd></dl>
401    </td>
402  </tr>
403</table>
404<a class="anchor" name="Ogre_1_1GpuProgramUsagea3" doxytag="Ogre::GpuProgramUsage::setProgramName" ></a><p>
405<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
406  <tr>
407    <td class="mdRow">
408      <table cellpadding="0" cellspacing="0" border="0">
409        <tr>
410          <td class="md" nowrap valign="top"> void Ogre::GpuProgramUsage::setProgramName </td>
411          <td class="md" valign="top">(&nbsp;</td>
412          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
413          <td class="mdname" nowrap> <em>name</em>, </td>
414        </tr>
415        <tr>
416          <td class="md" nowrap align="right"></td>
417          <td></td>
418          <td class="md" nowrap>bool&nbsp;</td>
419          <td class="mdname" nowrap> <em>resetParams</em> = true</td>
420        </tr>
421        <tr>
422          <td></td>
423          <td class="md">)&nbsp;</td>
424          <td class="md" colspan="2"></td>
425        </tr>
426
427      </table>
428    </td>
429  </tr>
430</table>
431<table cellspacing=5 cellpadding=0 border=0>
432  <tr>
433    <td>
434      &nbsp;
435    </td>
436    <td>
437
438<p>
439Sets the name of the program to use.
440<p>
441<dl compact><dt><b>Parameters:</b></dt><dd>
442  <table border="0" cellspacing="2" cellpadding="0">
443    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the program to use </td></tr>
444    <tr><td valign=top><em>resetParams</em>&nbsp;</td><td>If true, this will create a fresh set of parameters from the new program being linked, so if you had previously set parameters you will have to set them again. If you set this to false, you must be absolutely sure that the parameters match perfectly, and in the case of named parameters refers to the indexes underlying them, not just the names. </td></tr>
445  </table>
446</dl>
447    </td>
448  </tr>
449</table>
450<hr><h2>Member Data Documentation</h2>
451<a class="anchor" name="Ogre_1_1GpuProgramUsagep2" doxytag="Ogre::GpuProgramUsage::mParameters" ></a><p>
452<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
453  <tr>
454    <td class="mdRow">
455      <table cellpadding="0" cellspacing="0" border="0">
456        <tr>
457          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1SharedPtr.html">GpuProgramParametersSharedPtr</a> <a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagep2">Ogre::GpuProgramUsage::mParameters</a><code> [protected]</code>
458      </table>
459    </td>
460  </tr>
461</table>
462<table cellspacing=5 cellpadding=0 border=0>
463  <tr>
464    <td>
465      &nbsp;
466    </td>
467    <td>
468
469<p>
470program parameters
471<p>
472
473<p>
474Definition at line <a class="el" href="OgreGpuProgramUsage_8h-source.html#l00070">70</a> of file <a class="el" href="OgreGpuProgramUsage_8h-source.html">OgreGpuProgramUsage.h</a>.    </td>
475  </tr>
476</table>
477<a class="anchor" name="Ogre_1_1GpuProgramUsagep1" doxytag="Ogre::GpuProgramUsage::mProgram" ></a><p>
478<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
479  <tr>
480    <td class="mdRow">
481      <table cellpadding="0" cellspacing="0" border="0">
482        <tr>
483          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1GpuProgramPtr.html">GpuProgramPtr</a> <a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagep1">Ogre::GpuProgramUsage::mProgram</a><code> [protected]</code>
484      </table>
485    </td>
486  </tr>
487</table>
488<table cellspacing=5 cellpadding=0 border=0>
489  <tr>
490    <td>
491      &nbsp;
492    </td>
493    <td>
494
495<p>
496
497<p>
498Definition at line <a class="el" href="OgreGpuProgramUsage_8h-source.html#l00067">67</a> of file <a class="el" href="OgreGpuProgramUsage_8h-source.html">OgreGpuProgramUsage.h</a>.    </td>
499  </tr>
500</table>
501<a class="anchor" name="Ogre_1_1GpuProgramUsagep0" doxytag="Ogre::GpuProgramUsage::mType" ></a><p>
502<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
503  <tr>
504    <td class="mdRow">
505      <table cellpadding="0" cellspacing="0" border="0">
506        <tr>
507          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a653">GpuProgramType</a> <a class="el" href="classOgre_1_1GpuProgramUsage.html#Ogre_1_1GpuProgramUsagep0">Ogre::GpuProgramUsage::mType</a><code> [protected]</code>
508      </table>
509    </td>
510  </tr>
511</table>
512<table cellspacing=5 cellpadding=0 border=0>
513  <tr>
514    <td>
515      &nbsp;
516    </td>
517    <td>
518
519<p>
520
521<p>
522Definition at line <a class="el" href="OgreGpuProgramUsage_8h-source.html#l00065">65</a> of file <a class="el" href="OgreGpuProgramUsage_8h-source.html">OgreGpuProgramUsage.h</a>.    </td>
523  </tr>
524</table>
525<hr>The documentation for this class was generated from the following file:<ul>
526<li><a class="el" href="OgreGpuProgramUsage_8h-source.html">OgreGpuProgramUsage.h</a></ul>
527<hr>
528<p>
529Copyright &copy; 2000-2005 by The OGRE Team<br />
530<!--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/>
531This 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/>
532                <!--/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#">
533                <Work rdf:about="">
534                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
535        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
536                </Work>
537                <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> -->
538
539Last modified Sun Feb 12 13:00:38 2006
540</p>
541</body>
542</html>
Note: See TracBrowser for help on using the repository browser.