OgreGLSLProgram.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 __GLSLProgram_H__
#define __GLSLProgram_H__

#include "OgreGL3PlusPrerequisites.h"
#include "OgreHighLevelGpuProgram.h"

namespace Ogre {
    class _OgreGL3PlusExport GLSLProgram : public HighLevelGpuProgram
    {
    public:
        class CmdAttach : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& shaderNames);
        };

        class CmdPreprocessorDefines : public ParamCommand
        {
        public:
                String doGet(const void* target) const;
                void doSet(void* target, const String& val);
        };
        class _OgreGL3PlusExport CmdInputOperationType : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgreGL3PlusExport CmdOutputOperationType : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class _OgreGL3PlusExport CmdMaxOutputVertices : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        class CmdColumnMajorMatrices : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        virtual RenderOperation::OperationType getInputOperationType(void) const 
        { return mInputOperationType; }
        virtual RenderOperation::OperationType getOutputOperationType(void) const 
        { return mOutputOperationType; }
        virtual int getMaxOutputVertices(void) const { return mMaxOutputVertices; }

        virtual void setInputOperationType(RenderOperation::OperationType operationType) 
        { mInputOperationType = operationType; }
        virtual void setOutputOperationType(RenderOperation::OperationType operationType) 
        { mOutputOperationType = operationType; }
        virtual void setMaxOutputVertices(int maxOutputVertices) 
        { mMaxOutputVertices = maxOutputVertices; }

        GLSLProgram(ResourceManager* creator, 
            const String& name, ResourceHandle handle,
            const String& group, bool isManual, ManualResourceLoader* loader);
        ~GLSLProgram();

        GLuint getGLShaderHandle() const { return mGLShaderHandle; }
        GLuint getGLProgramHandle() const { return mGLProgramHandle; }
        void attachToProgramObject( const GLuint programObject );
        void detachFromProgramObject( const GLuint programObject );
        String getAttachedShaderNames() const { return mAttachedShaderNames; }

        bool getPassTransformStates(void) const;
        bool getPassSurfaceAndLightStates(void) const;
        bool getPassFogStates(void) const;

        void attachChildShader(const String& name);

        void setPreprocessorDefines(const String& defines) { mPreprocessorDefines = defines; }
        const String& getPreprocessorDefines(void) const { return mPreprocessorDefines; }

        const String& getLanguage(void) const;
        void setColumnMajorMatrices(bool columnMajor) { mColumnMajorMatrices = columnMajor; }
        bool getColumnMajorMatrices(void) const { return mColumnMajorMatrices; }

        GpuProgramParametersSharedPtr createParameters(void);

        bool compile( const bool checkErrors = false);

    protected:
        static CmdPreprocessorDefines msCmdPreprocessorDefines;
        static CmdAttach msCmdAttach;
        static CmdColumnMajorMatrices msCmdColumnMajorMatrices;
        static CmdInputOperationType msInputOperationTypeCmd;
        static CmdOutputOperationType msOutputOperationTypeCmd;
        static CmdMaxOutputVertices msMaxOutputVerticesCmd;

        void loadFromSource(void);
        void createLowLevelImpl(void);
        void unloadHighLevelImpl(void);
        void unloadImpl(void);

        void populateParameterNames(GpuProgramParametersSharedPtr params);
        void buildConstantDefinitions() const;
        void checkAndFixInvalidDefaultPrecisionError( String &message );
    private:
        GLuint mGLShaderHandle;
        GLuint mGLProgramHandle;
        GLint mCompiled;
        RenderOperation::OperationType mInputOperationType;
        RenderOperation::OperationType mOutputOperationType;
        int mMaxOutputVertices;
        String mAttachedShaderNames;
        String mPreprocessorDefines;
        typedef vector< GLSLProgram* >::type GLSLProgramContainer;
        typedef GLSLProgramContainer::iterator GLSLProgramContainerIterator;
        GLSLProgramContainer mAttachedGLSLPrograms;
        bool mColumnMajorMatrices;
    };
}

#endif // __GLSLProgram_H__