source: OGRE/trunk/ogrenew/Docs/api/html/OgreCompositorInstance_8h-source.html @ 692

Revision 692, 19.2 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>OgreCompositorInstance.h Source File - 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>OgreCompositorInstance.h</h1><a href="OgreCompositorInstance_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
1100002 <span class="comment">-----------------------------------------------------------------------------</span>
1200003 <span class="comment">This source file is part of OGRE</span>
1300004 <span class="comment">    (Object-oriented Graphics Rendering Engine)</span>
1400005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span>
1500006 <span class="comment"></span>
1600007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span>
1700008 <span class="comment">Also see acknowledgements in Readme.html</span>
1800009 <span class="comment"></span>
1900010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span>
2000011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span>
2100012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span>
2200013 <span class="comment">version.</span>
2300014 <span class="comment"></span>
2400015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span>
2500016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
2600017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span>
2700018 <span class="comment"></span>
2800019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span>
2900020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span>
3000021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span>
3100022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span>
3200023 <span class="comment">-----------------------------------------------------------------------------</span>
3300024 <span class="comment">*/</span>
3400025 <span class="preprocessor">#ifndef __CompositorInstance_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __CompositorInstance_H__</span>
3600027 <span class="preprocessor"></span>
3700028 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3800029 <span class="preprocessor">#include "<a class="code" href="OgreMaterial_8h.html">OgreMaterial.h</a>"</span>
3900030 <span class="preprocessor">#include "<a class="code" href="OgreTexture_8h.html">OgreTexture.h</a>"</span>
4000031 <span class="preprocessor">#include "<a class="code" href="OgreRenderQueue_8h.html">OgreRenderQueue.h</a>"</span>
4100032 <span class="keyword">namespace </span>Ogre {
42<a name="l00033"></a><a class="code" href="namespaceOgre.html#a140">00033</a>     <span class="keyword">const</span> size_t <a class="code" href="namespaceOgre.html#a140">RENDER_QUEUE_COUNT</a> = <a class="code" href="namespaceOgre.html#a674a486">RENDER_QUEUE_OVERLAY</a>+1;       
4300034             
44<a name="l00038"></a><a class="code" href="classOgre_1_1CompositorInstance.html">00038</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> CompositorInstance
4500039     {
4600040     <span class="keyword">public</span>:
4700041         CompositorInstance(<a class="code" href="classOgre_1_1Compositor.html">Compositor</a> *filter, <a class="code" href="classOgre_1_1CompositionTechnique.html">CompositionTechnique</a> *technique, <a class="code" href="classOgre_1_1CompositorChain.html">CompositorChain</a> *chain);
4800042         <span class="keyword">virtual</span> ~CompositorInstance();
49<a name="l00046"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1Listener.html">00046</a>         <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> Listener
5000047         {
5100048         <span class="keyword">public</span>:
5200049             <span class="keyword">virtual</span> ~Listener();
5300050
5400060             <span class="keyword">virtual</span> <span class="keywordtype">void</span> notifyMaterialSetup(<a class="code" href="namespaceOgre.html#a455">uint32</a> pass_id, <a class="code" href="classOgre_1_1MaterialPtr.html">MaterialPtr</a> &amp;mat);
5500061
5600070             <span class="keyword">virtual</span> <span class="keywordtype">void</span> notifyMaterialRender(<a class="code" href="namespaceOgre.html#a455">uint32</a> pass_id, <a class="code" href="classOgre_1_1MaterialPtr.html">MaterialPtr</a> &amp;mat);
5700071         };
58<a name="l00076"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1RenderSystemOperation.html">00076</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1CompositorInstance_1_1RenderSystemOperation.html">RenderSystemOperation</a>
5900077         {
6000078         <span class="keyword">public</span>:
6100079             <span class="keyword">virtual</span> ~<a class="code" href="classOgre_1_1CompositorInstance_1_1RenderSystemOperation.html">RenderSystemOperation</a>();
6200081             <span class="keyword">virtual</span> <span class="keywordtype">void</span> execute(<a class="code" href="classOgre_1_1SceneManager.html">SceneManager</a> *sm, <a class="code" href="classOgre_1_1RenderSystem.html">RenderSystem</a> *rs) = 0;
6300082         };
64<a name="l00083"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancew0">00083</a>         <span class="keyword">typedef</span> std::map&lt;int, MaterialPtr&gt; <a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancew0">QuadMaterialMap</a>;
65<a name="l00084"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancew1">00084</a>         <span class="keyword">typedef</span> std::pair&lt;int, RenderSystemOperation*&gt; <a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancew1">RenderSystemOpPair</a>;
66<a name="l00085"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancew2">00085</a>         <span class="keyword">typedef</span> std::vector&lt;RenderSystemOpPair&gt; <a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancew2">RenderSystemOpPairs</a>;
67<a name="l00088"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html">00088</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html">TargetOperation</a>
6800089         {
6900090         <span class="keyword">public</span>:
70<a name="l00091"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationa0">00091</a>             <a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html">TargetOperation</a>()
7100092             {
7200093             }
73<a name="l00094"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationa1">00094</a>             <a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html">TargetOperation</a>(<a class="code" href="classOgre_1_1RenderTarget.html">RenderTarget</a> *target):
7400095                 target(target), currentQueueGroupID(0), visibilityMask(0xFFFFFFFF),
7500096                 lodBias(1.0f),
7600097                 onlyInitial(false), hasBeenRendered(false), findVisibleObjects(false)
7700098             {
7800099             }
79<a name="l00101"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationo0">00101</a>             <a class="code" href="classOgre_1_1RenderTarget.html">RenderTarget</a> *target;
8000102
81<a name="l00104"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationo1">00104</a>             <span class="keywordtype">int</span> currentQueueGroupID;
8200105
83<a name="l00108"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationo2">00108</a>             <a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancew2">RenderSystemOpPairs</a> renderSystemOperations;
8400109
85<a name="l00112"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationo3">00112</a>             <a class="code" href="namespaceOgre.html#a455">uint32</a> visibilityMask;
8600113             
87<a name="l00116"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationo4">00116</a>             <span class="keywordtype">float</span> lodBias;
8800117             
89<a name="l00120"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationw0">00120</a>             <span class="keyword">typedef</span> std::bitset&lt;RENDER_QUEUE_COUNT&gt; <a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationw0">RenderQueueBitSet</a>;
9000121
91<a name="l00123"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationo5">00123</a>             <a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationw0">RenderQueueBitSet</a> renderQueues;
9200124             
93<a name="l00127"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationo6">00127</a>             <span class="keywordtype">bool</span> onlyInitial;
94<a name="l00131"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationo7">00131</a>             <span class="keywordtype">bool</span> hasBeenRendered;
95<a name="l00134"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationo8">00134</a>             <span class="keywordtype">bool</span> findVisibleObjects;
96<a name="l00136"></a><a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html#Ogre_1_1CompositorInstance_1_1TargetOperationo9">00136</a>             <a class="code" href="namespaceOgre.html#a471">String</a> materialScheme;
9700137         };
98<a name="l00138"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancew3">00138</a>         <span class="keyword">typedef</span> std::vector&lt;TargetOperation&gt; <a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancew3">CompiledState</a>;
9900139         
10000143         <span class="keywordtype">void</span> setEnabled(<span class="keywordtype">bool</span> value);
10100144         
10200147         <span class="keywordtype">bool</span> getEnabled();
10300148
10400152         <span class="keyword">virtual</span> <span class="keywordtype">void</span> _prepareForCompilation();
10500153         
10600157         <span class="keyword">virtual</span> <span class="keywordtype">void</span> _compileTargetOperations(<a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancew3">CompiledState</a> &amp;compiledState);
10700158         
10800162         <span class="keyword">virtual</span> <span class="keywordtype">void</span> _compileOutputOperation(<a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html">TargetOperation</a> &amp;finalState);
10900163         
11000166         <a class="code" href="classOgre_1_1Compositor.html">Compositor</a> *getCompositor();
11100167         
11200170         <a class="code" href="classOgre_1_1CompositionTechnique.html">CompositionTechnique</a> *getTechnique();
11300171
11400174         <a class="code" href="classOgre_1_1CompositorChain.html">CompositorChain</a> *getChain();
11500175
11600181         <span class="keywordtype">void</span> addListener(Listener *l);
11700182
11800186         <span class="keywordtype">void</span> removeListener(Listener *l);
11900187
12000190         <span class="keywordtype">void</span> _fireNotifyMaterialSetup(<a class="code" href="namespaceOgre.html#a455">uint32</a> pass_id, <a class="code" href="classOgre_1_1MaterialPtr.html">MaterialPtr</a> &amp;mat);
12100191
12200194         <span class="keywordtype">void</span> _fireNotifyMaterialRender(<a class="code" href="namespaceOgre.html#a455">uint32</a> pass_id, <a class="code" href="classOgre_1_1MaterialPtr.html">MaterialPtr</a> &amp;mat);
12300195     <span class="keyword">private</span>:
124<a name="l00197"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancer0">00197</a>         <a class="code" href="classOgre_1_1Compositor.html">Compositor</a> *mCompositor;
125<a name="l00199"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancer1">00199</a>         <a class="code" href="classOgre_1_1CompositionTechnique.html">CompositionTechnique</a> *mTechnique;
126<a name="l00201"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancer2">00201</a>         <a class="code" href="classOgre_1_1CompositorChain.html">CompositorChain</a> *mChain;
127<a name="l00203"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancer3">00203</a>         <span class="keywordtype">bool</span> mEnabled;
128<a name="l00205"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancey0">00205</a>         <span class="keyword">typedef</span> std::map&lt;String,TexturePtr&gt; <a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancey0">LocalTextureMap</a>;
129<a name="l00206"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancer4">00206</a>         <a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancey0">LocalTextureMap</a> mLocalTextures;
13000207
131<a name="l00211"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancey1">00211</a>         <span class="keyword">typedef</span> std::vector&lt;RenderSystemOperation*&gt; <a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancey1">RenderSystemOperations</a>;
132<a name="l00212"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancer5">00212</a>         <a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancey1">RenderSystemOperations</a> mRenderSystemOperations;
13300213
134<a name="l00215"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancey2">00215</a>         <span class="keyword">typedef</span> std::vector&lt;Listener*&gt; <a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancey2">Listeners</a>;
135<a name="l00216"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancer6">00216</a>         <a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancey2">Listeners</a> mListeners;
13600217         
137<a name="l00219"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancer7">00219</a>         CompositorInstance *mPreviousInstance;
13800220         
13900224         <span class="keyword">virtual</span> <span class="keywordtype">void</span> collectPasses(<a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html">TargetOperation</a> &amp;finalState, <a class="code" href="classOgre_1_1CompositionTargetPass.html">CompositionTargetPass</a> *target);
14000225         
14100230         <a class="code" href="classOgre_1_1MaterialPtr.html">MaterialPtr</a> createLocalMaterial();
14200231         
14300234         <span class="keywordtype">void</span> createResources();
14400235         
14500238         <span class="keywordtype">void</span> freeResources();
14600239
14700242         <span class="keywordtype">void</span> clearCompilationState();
14800243         
14900246         <a class="code" href="classOgre_1_1RenderTarget.html">RenderTarget</a> *getTargetForTex(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a> &amp;name);
15000247         
15100250         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a> &amp;getSourceForTex(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a> &amp;name);
15200251
15300255         <span class="keywordtype">void</span> queueRenderSystemOp(<a class="code" href="classOgre_1_1CompositorInstance_1_1TargetOperation.html">TargetOperation</a> &amp;finalState, <a class="code" href="classOgre_1_1CompositorInstance_1_1RenderSystemOperation.html">RenderSystemOperation</a> *op);
15400256         
155<a name="l00257"></a><a class="code" href="classOgre_1_1CompositorInstance.html#Ogre_1_1CompositorInstancen0">00257</a>         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classOgre_1_1CompositorChain.html">CompositorChain</a>;
15600258     };
15700259 }
15800260
15900261 <span class="preprocessor">#endif</span>
160</pre></div><hr>
161<p>
162Copyright &copy; 2000-2005 by The OGRE Team<br />
163<!--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/>
164This 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/>
165                <!--/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#">
166                <Work rdf:about="">
167                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
168        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
169                </Work>
170                <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> -->
171
172Last modified Sun Mar 12 14:37:39 2006
173</p>
174</body>
175</html>
Note: See TracBrowser for help on using the repository browser.