OGRE: OgreCompositionTargetPass.h Source File - OGRE Documentation

# OgreCompositionTargetPass.h

Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004     (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028 #ifndef __CompositionTargetPass_H__
    00029 #define __CompositionTargetPass_H__
    00030
    00031 #include "OgrePrerequisites.h"
    00032 #include "OgreIteratorWrappers.h"
    00033
    00034 namespace Ogre {
    00044     class _OgreExport CompositionTargetPass : public CompositorInstAlloc
    00045     {
    00046     public:
    00047         CompositionTargetPass(CompositionTechnique *parent);
    00048         ~CompositionTargetPass();
    00049
    00052         enum InputMode
    00053         {
    00054             IM_NONE,        // No input
    00055             IM_PREVIOUS     // Output of previous Composition in chain
    00056         };
    00057         typedef vector<CompositionPass *>::type Passes;
    00058         typedef VectorIterator<Passes> PassIterator;
    00059
    00062         void setInputMode(InputMode mode);
    00064         InputMode getInputMode() const;
    00065
    00067         void setOutputName(const String &out);
    00069         const String &getOutputName() const;
    00070
    00074         void setOnlyInitial(bool value);
    00077         bool getOnlyInitial();
    00078
    00081         void setVisibilityMask(uint32 mask);
    00084         uint32 getVisibilityMask();
    00085
    00092         void setMaterialScheme(const String& schemeName);
    00099         const String& getMaterialScheme(void) const;
    00100
    00106         void setShadowsEnabled(bool enabled);
    00112         bool getShadowsEnabled(void) const;
    00116         void setLodBias(float bias);
    00119         float getLodBias();
    00120
    00123         CompositionPass *createPass();
    00126         void removePass(size_t idx);
    00129         CompositionPass *getPass(size_t idx);
    00132         size_t getNumPasses();
    00133
    00136         void removeAllPasses();
    00137
    00139         PassIterator getPassIterator(void);
    00140
    00142         CompositionTechnique *getParent();
    00143
    00146         bool _isSupported(void);
    00147
    00148     private:
    00150         CompositionTechnique *mParent;
    00152         InputMode mInputMode;
    00154         String mOutputName;
    00156         Passes mPasses;
    00159         bool mOnlyInitial;
    00161         uint32 mVisibilityMask;
    00163         float mLodBias;
    00165         String mMaterialScheme;
    00167         bool mShadowsEnabled;
    00168     };
    00169
    00172 }
    00173
    00174 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:51