OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreCompositionTargetPass.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2014 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __CompositionTargetPass_H__
29 #define __CompositionTargetPass_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreIteratorWrappers.h"
33 #include "OgreHeaderPrefix.h"
34 
35 namespace Ogre {
46  {
47  public:
50 
53  enum InputMode
54  {
56  IM_PREVIOUS
57  };
60 
63  void setInputMode(InputMode mode);
65  InputMode getInputMode() const;
66 
68  void setOutputName(const String &out);
70  const String &getOutputName() const;
71 
75  void setOnlyInitial(bool value);
78  bool getOnlyInitial();
79 
82  void setVisibilityMask(uint32 mask);
85  uint32 getVisibilityMask();
86 
93  void setMaterialScheme(const String& schemeName);
100  const String& getMaterialScheme(void) const;
101 
107  void setShadowsEnabled(bool enabled);
113  bool getShadowsEnabled(void) const;
117  void setLodBias(float bias);
120  float getLodBias();
121 
124  CompositionPass *createPass();
127  void removePass(size_t idx);
130  CompositionPass *getPass(size_t idx);
133  size_t getNumPasses();
134 
137  void removeAllPasses();
138 
140  PassIterator getPassIterator(void);
141 
143  CompositionTechnique *getParent();
144 
147  bool _isSupported(void);
148 
149  private:
164  float mLodBias;
169  };
170 
173 }
174 
175 #include "OgreHeaderSuffix.h"
176 
177 #endif
CompositionTechnique * mParent
Parent technique.
unsigned int uint32
Definition: OgrePlatform.h:344
#define _OgreExport
Definition: OgrePlatform.h:260
String mOutputName
(local) output texture
Object representing one pass or operation in a composition sequence.
VectorIterator< Passes > PassIterator
vector< CompositionPass * >::type Passes
String mMaterialScheme
Material scheme name.
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Base composition technique, can be subclassed in plugins.
InputMode
Input mode of a TargetPass.
uint32 mVisibilityMask
Visibility mask for this render.
_StringBase String
Concrete IteratorWrapper for nonconst access to the underlying container.
float mLodBias
LOD bias of this render.
bool mOnlyInitial
This target pass is only executed initially after the effect has been enabled.
Object representing one render to a RenderTarget or Viewport in the Ogre Composition framework...