OgreCompositorManager.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 __CompositorManager_H__
#define __CompositorManager_H__

#include "OgrePrerequisites.h"
#include "OgreResourceManager.h"
#include "OgreCompositor.h"
#include "OgreRectangle2D.h"
#include "OgreRenderSystem.h"
#include "OgreCompositionTechnique.h"
#include "OgreHeaderPrefix.h"

namespace Ogre {
    class _OgreExport CompositorManager : public ResourceManager, public Singleton<CompositorManager>
    {
    public:
        CompositorManager();
        virtual ~CompositorManager();

        Resource* createImpl(const String& name, ResourceHandle handle,
            const String& group, bool isManual, ManualResourceLoader* loader,
            const NameValuePairList* params);

        void initialise(void);

        CompositorPtr create (const String& name, const String& group,
                            bool isManual = false, ManualResourceLoader* loader = 0,
                            const NameValuePairList* createParams = 0);

        CompositorPtr getByName(const String& name, const String& groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME);


        void parseScript(DataStreamPtr& stream, const String& groupName);

        CompositorChain *getCompositorChain(Viewport *vp);

        bool hasCompositorChain(Viewport *vp) const;

        void removeCompositorChain(Viewport *vp);

        CompositorInstance *addCompositor(Viewport *vp, const String &compositor, int addPosition=-1);

        void removeCompositor(Viewport *vp, const String &compositor);

        void setCompositorEnabled(Viewport *vp, const String &compositor, bool value);

        Renderable *_getTexturedRectangle2D();

        void removeAll(void);

        void _reconstructAllCompositorResources();

        typedef set<Texture*>::type UniqueTextureSet;

        TexturePtr getPooledTexture(const String& name, const String& localName, 
            size_t w, size_t h, 
            PixelFormat f, uint aa, const String& aaHint, bool srgb, UniqueTextureSet& texturesAlreadyAssigned, 
            CompositorInstance* inst, CompositionTechnique::TextureScope scope);

        void freePooledTextures(bool onlyIfUnreferenced = true);

        void registerCompositorLogic(const String& name, CompositorLogic* logic);

        void unregisterCompositorLogic(const String& name);
        
        CompositorLogic* getCompositorLogic(const String& name);

        void registerCustomCompositionPass(const String& name, CustomCompositionPass* customPass);
        
        CustomCompositionPass* getCustomCompositionPass(const String& name);

        static CompositorManager& getSingleton(void);
        static CompositorManager* getSingletonPtr(void);

    
    private:
        typedef map<Viewport*, CompositorChain*>::type Chains;
        Chains mChains;

        void freeChains();

        Rectangle2D *mRectangle;

        typedef vector<CompositorInstance *>::type Instances;
        Instances mInstances;

        typedef map<String, CompositorLogic*>::type CompositorLogicMap;
        CompositorLogicMap mCompositorLogics;

        typedef map<String, CustomCompositionPass*>::type CustomCompositionPassMap;
        CustomCompositionPassMap mCustomCompositionPasses;

        typedef vector<TexturePtr>::type TextureList;
        typedef VectorIterator<TextureList> TextureIterator;

        struct TextureDef
        {
            size_t width, height;
            PixelFormat format;
            uint fsaa;
            String fsaaHint;
            bool sRGBwrite;

            TextureDef(size_t w, size_t h, PixelFormat f, uint aa, const String& aaHint, bool srgb)
                : width(w), height(h), format(f), fsaa(aa), fsaaHint(aaHint), sRGBwrite(srgb)
            {

            }
        };
        struct TextureDefLess
        {
            bool _OgreExport operator()(const TextureDef& x, const TextureDef& y) const
            {
                if (x.format < y.format)
                    return true;
                else if (x.format == y.format)
                {
                    if (x.width < y.width)
                        return true;
                    else if (x.width == y.width)
                    {
                        if (x.height < y.height)
                            return true;
                        else if (x.height == y.height)
                        {
                            if (x.fsaa < y.fsaa)
                                return true;
                            else if (x.fsaa == y.fsaa)
                            {
                                if (x.fsaaHint < y.fsaaHint)
                                    return true;
                                else if (x.fsaaHint == y.fsaaHint)
                                {
                                    if (!x.sRGBwrite && y.sRGBwrite)
                                        return true;
                                }

                            }
                        }
                    }
                }
                return false;
            }
            virtual ~TextureDefLess() {}
        };
        typedef map<TextureDef, TextureList*, TextureDefLess>::type TexturesByDef;
        TexturesByDef mTexturesByDef;

        typedef std::pair<String, String> StringPair;
        typedef map<TextureDef, TexturePtr, TextureDefLess>::type TextureDefMap;
        typedef map<StringPair, TextureDefMap>::type ChainTexturesByDef;
        
        ChainTexturesByDef mChainTexturesByDef;

        bool isInputPreviousTarget(CompositorInstance* inst, const Ogre::String& localName);
        bool isInputPreviousTarget(CompositorInstance* inst, TexturePtr tex);
        bool isInputToOutputTarget(CompositorInstance* inst, const Ogre::String& localName);
        bool isInputToOutputTarget(CompositorInstance* inst, TexturePtr tex);

    };
}

#include "OgreHeaderSuffix.h"

#endif