1 | <html> |
---|
2 | <head> |
---|
3 | <title>OgreCompositionTechnique.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 Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
---|
10 | <h1>OgreCompositionTechnique.h</h1><a href="OgreCompositionTechnique_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span> |
---|
11 | 00002 <span class="comment">-----------------------------------------------------------------------------</span> |
---|
12 | 00003 <span class="comment">This source file is part of OGRE</span> |
---|
13 | 00004 <span class="comment"> (Object-oriented Graphics Rendering Engine)</span> |
---|
14 | 00005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span> |
---|
15 | 00006 <span class="comment"></span> |
---|
16 | 00007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span> |
---|
17 | 00008 <span class="comment">Also see acknowledgements in Readme.html</span> |
---|
18 | 00009 <span class="comment"></span> |
---|
19 | 00010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span> |
---|
20 | 00011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span> |
---|
21 | 00012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span> |
---|
22 | 00013 <span class="comment">version.</span> |
---|
23 | 00014 <span class="comment"></span> |
---|
24 | 00015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span> |
---|
25 | 00016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span> |
---|
26 | 00017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span> |
---|
27 | 00018 <span class="comment"></span> |
---|
28 | 00019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span> |
---|
29 | 00020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span> |
---|
30 | 00021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span> |
---|
31 | 00022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span> |
---|
32 | 00023 <span class="comment">-----------------------------------------------------------------------------</span> |
---|
33 | 00024 <span class="comment">*/</span> |
---|
34 | 00025 <span class="preprocessor">#ifndef __CompositionTechnique_H__</span> |
---|
35 | 00026 <span class="preprocessor"></span><span class="preprocessor">#define __CompositionTechnique_H__</span> |
---|
36 | 00027 <span class="preprocessor"></span> |
---|
37 | 00028 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span> |
---|
38 | 00029 <span class="preprocessor">#include "<a class="code" href="OgrePixelFormat_8h.html">OgrePixelFormat.h</a>"</span> |
---|
39 | 00030 <span class="preprocessor">#include "<a class="code" href="OgreIteratorWrappers_8h.html">OgreIteratorWrappers.h</a>"</span> |
---|
40 | 00031 |
---|
41 | 00032 <span class="keyword">namespace </span>Ogre { |
---|
42 | <a name="l00035"></a><a class="code" href="classOgre_1_1CompositionTechnique.html">00035</a> <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> CompositionTechnique |
---|
43 | 00036 { |
---|
44 | 00037 <span class="keyword">public</span>: |
---|
45 | 00038 CompositionTechnique(<a class="code" href="classOgre_1_1Compositor.html">Compositor</a> *parent); |
---|
46 | 00039 <span class="keyword">virtual</span> ~CompositionTechnique(); |
---|
47 | 00040 |
---|
48 | <a name="l00042"></a><a class="code" href="classOgre_1_1CompositionTechnique_1_1TextureDefinition.html">00042</a> <span class="keyword">class </span><a class="code" href="classOgre_1_1CompositionTechnique_1_1TextureDefinition.html">TextureDefinition</a> |
---|
49 | 00043 { |
---|
50 | 00044 <span class="keyword">public</span>: |
---|
51 | <a name="l00045"></a><a class="code" href="classOgre_1_1CompositionTechnique_1_1TextureDefinition.html#Ogre_1_1CompositionTechnique_1_1TextureDefinitiono0">00045</a> <a class="code" href="namespaceOgre.html#a471">String</a> name; |
---|
52 | <a name="l00046"></a><a class="code" href="classOgre_1_1CompositionTechnique_1_1TextureDefinition.html#Ogre_1_1CompositionTechnique_1_1TextureDefinitiono1">00046</a> size_t width; <span class="comment">// 0 means adapt to target width</span> |
---|
53 | <a name="l00047"></a><a class="code" href="classOgre_1_1CompositionTechnique_1_1TextureDefinition.html#Ogre_1_1CompositionTechnique_1_1TextureDefinitiono2">00047</a> size_t height; <span class="comment">// 0 means adapt to target height</span> |
---|
54 | <a name="l00048"></a><a class="code" href="classOgre_1_1CompositionTechnique_1_1TextureDefinition.html#Ogre_1_1CompositionTechnique_1_1TextureDefinitiono3">00048</a> <a class="code" href="namespaceOgre.html#a671">PixelFormat</a> format; |
---|
55 | 00049 |
---|
56 | <a name="l00050"></a><a class="code" href="classOgre_1_1CompositionTechnique_1_1TextureDefinition.html#Ogre_1_1CompositionTechnique_1_1TextureDefinitiona0">00050</a> <a class="code" href="classOgre_1_1CompositionTechnique_1_1TextureDefinition.html">TextureDefinition</a>() :width(0), height(0), format(<a class="code" href="namespaceOgre.html#a671a419">PF_R8G8B8A8</a>){} |
---|
57 | 00051 }; |
---|
58 | <a name="l00053"></a><a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquew0">00053</a> <span class="keyword">typedef</span> std::vector<CompositionTargetPass *> <a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquew0">TargetPasses</a>; |
---|
59 | <a name="l00054"></a><a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquew1">00054</a> <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1VectorIterator.html">VectorIterator<TargetPasses></a> <a class="code" href="classOgre_1_1VectorIterator.html">TargetPassIterator</a>; |
---|
60 | <a name="l00055"></a><a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquew2">00055</a> <span class="keyword">typedef</span> std::vector<TextureDefinition*> <a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquew2">TextureDefinitions</a>; |
---|
61 | <a name="l00056"></a><a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquew3">00056</a> <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1VectorIterator.html">VectorIterator<TextureDefinitions></a> <a class="code" href="classOgre_1_1VectorIterator.html">TextureDefinitionIterator</a>; |
---|
62 | 00057 |
---|
63 | 00061 <a class="code" href="classOgre_1_1CompositionTechnique_1_1TextureDefinition.html">TextureDefinition</a> *createTextureDefinition(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a> &name); |
---|
64 | 00062 |
---|
65 | 00065 <span class="keywordtype">void</span> removeTextureDefinition(size_t idx); |
---|
66 | 00066 |
---|
67 | 00069 <a class="code" href="classOgre_1_1CompositionTechnique_1_1TextureDefinition.html">TextureDefinition</a> *getTextureDefinition(size_t idx); |
---|
68 | 00070 |
---|
69 | 00073 size_t getNumTextureDefinitions(); |
---|
70 | 00074 |
---|
71 | 00077 <span class="keywordtype">void</span> removeAllTextureDefinitions(); |
---|
72 | 00078 |
---|
73 | 00080 <a class="code" href="classOgre_1_1VectorIterator.html">TextureDefinitionIterator</a> getTextureDefinitionIterator(<span class="keywordtype">void</span>); |
---|
74 | 00081 |
---|
75 | 00084 <a class="code" href="classOgre_1_1CompositionTargetPass.html">CompositionTargetPass</a> *createTargetPass(); |
---|
76 | 00085 |
---|
77 | 00088 <span class="keywordtype">void</span> removeTargetPass(size_t idx); |
---|
78 | 00089 |
---|
79 | 00092 <a class="code" href="classOgre_1_1CompositionTargetPass.html">CompositionTargetPass</a> *getTargetPass(size_t idx); |
---|
80 | 00093 |
---|
81 | 00096 size_t getNumTargetPasses(); |
---|
82 | 00097 |
---|
83 | 00100 <span class="keywordtype">void</span> removeAllTargetPasses(); |
---|
84 | 00101 |
---|
85 | 00103 <a class="code" href="classOgre_1_1VectorIterator.html">TargetPassIterator</a> getTargetPassIterator(<span class="keywordtype">void</span>); |
---|
86 | 00104 |
---|
87 | 00107 <a class="code" href="classOgre_1_1CompositionTargetPass.html">CompositionTargetPass</a> *getOutputTargetPass(); |
---|
88 | 00108 |
---|
89 | 00112 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isSupported(<span class="keywordtype">bool</span> allowTextureDegradation); |
---|
90 | 00113 |
---|
91 | 00116 <span class="keyword">virtual</span> <a class="code" href="classOgre_1_1CompositorInstance.html">CompositorInstance</a> *createInstance(<a class="code" href="classOgre_1_1CompositorChain.html">CompositorChain</a> *chain); |
---|
92 | 00117 |
---|
93 | 00120 <span class="keyword">virtual</span> <span class="keywordtype">void</span> destroyInstance(<a class="code" href="classOgre_1_1CompositorInstance.html">CompositorInstance</a> *instance); |
---|
94 | 00121 |
---|
95 | 00123 <a class="code" href="classOgre_1_1Compositor.html">Compositor</a> *getParent(); |
---|
96 | 00124 <span class="keyword">private</span>: |
---|
97 | <a name="l00126"></a><a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquer0">00126</a> <a class="code" href="classOgre_1_1Compositor.html">Compositor</a> *mParent; |
---|
98 | <a name="l00128"></a><a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquer1">00128</a> <a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquew2">TextureDefinitions</a> mTextureDefinitions; |
---|
99 | 00129 |
---|
100 | <a name="l00131"></a><a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquer2">00131</a> <a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquew0">TargetPasses</a> mTargetPasses; |
---|
101 | <a name="l00133"></a><a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquer3">00133</a> <a class="code" href="classOgre_1_1CompositionTargetPass.html">CompositionTargetPass</a> *mOutputTarget; |
---|
102 | 00134 |
---|
103 | <a name="l00136"></a><a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquey0">00136</a> <span class="keyword">typedef</span> std::vector<CompositorInstance *> <a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquey0">Instances</a>; |
---|
104 | <a name="l00137"></a><a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquer4">00137</a> <a class="code" href="classOgre_1_1CompositionTechnique.html#Ogre_1_1CompositionTechniquey0">Instances</a> mInstances; |
---|
105 | 00138 }; |
---|
106 | 00139 |
---|
107 | 00140 } |
---|
108 | 00141 |
---|
109 | 00142 <span class="preprocessor">#endif</span> |
---|
110 | </pre></div><hr> |
---|
111 | <p> |
---|
112 | Copyright © 2000-2005 by The OGRE Team<br /> |
---|
113 | <!--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/> |
---|
114 | This 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/> |
---|
115 | <!--/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#"> |
---|
116 | <Work rdf:about=""> |
---|
117 | <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" /> |
---|
118 | <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" /> |
---|
119 | </Work> |
---|
120 | <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> --> |
---|
121 | |
---|
122 | Last modified Sun Mar 12 14:37:38 2006 |
---|
123 | </p> |
---|
124 | </body> |
---|
125 | </html> |
---|