OgreCompositionPass.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-2005 The OGRE Team
Also see acknowledgements in Readme.html

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/
#ifndef __CompositionPass_H__
#define __CompositionPass_H__

#include "OgrePrerequisites.h"
#include "OgreMaterial.h"
#include "OgreRenderSystem.h"
#include "OgreRenderQueue.h"

namespace Ogre {
    class _OgreExport CompositionPass
    {
    public:
        CompositionPass(CompositionTargetPass *parent);
        ~CompositionPass();
        
        enum PassType
        {
            PT_CLEAR,           // Clear target to one colour
            PT_STENCIL,         // Set stencil operation
            PT_RENDERSCENE,     // Render the scene or part of it
            PT_RENDERQUAD       // Render a full screen quad
        };
        
        void setType(PassType type);
        PassType getType() const;
        
        void setIdentifier(uint32 id);
        uint32 getIdentifier() const;

        void setMaterial(MaterialPtr mat);
        void setMaterialName(const String &name);
        MaterialPtr getMaterial() const;
        void setFirstRenderQueue(uint8 id);
        uint8 getFirstRenderQueue();
        void setLastRenderQueue(uint8 id);
        uint8 getLastRenderQueue();

        void setClearBuffers(uint32 val);
        uint32 getClearBuffers();
        void setClearColour(ColourValue val);
        const ColourValue &getClearColour();
        void setClearDepth(Real depth);
        Real getClearDepth();
        void setClearStencil(uint32 value);
        uint32 getClearStencil();

        void setStencilCheck(bool value);
        bool getStencilCheck();
        void setStencilFunc(CompareFunction value); 
        CompareFunction getStencilFunc(); 
        void setStencilRefValue(uint32 value);
        uint32 getStencilRefValue();
        void setStencilMask(uint32 value);
        uint32 getStencilMask();
        void setStencilFailOp(StencilOperation value);
        StencilOperation getStencilFailOp();
        void setStencilDepthFailOp(StencilOperation value);
        StencilOperation getStencilDepthFailOp();
        void setStencilPassOp(StencilOperation value);
        StencilOperation getStencilPassOp();
        void setStencilTwoSidedOperation(bool value);
        bool getStencilTwoSidedOperation();

        void setInput(size_t id, const String &input="");
        
        const String &getInput(size_t id);
        
        size_t getNumInputs();
        
        void clearAllInputs();
        
        CompositionTargetPass *getParent();
    private:
        CompositionTargetPass *mParent;
        PassType mType;
        uint32 mIdentifier;
        MaterialPtr mMaterial;
        uint8 mFirstRenderQueue;
        uint8 mLastRenderQueue;
        uint32 mClearBuffers;
        ColourValue mClearColour;
        Real mClearDepth;
        uint32 mClearStencil;
        String mInputs[OGRE_MAX_TEXTURE_LAYERS];
        bool mStencilCheck;
        CompareFunction mStencilFunc; 
        uint32 mStencilRefValue;
        uint32 mStencilMask;
        StencilOperation mStencilFailOp;
        StencilOperation mStencilDepthFailOp;
        StencilOperation mStencilPassOp;
        bool mStencilTwoSidedOperation;
    };

}

#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:37:38 2006