OgreCompositionTargetPass.h
Go to the documentation of this file.
/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2013 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __CompositionTargetPass_H__
#define __CompositionTargetPass_H__
#include "OgrePrerequisites.h"
#include "OgreIteratorWrappers.h"
#include "OgreHeaderPrefix.h"
namespace Ogre {
class _OgreExport CompositionTargetPass : public CompositorInstAlloc
{
public:
CompositionTargetPass(CompositionTechnique *parent);
~CompositionTargetPass();
enum InputMode
{
IM_NONE,
IM_PREVIOUS
};
typedef vector<CompositionPass *>::type Passes;
typedef VectorIterator<Passes> PassIterator;
void setInputMode(InputMode mode);
InputMode getInputMode() const;
void setOutputName(const String &out);
const String &getOutputName() const;
void setOnlyInitial(bool value);
bool getOnlyInitial();
void setVisibilityMask(uint32 mask);
uint32 getVisibilityMask();
void setMaterialScheme(const String& schemeName);
const String& getMaterialScheme(void) const;
void setShadowsEnabled(bool enabled);
bool getShadowsEnabled(void) const;
void setLodBias(float bias);
float getLodBias();
CompositionPass *createPass();
void removePass(size_t idx);
CompositionPass *getPass(size_t idx);
size_t getNumPasses();
void removeAllPasses();
PassIterator getPassIterator(void);
CompositionTechnique *getParent();
bool _isSupported(void);
private:
CompositionTechnique *mParent;
InputMode mInputMode;
String mOutputName;
Passes mPasses;
bool mOnlyInitial;
uint32 mVisibilityMask;
float mLodBias;
String mMaterialScheme;
bool mShadowsEnabled;
};
}
#include "OgreHeaderSuffix.h"
#endif
Ogre::VectorIterator
Concrete IteratorWrapper for nonconst access to the underlying container.
Definition: OgreIteratorWrapper.h:186
Ogre::CompositionTargetPass::mInputMode
InputMode mInputMode
Input mode.
Definition: OgreCompositionTargetPass.h:153
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::CompositionTargetPass
Object representing one render to a RenderTarget or Viewport in the Ogre Composition framework...
Definition: OgreCompositionTargetPass.h:45
Ogre::CompositionPass
Object representing one pass or operation in a composition sequence.
Definition: OgreCompositionPass.h:47
Ogre::CompositionTargetPass::mOnlyInitial
bool mOnlyInitial
This target pass is only executed initially after the effect has been enabled.
Definition: OgreCompositionTargetPass.h:160
Ogre::CompositionTargetPass::IM_NONE
Definition: OgreCompositionTargetPass.h:55
Ogre::CompositionTechnique
Base composition technique, can be subclassed in plugins.
Definition: OgreCompositionTechnique.h:45
Ogre::CompositionTargetPass::mMaterialScheme
String mMaterialScheme
Material scheme name.
Definition: OgreCompositionTargetPass.h:166
OgrePrerequisites.h
Ogre::CompositionTargetPass::PassIterator
VectorIterator< Passes > PassIterator
Definition: OgreCompositionTargetPass.h:59
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::CompositionTargetPass::mParent
CompositionTechnique * mParent
Parent technique.
Definition: OgreCompositionTargetPass.h:151
Ogre::CompositionTargetPass::mVisibilityMask
uint32 mVisibilityMask
Visibility mask for this render.
Definition: OgreCompositionTargetPass.h:162
OgreHeaderSuffix.h
Ogre::CompositionTargetPass::mPasses
Passes mPasses
Passes.
Definition: OgreCompositionTargetPass.h:157
Ogre::uint32
unsigned int uint32
Definition: OgrePlatform.h:359
OgreIteratorWrappers.h
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::CompositionTargetPass::mOutputName
String mOutputName
(local) output texture
Definition: OgreCompositionTargetPass.h:155
Ogre::vector
Definition: OgrePrerequisites.h:491
OgreHeaderPrefix.h
Ogre::CompositionTargetPass::mShadowsEnabled
bool mShadowsEnabled
Shadows option.
Definition: OgreCompositionTargetPass.h:168
Ogre::CompositionTargetPass::mLodBias
float mLodBias
LOD bias of this render.
Definition: OgreCompositionTargetPass.h:164
Ogre::CompositionTargetPass::InputMode
InputMode
Input mode of a TargetPass.
Definition: OgreCompositionTargetPass.h:53
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:58
Ogre::CompositionTargetPass::Passes
vector< CompositionPass * >::type Passes
Definition: OgreCompositionTargetPass.h:58

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