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-2013 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);
66 
68  void setOutputName(const String &out);
70  const String &getOutputName() const;
71 
75  void setOnlyInitial(bool value);
79 
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 
127  void removePass(size_t idx);
130  CompositionPass *getPass(size_t idx);
133  size_t getNumPasses();
134 
138 
141 
144 
147  bool _isSupported(void);
148 
149  private:
164  float mLodBias;
169  };
170 
173 }
174 
175 #include "OgreHeaderSuffix.h"
176 
177 #endif
#define _OgreExport
Definition: OgrePlatform.h:257
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Object representing one pass or operation in a composition sequence.
Object representing one render to a RenderTarget or Viewport in the Ogre Composition framework.
const String & getOutputName() const
Get output local texture name.
void setShadowsEnabled(bool enabled)
Set whether shadows are enabled in this target pass.
void removeAllPasses()
Remove all passes.
CompositionPass * getPass(size_t idx)
Get a pass.
uint32 mVisibilityMask
Visibility mask for this render.
VectorIterator< Passes > PassIterator
const String & getMaterialScheme(void) const
Get the material scheme used by this target pass.
void removePass(size_t idx)
Remove a pass.
void setMaterialScheme(const String &schemeName)
Set the material scheme used by this target pass.
float mLodBias
LOD bias of this render.
CompositionTechnique * mParent
Parent technique.
bool _isSupported(void)
Determine if this target pass is supported on the current rendering device.
void setVisibilityMask(uint32 mask)
Set the scene visibility mask used by this pass.
CompositionTargetPass(CompositionTechnique *parent)
String mOutputName
(local) output texture
float getLodBias()
Get the scene LOD bias used by this pass.
bool mOnlyInitial
This target pass is only executed initially after the effect has been enabled.
CompositionPass * createPass()
Create a new pass, and return a pointer to it.
PassIterator getPassIterator(void)
Get an iterator over the Passes in this TargetPass.
size_t getNumPasses()
Get the number of passes.
CompositionTechnique * getParent()
Get parent object.
void setOnlyInitial(bool value)
Set "only initial" flag.
uint32 getVisibilityMask()
Get the scene visibility mask used by this pass.
InputMode
Input mode of a TargetPass.
bool getOnlyInitial()
Get "only initial" flag.
String mMaterialScheme
Material scheme name.
void setInputMode(InputMode mode)
Set input mode of this TargetPass.
void setOutputName(const String &out)
Set output local texture name.
bool getShadowsEnabled(void) const
Get whether shadows are enabled in this target pass.
vector< CompositionPass * >::type Passes
InputMode getInputMode() const
Get input mode.
void setLodBias(float bias)
Set the scene LOD bias used by this pass.
Base composition technique, can be subclassed in plugins.
Concrete IteratorWrapper for nonconst access to the underlying container.
unsigned int uint32
Definition: OgrePlatform.h:359
_StringBase String

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.