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-2012 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 __CompositionPass_H__
#define __CompositionPass_H__

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

namespace Ogre {
    class _OgreExport CompositionPass : public CompositorInstAlloc
    {
    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
            PT_RENDERCUSTOM     // Render a custom sequence
        };
        
        void setType(PassType type);
        PassType getType() const;
        
        void setIdentifier(uint32 id);
        uint32 getIdentifier() const;

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

        void setMaterialScheme(const String& schemeName);
        const String& getMaterialScheme(void) const;

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

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

        struct InputTex
        {
            String name;
            size_t mrtIndex;
            InputTex() : name(StringUtil::BLANK), mrtIndex(0) {}
            InputTex(const String& _name, size_t _mrtIndex = 0)
                : name(_name), mrtIndex(_mrtIndex) {}
        };

        void setInput(size_t id, const String &input=StringUtil::BLANK, size_t mrtIndex=0);
        
        const InputTex &getInput(size_t id) const;
        
        size_t getNumInputs() const;
        
        void clearAllInputs();
        
        CompositionTargetPass *getParent();

        bool _isSupported(void);

        void setQuadCorners(Real left,Real top,Real right,Real bottom);

        bool getQuadCorners(Real & left,Real & top,Real & right,Real & bottom) const;
            
        void setQuadFarCorners(bool farCorners, bool farCornersViewSpace);

        bool getQuadFarCorners() const;

        bool getQuadFarCornersViewSpace() const;

        void setCustomType(const String& customType);

        const String& getCustomType() const;

    private:
        CompositionTargetPass *mParent;
        PassType mType;
        uint32 mIdentifier;
        MaterialPtr mMaterial;
        uint8 mFirstRenderQueue;
        uint8 mLastRenderQueue;
        String mMaterialScheme;
        uint32 mClearBuffers;
        ColourValue mClearColour;
        Real mClearDepth;
        uint32 mClearStencil;
        InputTex mInputs[OGRE_MAX_TEXTURE_LAYERS];
        bool mStencilCheck;
        CompareFunction mStencilFunc; 
        uint32 mStencilRefValue;
        uint32 mStencilMask;
        StencilOperation mStencilFailOp;
        StencilOperation mStencilDepthFailOp;
        StencilOperation mStencilPassOp;
        bool mStencilTwoSidedOperation;

        bool mQuadCornerModified;
        Real mQuadLeft;
        Real mQuadTop;
        Real mQuadRight;
        Real mQuadBottom;

        bool mQuadFarCorners, mQuadFarCornersViewSpace;
        //The type name of the custom composition pass.
        String mCustomType;
    };
}

#endif