OgreGLSLESProgram.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 __GLSLESProgram_H__
#define __GLSLESProgram_H__

#include "OgreGLES2Prerequisites.h"
#include "OgreHighLevelGpuProgram.h"
#include "OgreGLES2ManagedResource.h"

namespace Ogre {
    class _OgreGLES2Export GLSLESProgram : public HighLevelGpuProgram MANAGED_RESOURCE
    {
    public:
#if !OGRE_NO_GLES2_GLSL_OPTIMISER

        class CmdOptimisation : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
#endif

        class CmdPreprocessorDefines : public ParamCommand
        {
        public:
            String doGet(const void* target) const;
            void doSet(void* target, const String& val);
        };
        
        GLSLESProgram(ResourceManager* creator, 
            const String& name, ResourceHandle handle,
            const String& group, bool isManual, ManualResourceLoader* loader);
        ~GLSLESProgram();

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

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

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

#if !OGRE_NO_GLES2_GLSL_OPTIMISER

        void setOptimiserEnabled(bool enabled);
        bool getOptimiserEnabled(void) const { return mOptimiserEnabled; }
        
        void setIsOptimised(bool flag) { mIsOptimised = flag; }
        bool getIsOptimised(void) { return mIsOptimised; }

        void setOptimisedSource(const String& src) { mOptimisedSource = src; }
        String getOptimisedSource(void) { return mOptimisedSource; }
#endif

        const String& getLanguage(void) const;
        GpuProgramParametersSharedPtr createParameters(void);

        bool compile( const bool checkErrors = false);

    protected:
        static CmdPreprocessorDefines msCmdPreprocessorDefines;
#if !OGRE_NO_GLES2_GLSL_OPTIMISER
        static CmdOptimisation msCmdOptimisation;
#endif

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

        void populateParameterNames(GpuProgramParametersSharedPtr params);
        void buildConstantDefinitions() const;
        void checkAndFixInvalidDefaultPrecisionError( String &message );
        
#if OGRE_PLATFORM == OGRE_PLATFORM_ANDROID

        virtual void notifyOnContextLost();
#endif
        
    private:
        GLuint mGLShaderHandle;
        GLuint mGLProgramHandle;
        GLint mCompiled;
        String mPreprocessorDefines;
#if !OGRE_NO_GLES2_GLSL_OPTIMISER

        bool mIsOptimised;
        bool mOptimiserEnabled;
        String mOptimisedSource;
#endif
    };
}

#endif // __GLSLESProgram_H__