OgreShaderProgramManager.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 _ShaderProgramManager_
#define _ShaderProgramManager_

#include "OgreShaderPrerequisites.h"
#include "OgreShaderProgram.h"
#include "OgreShaderProgramWriter.h"

namespace Ogre {    
namespace RTShader {

class _OgreRTSSExport ProgramManager : public Singleton<ProgramManager>, public RTShaderSystemAlloc
{
// Interface.
public:

    ProgramManager  ();

    ~ProgramManager ();


    static ProgramManager&          getSingleton    (); 

    static ProgramManager*          getSingletonPtr             ();

    void                            acquirePrograms         (Pass* pass, TargetRenderState* renderState);

    void                            releasePrograms         (Pass* pass, TargetRenderState* renderState);

    void                            flushGpuProgramsCache   ();

protected:

    //-----------------------------------------------------------------------------
    typedef map<String, GpuProgramPtr>::type            GpuProgramsMap;
    typedef GpuProgramsMap::iterator                    GpuProgramsMapIterator;
    typedef GpuProgramsMap::const_iterator              GpuProgramsMapConstIterator;

    //-----------------------------------------------------------------------------
    typedef set<Program*>::type                         ProgramList;
    typedef ProgramList::iterator                       ProgramListIterator;
    typedef map<String, ProgramWriter*>::type           ProgramWriterMap;
    typedef ProgramWriterMap::iterator                  ProgramWriterIterator;
    typedef vector<ProgramWriterFactory*>::type         ProgramWriterFactoryList;
    
    //-----------------------------------------------------------------------------
    typedef map<String, ProgramProcessor*>::type        ProgramProcessorMap;
    typedef ProgramProcessorMap::iterator               ProgramProcessorIterator;
    typedef ProgramProcessorMap::const_iterator         ProgramProcessorConstIterator;
    typedef vector<ProgramProcessor*>::type             ProgramProcessorList;

    
protected:
    void            createDefaultProgramProcessors  ();
    
    void            destroyDefaultProgramProcessors ();

    void            createDefaultProgramWriterFactories ();

    void            destroyDefaultProgramWriterFactories();

    void            destroyProgramWriters   ();

    Program*        createCpuProgram        (GpuProgramType type);

    void            destroyCpuProgram       (Program* shaderProgram);

    bool            createGpuPrograms       (ProgramSet* programSet);

    GpuProgramPtr   createGpuProgram        (Program* shaderProgram, 
        ProgramWriter* programWriter,
        const String& language,
        const String& profiles,
        const StringVector& profilesList,
        const String& cachePath);

    void            addProgramProcessor     (ProgramProcessor* processor);

    void            removeProgramProcessor  (ProgramProcessor* processor);

    void            destroyGpuProgram       (GpuProgramPtr& gpuProgram);

    void            flushGpuProgramsCache   (GpuProgramsMap& gpuProgramsMap);
    
    size_t          getVertexShaderCount        () const { return mVertexShaderMap.size(); }

    size_t          getFragmentShaderCount      () const { return mFragmentShaderMap.size(); }

    void            synchronizePixelnToBeVertexOut  (ProgramSet* programSet);

    void            bindUniformParameters           (Program* pCpuProgram, const GpuProgramParametersSharedPtr& passParams);


protected:
    

protected:
    ProgramList                 mCpuProgramsList;               // CPU programs list.                   
    ProgramWriterMap            mProgramWritersMap;             // Map between target language and shader program writer.                   
    ProgramProcessorMap         mProgramProcessorsMap;          // Map between target language and shader program processor.    
    ProgramWriterFactoryList    mProgramWriterFactories;        // Holds standard shader writer factories
    GpuProgramsMap              mVertexShaderMap;               // The generated vertex shaders.
    GpuProgramsMap              mFragmentShaderMap;             // The generated fragment shaders.
    ProgramProcessorList        mDefaultProgramProcessors;      // The default program processors.

private:
    friend class ProgramSet;
    friend class TargetRenderState;
    friend class ShaderGenerator;
};

}
}

#endif