OgreGpuProgramManager.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 __GpuProgramManager_H_
#define __GpuProgramManager_H_

// Precompiler options
#include "OgrePrerequisites.h"
#include "OgreResourceManager.h"
#include "OgreException.h"
#include "OgreGpuProgram.h"
#include "OgreSingleton.h"
#include "OgreHeaderPrefix.h"

namespace Ogre {

    class _OgreExport GpuProgramManager : public ResourceManager, public Singleton<GpuProgramManager>
    {
    public:

        typedef set<String>::type SyntaxCodes;
        typedef map<String, GpuSharedParametersPtr>::type SharedParametersMap;

        typedef MemoryDataStreamPtr Microcode;
        typedef map<String, Microcode>::type MicrocodeMap;

    protected:

        SharedParametersMap mSharedParametersMap;
        MicrocodeMap mMicrocodeCache;
        bool mSaveMicrocodesToCache;
        bool mCacheDirty;           // When this is true the cache is 'dirty' and should be resaved to disk.
            
        static String addRenderSystemToName( const String &  name );

        virtual Resource* createImpl(const String& name, ResourceHandle handle, 
            const String& group, bool isManual, ManualResourceLoader* loader,
            GpuProgramType gptype, const String& syntaxCode) = 0;
    public:
        GpuProgramManager();
        virtual ~GpuProgramManager();

        GpuProgramPtr getByName(const String& name, bool preferHighLevelPrograms = true);

        virtual GpuProgramPtr load(const String& name, const String& groupName, 
            const String& filename, GpuProgramType gptype, 
            const String& syntaxCode);

        virtual GpuProgramPtr loadFromString(const String& name, const String& groupName,
            const String& code, GpuProgramType gptype,
            const String& syntaxCode);

        virtual const SyntaxCodes& getSupportedSyntax(void) const;
         

        virtual bool isSyntaxSupported(const String& syntaxCode) const;
        
        virtual GpuProgramParametersSharedPtr createParameters(void);
        
        virtual GpuProgramPtr createProgram(const String& name, 
            const String& groupName, const String& filename, 
            GpuProgramType gptype, const String& syntaxCode);

        virtual GpuProgramPtr createProgramFromString(const String& name, 
            const String& groupName, const String& code, 
            GpuProgramType gptype, const String& syntaxCode);

        virtual ResourcePtr create(const String& name, const String& group, 
            GpuProgramType gptype, const String& syntaxCode, bool isManual = false, 
            ManualResourceLoader* loader = 0);

        ResourcePtr getResourceByName(const String& name, bool preferHighLevelPrograms = true);


        virtual GpuSharedParametersPtr createSharedParameters(const String& name);

        virtual GpuSharedParametersPtr getSharedParameters(const String& name) const;

        virtual const SharedParametersMap& getAvailableSharedParameters() const;

        bool getSaveMicrocodesToCache();
        void setSaveMicrocodesToCache( const bool val );

        bool isCacheDirty(void) const;

        bool canGetCompiledShaderBuffer();
        virtual bool isMicrocodeAvailableInCache( const String & name ) const;
        virtual const Microcode & getMicrocodeFromCache( const String & name ) const;

        virtual Microcode createMicrocode( const uint32 size ) const;

        virtual void addMicrocodeToCache( const String & name, const Microcode & microcode );

        virtual void removeMicrocodeFromCache( const String & name );

        virtual void saveMicrocodeCache( DataStreamPtr stream ) const;
        virtual void loadMicrocodeCache( DataStreamPtr stream );
        


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


    };

}

#include "OgreHeaderSuffix.h"

#endif