OgreGLSLProgramCommon.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 __GLSLProgramCommon_H__
#define __GLSLProgramCommon_H__

#include "OgreGL3PlusPrerequisites.h"
#include "OgreGpuProgram.h"
#include "OgreHardwareVertexBuffer.h"
#include "OgreGL3PlusHardwareUniformBuffer.h"
#include "OgreGL3PlusVertexArrayObject.h"

namespace Ogre {

    class GLSLGpuProgram;

    struct GLUniformReference
    {
        GLint mLocation;
        GpuProgramType mSourceProgType;
        const GpuConstantDefinition* mConstantDef;
    };

    typedef vector<GLUniformReference>::type GLUniformReferenceList;
    typedef GLUniformReferenceList::iterator GLUniformReferenceIterator;
    typedef vector<HardwareUniformBufferSharedPtr>::type GLUniformBufferList;
    typedef GLUniformBufferList::iterator GLUniformBufferIterator;

    class _OgreGL3PlusExport GLSLProgramCommon
    {
    protected:
        GLUniformReferenceList mGLUniformReferences;

        GLUniformBufferList mGLUniformBufferReferences;

        GLSLGpuProgram* mVertexProgram;
        GLSLGpuProgram* mFragmentProgram;
        GLSLGpuProgram* mGeometryProgram;
        GLSLGpuProgram* mHullProgram;
        GLSLGpuProgram* mDomainProgram;
        GLSLGpuProgram* mComputeProgram;
        GL3PlusVertexArrayObject *mVertexArrayObject;

        bool mUniformRefsBuilt;
        GLuint mGLProgramHandle;
        GLint mLinked;
        bool mTriedToLinkAndFailed;
        bool mSkeletalAnimation;

        void buildGLUniformReferences(void);
        typedef set<GLuint>::type AttributeSet;

        GLint mCustomAttributesIndexes[VES_COUNT][OGRE_MAX_TEXTURE_COORD_SETS];
#define NULL_CUSTOM_ATTRIBUTES_INDEX -2

#define NOT_FOUND_CUSTOM_ATTRIBUTES_INDEX -1

        Ogre::String getCombinedName(void);
        void getMicrocodeFromCache(void);
        virtual void compileAndLink(void) = 0;
        virtual void _useProgram(void) = 0;

        typedef map<String, VertexElementSemantic>::type SemanticToStringMap;
        SemanticToStringMap mSemanticTypeMap;

        VertexElementSemantic getAttributeSemanticEnum(String type);
        const char * getAttributeSemanticString(VertexElementSemantic semantic);

    public:
        GLSLProgramCommon(GLSLGpuProgram* vertexProgram, GLSLGpuProgram* geometryProgram, GLSLGpuProgram* fragmentProgram, GLSLGpuProgram* hullProgram, GLSLGpuProgram* domainProgram, GLSLGpuProgram* computeProgram);
        virtual ~GLSLProgramCommon(void);

        virtual void activate(void) = 0;

        virtual void updateUniforms(GpuProgramParametersSharedPtr params, uint16 mask, GpuProgramType fromProgType) = 0;
        virtual void updateUniformBlocks(GpuProgramParametersSharedPtr params, uint16 mask, GpuProgramType fromProgType) = 0;
        virtual void updatePassIterationUniforms(GpuProgramParametersSharedPtr params) = 0;
        virtual void extractLayoutQualifiers(void);
        GLuint getGLProgramHandle(void) const { return mGLProgramHandle; }
        void setSkeletalAnimationIncluded(bool included) { mSkeletalAnimation = included; }

        bool isSkeletalAnimationIncluded(void) const { return mSkeletalAnimation; }

        virtual GLint getAttributeIndex(VertexElementSemantic semantic, uint index);
        bool isAttributeValid(VertexElementSemantic semantic, uint index);

        GLSLGpuProgram* getVertexProgram() const { return mVertexProgram; }
        GLSLGpuProgram* getFragmentProgram() const { return mFragmentProgram; }
        GLSLGpuProgram* getGeometryProgram() const { return mGeometryProgram; }
        GLSLGpuProgram* getHullProgram() const { return mHullProgram; }
        GLSLGpuProgram* getDomainProgram() const { return mDomainProgram; }
        GLSLGpuProgram* getComputeProgram() const { return mComputeProgram; }
        GL3PlusVertexArrayObject* getVertexArrayObject() { return mVertexArrayObject; }
    };
}

#endif // __GLSLProgramCommon_H__