root/OpenSceneGraph/trunk/doc/doc++/osgUtil/RenderToTextureStage.html @ 3244

Revision 3244, 14.7 kB (checked in by robert, 10 years ago)

Updated docs

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2
3<HTML>
4<HEAD>
5   <TITLE>class  OSGUTIL_EXPORT osgUtil::RenderToTextureStage</TITLE>
6   <META NAME="GENERATOR" CONTENT="DOC++ 3.4.6">
7</HEAD>
8<BODY BGCOLOR="#ffffff">
9
10<H2>class  OSGUTIL_EXPORT <A HREF="#DOC.DOCU">osgUtil::RenderToTextureStage</A></H2></H2><BLOCKQUOTE> RenderStage which copies the final image to an attached texture or image.</BLOCKQUOTE>
11<HR>
12
13<H2>Inheritance:</H2>
14<APPLET CODE="ClassGraph.class" WIDTH=600 HEIGHT=125>
15<param name=classes value="Mosg::Object,M,CRenderBin,MRenderBin.html,CRenderStage,MRenderStage.html,CRenderToTextureStage,MRenderToTextureStage.html">
16<param name=before value="M,M,M,M">
17<param name=after value="Md_SPSP,Md_SP,Md_,M">
18<param name=indent value="0,1,2,3">
19<param name=arrowdir value="down">
20</APPLET>
21<HR>
22
23<DL>
24<P><DL>
25<DT><H3>Public Methods</H3><DD><DT>
26<IMG ALT="[more]" BORDER=0 SRC=icon1.gif> <B><A HREF="#DOC.2.20.1">RenderToTextureStage</A></B>()
27<DT>
28<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   osg::Object* <B><A HREF="#DOC.2.20.2">cloneType</A></B>() const
29<DT>
30<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   osg::Object* <B><A HREF="#DOC.2.20.3">clone</A></B>(const osg::CopyOp&amp;) const
31<DT>
32<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   bool <B><A HREF="#DOC.2.20.4">isSameKindAs</A></B>(const osg::Object* obj) const
33<DT>
34<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   const char* <B><A HREF="#DOC.2.20.5">libraryName</A></B>() const
35<DT>
36<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   const char* <B><A HREF="#DOC.2.20.6">className</A></B>() const
37<DT>
38<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.2.20.7">reset</A></B>()
39<DT>
40<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.20.8">setTexture</A></B>(osg::Texture2D* texture)
41<DT>
42<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>osg::Texture2D* <B><A HREF="#DOC.2.20.9">getTexture</A></B>()
43<DT>
44<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>void <B><A HREF="#DOC.2.20.10">setImage</A></B>(osg::Image* image)
45<DT>
46<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>osg::Image* <B><A HREF="#DOC.2.20.11">getImage</A></B>()
47<DT>
48<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   void <B><A HREF="#DOC.2.20.12">draw</A></B>(osg::State&amp; state, <!1><A HREF="RenderLeaf.html">RenderLeaf</A>*&amp; previous)
49</DL></P>
50
51<P><DL>
52<DT><H3>Protected Fields</H3><DD><DT>
53<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>osg::ref_ptr&lt;osg::Texture2D&gt;  <B><A HREF="#DOC.2.20.14">_texture</A></B>
54<DT>
55<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>osg::ref_ptr&lt;osg::Image&gt;  <B><A HREF="#DOC.2.20.15">_image</A></B>
56</DL></P>
57
58<P><DL>
59<DT><H3>Protected Methods</H3><DD><DT>
60<IMG ALT="[more]" BORDER=0 SRC=icon1.gif>virtual   <B><A HREF="#DOC.2.20.13">~RenderToTextureStage</A></B>()
61</DL></P>
62
63</DL>
64<HR><H3>Inherited from <A HREF="RenderStage.html">RenderStage</A>:</H3>
65<DL>
66<P><DL>
67<DT><H3>Public Methods</H3><DD><DT>
68<IMG ALT="o" SRC=icon2.gif>void <B>setViewport</B>(osg::Viewport* viewport)
69<DT>
70<IMG ALT="o" SRC=icon2.gif>const osg::Viewport* <B>getViewport</B>() const
71<DT>
72<IMG ALT="o" SRC=icon2.gif>osg::Viewport* <B>getViewport</B>()
73<DT>
74<IMG ALT="o" SRC=icon2.gif>void <B>setClearMask</B>(GLbitfield mask)
75<DT>
76<IMG ALT="o" SRC=icon2.gif>GLbitfield <B>getClearMask</B>() const
77<DT>
78<IMG ALT="o" SRC=icon2.gif>void <B>setColorMask</B>(osg::ColorMask* cm)
79<DT>
80<IMG ALT="o" SRC=icon2.gif>osg::ColorMask* <B>getColorMask</B>()
81<DT>
82<IMG ALT="o" SRC=icon2.gif>const osg::ColorMask* <B>getColorMask</B>() const
83<DT>
84<IMG ALT="o" SRC=icon2.gif>void <B>setClearColor</B>(const osg::Vec4&amp; color)
85<DT>
86<IMG ALT="o" SRC=icon2.gif>const osg::Vec4&amp; <B>getClearColor</B>() const
87<DT>
88<IMG ALT="o" SRC=icon2.gif>void <B>setClearAccum</B>(const osg::Vec4&amp; color)
89<DT>
90<IMG ALT="o" SRC=icon2.gif>const osg::Vec4&amp; <B>getClearAccum</B>() const
91<DT>
92<IMG ALT="o" SRC=icon2.gif>void <B>setClearDepth</B>(double <!1><A HREF="Statistics.html#DOC.2.24.32">depth</A>)
93<DT>
94<IMG ALT="o" SRC=icon2.gif>double <B>getClearDepth</B>() const
95<DT>
96<IMG ALT="o" SRC=icon2.gif>void <B>setClearStencil</B>(int stencil)
97<DT>
98<IMG ALT="o" SRC=icon2.gif>int <B>getClearStencil</B>() const
99<DT>
100<IMG ALT="o" SRC=icon2.gif>void <B>setRenderStageLighting</B>(<!1><A HREF="RenderStageLighting.html">RenderStageLighting</A>* rsl)
101<DT>
102<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderStageLighting.html">RenderStageLighting</A>* <B>getRenderStageLighting</B>() const
103<DT>
104<IMG ALT="o" SRC=icon2.gif>virtual   void <B>addPositionedAttribute</B>(osg::RefMatrix* matrix, const osg::StateAttribute* attr)
105<DT>
106<IMG ALT="o" SRC=icon2.gif>virtual   void <B>addPositionedTextureAttribute</B>(unsigned int textureUnit, osg::RefMatrix* matrix, const osg::StateAttribute* attr)
107<DT>
108<IMG ALT="o" SRC=icon2.gif>virtual   void <B>drawPreRenderStages</B>(osg::State&amp; state, <!1><A HREF="RenderLeaf.html">RenderLeaf</A>*&amp; previous)
109<DT>
110<IMG ALT="o" SRC=icon2.gif>virtual   void <B>drawImplementation</B>(osg::State&amp; state, <!1><A HREF="RenderLeaf.html">RenderLeaf</A>*&amp; previous)
111<DT>
112<IMG ALT="o" SRC=icon2.gif>void <B>addToDependencyList</B>(<!1><A HREF="RenderStage.html">RenderStage</A>* rs)
113<DT>
114<IMG ALT="o" SRC=icon2.gif>bool <B>getStats</B>(<!1><A HREF="Statistics.html">Statistics</A>* primStats)
115</DL></P>
116
117<P><DL>
118<DT><H3>Protected Fields</H3><DD><DT>
119<IMG ALT="o" SRC=icon2.gif>bool <B>_stageDrawnThisFrame</B>
120<DT>
121<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderStage.html#DOC.2.18.34">DependencyList</A> <B>_dependencyList</B>
122<DT>
123<IMG ALT="o" SRC=icon2.gif>osg::ref_ptr&lt;osg::Viewport&gt;  <B>_viewport</B>
124<DT>
125<IMG ALT="o" SRC=icon2.gif>GLbitfield <B>_clearMask</B>
126<DT>
127<IMG ALT="o" SRC=icon2.gif>osg::ref_ptr&lt;osg::ColorMask&gt;  <B>_colorMask</B>
128<DT>
129<IMG ALT="o" SRC=icon2.gif>osg::Vec4 <B>_clearColor</B>
130<DT>
131<IMG ALT="o" SRC=icon2.gif>osg::Vec4 <B>_clearAccum</B>
132<DT>
133<IMG ALT="o" SRC=icon2.gif>double <B>_clearDepth</B>
134<DT>
135<IMG ALT="o" SRC=icon2.gif>int <B>_clearStencil</B>
136<DT>
137<IMG ALT="o" SRC=icon2.gif>mutable osg::ref_ptr&lt;<!1><A HREF="RenderStageLighting.html">RenderStageLighting</A>&gt;  <B>_renderStageLighting</B>
138</DL></P>
139
140<P><DL>
141<DT><H3>Protected</H3><DD><DT>
142<IMG ALT="o" SRC=icon2.gif>typedef  std::vector&lt; osg::ref_ptr&lt;<!1><A HREF="RenderStage.html">RenderStage</A>&gt; &gt;  <B>DependencyList</B>
143</DL></P>
144
145</DL>
146<HR><H3>Inherited from <A HREF="RenderBin.html">RenderBin</A>:</H3>
147<DL>
148<P><DL>
149<DT><H3>Public Classes</H3><DD><DT>
150<IMG ALT="o" SRC=icon2.gif>enum  <B>SortMode</B>
151<DT>
152<IMG ALT="o" SRC=icon2.gif>struct  <B>SortCallback</B>: public osg::Referenced
153<DT>
154<IMG ALT="o" SRC=icon2.gif>struct  <B>DrawCallback</B>: public osg::Referenced
155</DL></P>
156
157<P><DL>
158<DT><H3>Public Methods</H3><DD><DT>
159<IMG ALT="o" SRC=icon2.gif>static   <!1><A HREF="RenderBin.html">RenderBin</A>* <B>createRenderBin</B>(const std::string&amp; binName)
160<DT>
161<IMG ALT="o" SRC=icon2.gif>static   <!1><A HREF="RenderBin.html">RenderBin</A>* <B>getRenderBinPrototype</B>(const std::string&amp; binName)
162<DT>
163<IMG ALT="o" SRC=icon2.gif>static   void <B>addRenderBinPrototype</B>(const std::string&amp; binName, <!1><A HREF="RenderBin.html">RenderBin</A>* proto)
164<DT>
165<IMG ALT="o" SRC=icon2.gif>static   void <B>removeRenderBinPrototype</B>(<!1><A HREF="RenderBin.html">RenderBin</A>* proto)
166<DT>
167<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderBin.html">RenderBin</A>* <B>getParent</B>()
168<DT>
169<IMG ALT="o" SRC=icon2.gif>const <!1><A HREF="RenderBin.html">RenderBin</A>* <B>getParent</B>() const
170<DT>
171<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderStage.html">RenderStage</A>* <B>getStage</B>()
172<DT>
173<IMG ALT="o" SRC=icon2.gif>const <!1><A HREF="RenderStage.html">RenderStage</A>* <B>getStage</B>() const
174<DT>
175<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderBin.html#DOC.2.13.2">RenderGraphList</A>&amp; <B>getRenderGraphList</B>()
176<DT>
177<IMG ALT="o" SRC=icon2.gif>const <!1><A HREF="RenderBin.html#DOC.2.13.2">RenderGraphList</A>&amp; <B>getRenderGraphList</B>() const
178<DT>
179<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderBin.html#DOC.2.13.3">RenderBinList</A>&amp; <B>getRenderBinList</B>()
180<DT>
181<IMG ALT="o" SRC=icon2.gif>const <!1><A HREF="RenderBin.html#DOC.2.13.3">RenderBinList</A>&amp; <B>getRenderBinList</B>() const
182<DT>
183<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderBin.html#DOC.2.13.1">RenderLeafList</A>&amp; <B>getRenderLeafList</B>()
184<DT>
185<IMG ALT="o" SRC=icon2.gif>const <!1><A HREF="RenderBin.html#DOC.2.13.1">RenderLeafList</A>&amp; <B>getRenderLeafList</B>() const
186<DT>
187<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderBin.html">RenderBin</A>* <B>find_or_insert</B>(int binNum, const std::string&amp; binName)
188<DT>
189<IMG ALT="o" SRC=icon2.gif>void <B>addRenderGraph</B>(<!1><A HREF="RenderGraph.html">RenderGraph</A>* rg)
190<DT>
191<IMG ALT="o" SRC=icon2.gif>void <B>sort</B>()
192<DT>
193<IMG ALT="o" SRC=icon2.gif>virtual   void <B>sortImplementation</B>()
194<DT>
195<IMG ALT="o" SRC=icon2.gif>void <B>setSortMode</B>(<!1><A HREF="RenderBin.html#DOC.2.13.8">SortMode</A> mode)
196<DT>
197<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderBin.html#DOC.2.13.8">SortMode</A> <B>getSortMode</B>() const
198<DT>
199<IMG ALT="o" SRC=icon2.gif>virtual   void <B>sortByState</B>()
200<DT>
201<IMG ALT="o" SRC=icon2.gif>virtual   void <B>sortFrontToBack</B>()
202<DT>
203<IMG ALT="o" SRC=icon2.gif>virtual   void <B>sortBackToFront</B>()
204<DT>
205<IMG ALT="o" SRC=icon2.gif>void <B>setSortCallback</B>(<!1><A HREF="RenderBin.html#DOC.2.13.36">SortCallback</A>* sortCallback)
206<DT>
207<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderBin.html#DOC.2.13.36">SortCallback</A>* <B>getSortCallback</B>()
208<DT>
209<IMG ALT="o" SRC=icon2.gif>const <!1><A HREF="RenderBin.html#DOC.2.13.36">SortCallback</A>* <B>getSortCallback</B>() const
210<DT>
211<IMG ALT="o" SRC=icon2.gif>void <B>setDrawCallback</B>(<!1><A HREF="RenderBin.html#DOC.2.13.42">DrawCallback</A>* drawCallback)
212<DT>
213<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderBin.html#DOC.2.13.42">DrawCallback</A>* <B>getDrawCallback</B>()
214<DT>
215<IMG ALT="o" SRC=icon2.gif>const <!1><A HREF="RenderBin.html#DOC.2.13.42">DrawCallback</A>* <B>getDrawCallback</B>() const
216<DT>
217<IMG ALT="o" SRC=icon2.gif>void <B>getPrims</B>(<!1><A HREF="Statistics.html">Statistics</A>* primStats)
218<DT>
219<IMG ALT="o" SRC=icon2.gif>bool <B>getPrims</B>(<!1><A HREF="Statistics.html">Statistics</A>* primStats, int nbin)
220</DL></P>
221
222<P><DL>
223<DT><H3>Public</H3><DD><DT>
224<IMG ALT="o" SRC=icon2.gif>typedef  std::vector&lt;<!1><A HREF="RenderLeaf.html">RenderLeaf</A>*&gt;  <B>RenderLeafList</B>
225<DT>
226<IMG ALT="o" SRC=icon2.gif>typedef  std::vector&lt;<!1><A HREF="RenderGraph.html">RenderGraph</A>*&gt;  <B>RenderGraphList</B>
227<DT>
228<IMG ALT="o" SRC=icon2.gif>typedef  std::map&lt; int, osg::ref_ptr&lt;<!1><A HREF="RenderBin.html">RenderBin</A>&gt; &gt;  <B>RenderBinList</B>
229</DL></P>
230
231<P><DL>
232<DT><H3>Protected Fields</H3><DD><DT>
233<IMG ALT="o" SRC=icon2.gif>int <B>_binNum</B>
234<DT>
235<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderBin.html">RenderBin</A>* <B>_parent</B>
236<DT>
237<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderStage.html">RenderStage</A>* <B>_stage</B>
238<DT>
239<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderBin.html#DOC.2.13.3">RenderBinList</A> <B>_bins</B>
240<DT>
241<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderBin.html#DOC.2.13.2">RenderGraphList</A> <B>_renderGraphList</B>
242<DT>
243<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderBin.html#DOC.2.13.1">RenderLeafList</A> <B>_renderLeafList</B>
244<DT>
245<IMG ALT="o" SRC=icon2.gif><!1><A HREF="RenderBin.html#DOC.2.13.8">SortMode</A> <B>_sortMode</B>
246<DT>
247<IMG ALT="o" SRC=icon2.gif>osg::ref_ptr&lt;<!1><A HREF="RenderBin.html#DOC.2.13.36">SortCallback</A>&gt;  <B>_sortCallback</B>
248<DT>
249<IMG ALT="o" SRC=icon2.gif>osg::ref_ptr&lt;<!1><A HREF="RenderBin.html#DOC.2.13.42">DrawCallback</A>&gt;  <B>_drawCallback</B>
250</DL></P>
251
252<P><DL>
253<DT><H3>Protected Methods</H3><DD><DT>
254<IMG ALT="o" SRC=icon2.gif>void <B>copyLeavesFromRenderGraphListToRenderLeafList</B>()
255</DL></P>
256
257</DL>
258
259<A NAME="DOC.DOCU"></A>
260<HR>
261<H2>Documentation</H2>
262<BLOCKQUOTE>
263RenderStage which copies the final image to an attached texture or image.
264Generally used as a pre-rendering stage.</BLOCKQUOTE>
265<DL>
266
267<A NAME="RenderToTextureStage"></A>
268<A NAME="DOC.2.20.1"></A>
269<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B> RenderToTextureStage()</B></TT>
270<DL><DT><DD></DL><P>
271<A NAME="cloneType"></A>
272<A NAME="DOC.2.20.2"></A>
273<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   osg::Object* cloneType() const </B></TT>
274<DL><DT><DD></DL><P>
275<A NAME="clone"></A>
276<A NAME="DOC.2.20.3"></A>
277<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   osg::Object* clone(const osg::CopyOp&amp;) const </B></TT>
278<DL><DT><DD></DL><P>
279<A NAME="isSameKindAs"></A>
280<A NAME="DOC.2.20.4"></A>
281<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   bool isSameKindAs(const osg::Object* obj) const </B></TT>
282<DL><DT><DD></DL><P>
283<A NAME="libraryName"></A>
284<A NAME="DOC.2.20.5"></A>
285<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   const char* libraryName() const </B></TT>
286<DL><DT><DD></DL><P>
287<A NAME="className"></A>
288<A NAME="DOC.2.20.6"></A>
289<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   const char* className() const </B></TT>
290<DL><DT><DD></DL><P>
291<A NAME="reset"></A>
292<A NAME="DOC.2.20.7"></A>
293<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void reset()</B></TT>
294<DL><DT><DD></DL><P>
295<A NAME="setTexture"></A>
296<A NAME="DOC.2.20.8"></A>
297<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setTexture(osg::Texture2D* texture)</B></TT>
298<DL><DT><DD></DL><P>
299<A NAME="getTexture"></A>
300<A NAME="DOC.2.20.9"></A>
301<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>osg::Texture2D* getTexture()</B></TT>
302<DL><DT><DD></DL><P>
303<A NAME="setImage"></A>
304<A NAME="DOC.2.20.10"></A>
305<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>void setImage(osg::Image* image)</B></TT>
306<DL><DT><DD></DL><P>
307<A NAME="getImage"></A>
308<A NAME="DOC.2.20.11"></A>
309<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>osg::Image* getImage()</B></TT>
310<DL><DT><DD></DL><P>
311<A NAME="draw"></A>
312<A NAME="DOC.2.20.12"></A>
313<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   void draw(osg::State&amp; state, <!1><A HREF="RenderLeaf.html">RenderLeaf</A>*&amp; previous)</B></TT>
314<DL><DT><DD></DL><P>
315<A NAME="~RenderToTextureStage"></A>
316<A NAME="DOC.2.20.13"></A>
317<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>virtual   ~RenderToTextureStage()</B></TT>
318<DL><DT><DD></DL><P>
319<A NAME="_texture"></A>
320<A NAME="DOC.2.20.14"></A>
321<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>osg::ref_ptr&lt;osg::Texture2D&gt;  _texture</B></TT>
322<DL><DT><DD></DL><P>
323<A NAME="_image"></A>
324<A NAME="DOC.2.20.15"></A>
325<DT><IMG ALT="o" BORDER=0 SRC=icon2.gif><TT><B>osg::ref_ptr&lt;osg::Image&gt;  _image</B></TT>
326<DL><DT><DD></DL><P></DL>
327
328<HR><DL><DT><B>This class has no child classes.</B></DL>
329
330<DL><DT><DD></DL><P><P><I><A HREF="index.html">Alphabetic index</A></I> <I><A HREF="HIER.html">HTML hierarchy of classes</A> or <A HREF="HIERjava.html">Java</A></I></P><HR>
331<BR>
332This page was generated with the help of <A HREF="http://www.linuxsupportline.com/~doc++">DOC++</A>.
333</BODY>
334</HTML>
Note: See TracBrowser for help on using the browser.