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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::RenderOperation 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::RenderOperation Class Reference</h1>'New' rendering operation using vertex buffers. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreRenderOperation_8h-source.html">OgreRenderOperation.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1RenderOperation-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 Types</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationw6">OperationType</a> { <br>
19&nbsp;&nbsp;<a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationw6Ogre_1_1RenderOperationw0">OT_POINT_LIST</a> =  1,
20<a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationw6Ogre_1_1RenderOperationw1">OT_LINE_LIST</a> =  2,
21<a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationw6Ogre_1_1RenderOperationw2">OT_LINE_STRIP</a> =  3,
22<a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationw6Ogre_1_1RenderOperationw3">OT_TRIANGLE_LIST</a> =  4,
23<br>
24&nbsp;&nbsp;<a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationw6Ogre_1_1RenderOperationw4">OT_TRIANGLE_STRIP</a> =  5,
25<a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationw6Ogre_1_1RenderOperationw5">OT_TRIANGLE_FAN</a> =  6
26<br>
27 }</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The rendering operation type to perform.  <a href="#Ogre_1_1RenderOperationw6">More...</a><br><br></td></tr>
30<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationa0">RenderOperation</a> ()</td></tr>
32
33<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
34<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1VertexData.html">VertexData</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationo0">vertexData</a></td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vertex source data.  <a href="#Ogre_1_1RenderOperationo0"></a><br><br></td></tr>
37<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationw6">OperationType</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationo1">operationType</a></td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The type of operation to perform.  <a href="#Ogre_1_1RenderOperationo1"></a><br><br></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationo2">useIndexes</a></td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specifies whether to use indexes to determine the vertices to use as input.  <a href="#Ogre_1_1RenderOperationo2"></a><br><br></td></tr>
43<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1IndexData.html">IndexData</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationo3">indexData</a></td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Index data - only valid if useIndexes is true.  <a href="#Ogre_1_1RenderOperationo3"></a><br><br></td></tr>
46<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Renderable.html">Renderable</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationo4">srcRenderable</a></td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Debug pointer back to renderable which created this.  <a href="#Ogre_1_1RenderOperationo4"></a><br><br></td></tr>
49</table>
50<hr><a name="_details"></a><h2>Detailed Description</h2>
51'New' rendering operation using vertex buffers.
52<p>
53
54<p>
55Definition at line <a class="el" href="OgreRenderOperation_8h-source.html#l00035">35</a> of file <a class="el" href="OgreRenderOperation_8h-source.html">OgreRenderOperation.h</a>.<hr><h2>Member Enumeration Documentation</h2>
56<a class="anchor" name="Ogre_1_1RenderOperationw6" doxytag="Ogre::RenderOperation::OperationType" ></a><p>
57<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
58  <tr>
59    <td class="mdRow">
60      <table cellpadding="0" cellspacing="0" border="0">
61        <tr>
62          <td class="md" nowrap valign="top"> enum <a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationw6">Ogre::RenderOperation::OperationType</a>
63      </table>
64    </td>
65  </tr>
66</table>
67<table cellspacing=5 cellpadding=0 border=0>
68  <tr>
69    <td>
70      &nbsp;
71    </td>
72    <td>
73
74<p>
75The rendering operation type to perform.
76<p>
77<dl compact><dt><b>Enumeration values: </b></dt><dd>
78<table border=0 cellspacing=2 cellpadding=0>
79<tr><td valign=top><em><a class="anchor" name="Ogre_1_1RenderOperationw6Ogre_1_1RenderOperationw0" doxytag="OT_POINT_LIST" ></a>OT_POINT_LIST</em>&nbsp;</td><td>
80A list of points, 1 vertex per point. </td></tr>
81<tr><td valign=top><em><a class="anchor" name="Ogre_1_1RenderOperationw6Ogre_1_1RenderOperationw1" doxytag="OT_LINE_LIST" ></a>OT_LINE_LIST</em>&nbsp;</td><td>
82A list of lines, 2 vertices per line. </td></tr>
83<tr><td valign=top><em><a class="anchor" name="Ogre_1_1RenderOperationw6Ogre_1_1RenderOperationw2" doxytag="OT_LINE_STRIP" ></a>OT_LINE_STRIP</em>&nbsp;</td><td>
84A strip of connected lines, 1 vertex per line plus 1 start vertex. </td></tr>
85<tr><td valign=top><em><a class="anchor" name="Ogre_1_1RenderOperationw6Ogre_1_1RenderOperationw3" doxytag="OT_TRIANGLE_LIST" ></a>OT_TRIANGLE_LIST</em>&nbsp;</td><td>
86A list of triangles, 3 vertices per triangle. </td></tr>
87<tr><td valign=top><em><a class="anchor" name="Ogre_1_1RenderOperationw6Ogre_1_1RenderOperationw4" doxytag="OT_TRIANGLE_STRIP" ></a>OT_TRIANGLE_STRIP</em>&nbsp;</td><td>
88A strip of triangles, 3 vertices for the first triangle, and 1 per triangle after that. </td></tr>
89<tr><td valign=top><em><a class="anchor" name="Ogre_1_1RenderOperationw6Ogre_1_1RenderOperationw5" doxytag="OT_TRIANGLE_FAN" ></a>OT_TRIANGLE_FAN</em>&nbsp;</td><td>
90A fan of triangles, 3 vertices for the first triangle, and 1 per triangle after that. </td></tr>
91</table>
92</dl>
93
94<p>
95Definition at line <a class="el" href="OgreRenderOperation_8h-source.html#l00038">38</a> of file <a class="el" href="OgreRenderOperation_8h-source.html">OgreRenderOperation.h</a>.    </td>
96  </tr>
97</table>
98<hr><h2>Constructor &amp; Destructor Documentation</h2>
99<a class="anchor" name="Ogre_1_1RenderOperationa0" doxytag="Ogre::RenderOperation::RenderOperation" ></a><p>
100<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
101  <tr>
102    <td class="mdRow">
103      <table cellpadding="0" cellspacing="0" border="0">
104        <tr>
105          <td class="md" nowrap valign="top"> Ogre::RenderOperation::RenderOperation </td>
106          <td class="md" valign="top">(&nbsp;</td>
107          <td class="mdname1" valign="top" nowrap>          </td>
108          <td class="md" valign="top">&nbsp;)&nbsp;</td>
109          <td class="md" nowrap></td>
110        </tr>
111
112      </table>
113    </td>
114  </tr>
115</table>
116<table cellspacing=5 cellpadding=0 border=0>
117  <tr>
118    <td>
119      &nbsp;
120    </td>
121    <td>
122
123<p>
124
125<p>
126Definition at line <a class="el" href="OgreRenderOperation_8h-source.html#l00071">71</a> of file <a class="el" href="OgreRenderOperation_8h-source.html">OgreRenderOperation.h</a>.    </td>
127  </tr>
128</table>
129<hr><h2>Member Data Documentation</h2>
130<a class="anchor" name="Ogre_1_1RenderOperationo3" doxytag="Ogre::RenderOperation::indexData" ></a><p>
131<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
132  <tr>
133    <td class="mdRow">
134      <table cellpadding="0" cellspacing="0" border="0">
135        <tr>
136          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1IndexData.html">IndexData</a>* <a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationo3">Ogre::RenderOperation::indexData</a>
137      </table>
138    </td>
139  </tr>
140</table>
141<table cellspacing=5 cellpadding=0 border=0>
142  <tr>
143    <td>
144      &nbsp;
145    </td>
146    <td>
147
148<p>
149Index data - only valid if useIndexes is true.
150<p>
151
152<p>
153Definition at line <a class="el" href="OgreRenderOperation_8h-source.html#l00066">66</a> of file <a class="el" href="OgreRenderOperation_8h-source.html">OgreRenderOperation.h</a>.    </td>
154  </tr>
155</table>
156<a class="anchor" name="Ogre_1_1RenderOperationo1" doxytag="Ogre::RenderOperation::operationType" ></a><p>
157<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
158  <tr>
159    <td class="mdRow">
160      <table cellpadding="0" cellspacing="0" border="0">
161        <tr>
162          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationw6">OperationType</a> <a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationo1">Ogre::RenderOperation::operationType</a>
163      </table>
164    </td>
165  </tr>
166</table>
167<table cellspacing=5 cellpadding=0 border=0>
168  <tr>
169    <td>
170      &nbsp;
171    </td>
172    <td>
173
174<p>
175The type of operation to perform.
176<p>
177
178<p>
179Definition at line <a class="el" href="OgreRenderOperation_8h-source.html#l00057">57</a> of file <a class="el" href="OgreRenderOperation_8h-source.html">OgreRenderOperation.h</a>.    </td>
180  </tr>
181</table>
182<a class="anchor" name="Ogre_1_1RenderOperationo4" doxytag="Ogre::RenderOperation::srcRenderable" ></a><p>
183<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
184  <tr>
185    <td class="mdRow">
186      <table cellpadding="0" cellspacing="0" border="0">
187        <tr>
188          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Renderable.html">Renderable</a>* <a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationo4">Ogre::RenderOperation::srcRenderable</a>
189      </table>
190    </td>
191  </tr>
192</table>
193<table cellspacing=5 cellpadding=0 border=0>
194  <tr>
195    <td>
196      &nbsp;
197    </td>
198    <td>
199
200<p>
201Debug pointer back to renderable which created this.
202<p>
203
204<p>
205Definition at line <a class="el" href="OgreRenderOperation_8h-source.html#l00068">68</a> of file <a class="el" href="OgreRenderOperation_8h-source.html">OgreRenderOperation.h</a>.    </td>
206  </tr>
207</table>
208<a class="anchor" name="Ogre_1_1RenderOperationo2" doxytag="Ogre::RenderOperation::useIndexes" ></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"> bool <a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationo2">Ogre::RenderOperation::useIndexes</a>
215      </table>
216    </td>
217  </tr>
218</table>
219<table cellspacing=5 cellpadding=0 border=0>
220  <tr>
221    <td>
222      &nbsp;
223    </td>
224    <td>
225
226<p>
227Specifies whether to use indexes to determine the vertices to use as input.
228<p>
229If false, the vertices are simply read in sequence to define the primitives. If true, indexes are used instead to identify vertices anywhere in the buffer, and allowing vertices to be used more than once. If true, then the indexBuffer, indexStart and numIndexes properties must be valid.
230<p>
231Definition at line <a class="el" href="OgreRenderOperation_8h-source.html#l00063">63</a> of file <a class="el" href="OgreRenderOperation_8h-source.html">OgreRenderOperation.h</a>.    </td>
232  </tr>
233</table>
234<a class="anchor" name="Ogre_1_1RenderOperationo0" doxytag="Ogre::RenderOperation::vertexData" ></a><p>
235<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
236  <tr>
237    <td class="mdRow">
238      <table cellpadding="0" cellspacing="0" border="0">
239        <tr>
240          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1VertexData.html">VertexData</a>* <a class="el" href="classOgre_1_1RenderOperation.html#Ogre_1_1RenderOperationo0">Ogre::RenderOperation::vertexData</a>
241      </table>
242    </td>
243  </tr>
244</table>
245<table cellspacing=5 cellpadding=0 border=0>
246  <tr>
247    <td>
248      &nbsp;
249    </td>
250    <td>
251
252<p>
253Vertex source data.
254<p>
255
256<p>
257Definition at line <a class="el" href="OgreRenderOperation_8h-source.html#l00054">54</a> of file <a class="el" href="OgreRenderOperation_8h-source.html">OgreRenderOperation.h</a>.    </td>
258  </tr>
259</table>
260<hr>The documentation for this class was generated from the following file:<ul>
261<li><a class="el" href="OgreRenderOperation_8h-source.html">OgreRenderOperation.h</a></ul>
262<hr>
263<p>
264Copyright &copy; 2000-2005 by The OGRE Team<br />
265<!--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/>
266This 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/>
267                <!--/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#">
268                <Work rdf:about="">
269                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
270        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
271                </Work>
272                <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> -->
273
274Last modified Sun Feb 12 13:02:22 2006
275</p>
276</body>
277</html>
Note: See TracBrowser for help on using the repository browser.