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-2006 Torus Knot Software Ltd
    00008 Also see acknowledgements in Readme.html
    00009
    00010 This program is free software; you can redistribute it and/or modify it under
    00011 the terms of the GNU Lesser General Public License as published by the Free Software
    00012 Foundation; either version 2 of the License, or (at your option) any later
    00013 version.
    00014
    00015 This program is distributed in the hope that it will be useful, but WITHOUT
    00016 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    00017 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
    00018
    00019 You should have received a copy of the GNU Lesser General Public License along with
    00020 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
    00021 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
    00022 http://www.gnu.org/copyleft/lesser.txt.
    00023
    00024 You may alternatively use this source under the terms of a specific version of
    00025 the OGRE Unrestricted License provided you have obtained such a license from
    00026 Torus Knot Software Ltd.
    00027 -----------------------------------------------------------------------------
    00028 */
    00029 #ifndef __CompositionTargetPass_H__
    00030 #define __CompositionTargetPass_H__
    00031
    00032 #include "OgrePrerequisites.h"
    00033 #include "OgreIteratorWrappers.h"
    00034
    00035 namespace Ogre {
    00039     class _OgreExport CompositionTargetPass : public CompositorInstAlloc
    00040     {
    00041     public:
    00042         CompositionTargetPass(CompositionTechnique *parent);
    00043         ~CompositionTargetPass();
    00044
    00047         enum InputMode
    00048         {
    00049             IM_NONE,        // No input
    00050             IM_PREVIOUS     // Output of previous Composition in chain
    00051         };
    00052         typedef std::vector<CompositionPass *> Passes;
    00053         typedef VectorIterator<Passes> PassIterator;
    00054
    00057         void setInputMode(InputMode mode);
    00059         InputMode getInputMode() const;
    00060
    00062         void setOutputName(const String &out);
    00064         const String &getOutputName() const;
    00065
    00069         void setOnlyInitial(bool value);
    00072         bool getOnlyInitial();
    00073
    00076         void setVisibilityMask(uint32 mask);
    00079         uint32 getVisibilityMask();
    00080
    00087         void setMaterialScheme(const String& schemeName);
    00094         const String& getMaterialScheme(void) const;
    00095
    00101         void setShadowsEnabled(bool enabled);
    00107         bool getShadowsEnabled(void) const;
    00111         void setLodBias(float bias);
    00114         float getLodBias();
    00115
    00118         CompositionPass *createPass();
    00121         void removePass(size_t idx);
    00124         CompositionPass *getPass(size_t idx);
    00127         size_t getNumPasses();
    00128
    00131         void removeAllPasses();
    00132
    00134         PassIterator getPassIterator(void);
    00135
    00137         CompositionTechnique *getParent();
    00138
    00141         bool _isSupported(void);
    00142
    00143     private:
    00145         CompositionTechnique *mParent;
    00147         InputMode mInputMode;
    00149         String mOutputName;
    00151         Passes mPasses;
    00154         bool mOnlyInitial;
    00156         uint32 mVisibilityMask;
    00158         float mLodBias;
    00160         String mMaterialScheme;
    00162         bool mShadowsEnabled;
    00163     };
    00164
    00165 }
    00166
    00167 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jul 26 11:32:17 2009