OgreGLStateCacheManagerImp.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-2014 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 __GLStateCacheManagerImp_H__
#define __GLStateCacheManagerImp_H__

#include "OgreGLPrerequisites.h"

typedef Ogre::GeneralAllocatedObject StateCacheAlloc;

namespace Ogre
{
    class _OgreGLExport GLStateCacheManagerImp : public StateCacheAlloc
    {
    private:
        typedef HashMap<GLenum, GLuint> BindBufferMap;
        typedef HashMap<GLenum, GLint> TexParameteriMap;
        typedef HashMap<GLenum, bool> GLbooleanStateMap;

        struct TextureUnitParams
        {
            ~TextureUnitParams()
            {
                mTexParameteriMap.clear();
            }

            TexParameteriMap mTexParameteriMap;
        };

        typedef HashMap<GLuint, TextureUnitParams> TexUnitsMap;

        /* These variables are used for caching OpenGL state.
         They are cached because state changes can be quite expensive,
         which is especially important on mobile or embedded systems.
         */

        HashMap <GLenum, GLuint> mBoundTextures;

        struct TexGenParams
        {
            std::set<GLenum> mEnabled;
        };
        HashMap <GLenum, TexGenParams> mTextureCoordGen;

        BindBufferMap mActiveBufferMap;
        TexUnitsMap mTexUnitsMap;
        GLbooleanStateMap mBoolStateMap;
        vector<GLclampf>::type mClearColour;
        vector<GLboolean>::type mColourMask;
        GLboolean mDepthMask;
        GLenum mPolygonMode;
        GLenum mBlendEquation;
        GLenum mBlendFuncSource;
        GLenum mBlendFuncDest;
        GLenum mCullFace;
        GLenum mDepthFunc;
        GLuint mStencilMask;
        GLuint mLastBoundTexID;
        size_t mActiveTextureUnit;
        unsigned int mDiscardBuffers;
        GLclampf mClearDepth;
        int mViewport[4];

        GLenum mBlendEquationRGB;
        GLenum mBlendEquationAlpha;
        GLenum mShadeModel;

        GLfloat mAmbient[4];
        GLfloat mDiffuse[4];
        GLfloat mSpecular[4];
        GLfloat mEmissive[4];
        GLfloat mLightAmbient[4];
        GLfloat mShininess;

        GLfloat mPointAttenuation[3];
        GLfloat mPointSize;
        GLfloat mPointSizeMin;
        GLfloat mPointSizeMax;

    public:
        GLStateCacheManagerImp(void);
        ~GLStateCacheManagerImp(void);
        
        void initializeCache();
        
        void clearCache();
        
        void bindGLBuffer(GLenum target, GLuint buffer, GLenum attach = 0, bool force = false);
        
        void deleteGLBuffer(GLenum target, GLuint buffer, GLenum attach = 0, bool force = false);
        
        void bindGLTexture(GLenum target, GLuint texture);
        
        void setTexParameteri(GLenum target, GLenum pname, GLint param);

        void invalidateStateForTexture(GLuint texture);

        bool activateGLTextureUnit(size_t unit);
        
        GLenum getBlendEquation(void) const { return mBlendEquation; }
        
        void setBlendEquation(GLenum eq);

        void setBlendEquation(GLenum eqRGB, GLenum eqA);

        void setBlendFunc(GLenum source, GLenum dest);

        void setShadeModel(GLenum model);

        void setLightAmbient(GLfloat r, GLfloat g, GLfloat b);

        GLboolean getDepthMask(void) const { return mDepthMask; }
        
        void setDepthMask(GLboolean mask);
        
        GLenum getDepthFunc(void) const { return mDepthFunc; }
        
        void setDepthFunc(GLenum func);
        
        GLclampf getClearDepth(void) const { return mClearDepth; }
        
        void setClearDepth(GLclampf depth);
        
        void setClearColour(GLclampf red, GLclampf green, GLclampf blue, GLclampf alpha);
        
        vector<GLboolean>::type & getColourMask(void) { return mColourMask; }
        
        void setColourMask(GLboolean red, GLboolean green, GLboolean blue, GLboolean alpha);
        
        GLuint getStencilMask(void) const { return mStencilMask; }
        
        void setStencilMask(GLuint mask);
        
        void setEnabled(GLenum flag, bool enabled);

        unsigned int getDiscardBuffers(void) const { return mDiscardBuffers; }
        
        void setDiscardBuffers(unsigned int flags) { mDiscardBuffers = flags; }
        
        GLenum getPolygonMode(void) const { return mPolygonMode; }
        
        void setPolygonMode(GLenum mode);
        
        GLenum getCullFace(void) const { return mCullFace; }
        
        void setCullFace(GLenum face);

        void enableTextureCoordGen(GLenum type);
        void disableTextureCoordGen(GLenum type);

        // Set material lighting parameters
        void setMaterialAmbient(GLfloat r, GLfloat g, GLfloat b, GLfloat a);
        void setMaterialDiffuse(GLfloat r, GLfloat g, GLfloat b, GLfloat a);
        void setMaterialEmissive(GLfloat r, GLfloat g, GLfloat b, GLfloat a);
        void setMaterialSpecular(GLfloat r, GLfloat g, GLfloat b, GLfloat a);
        void setMaterialShininess(GLfloat shininess);
        void setPointSize(GLfloat size);
        void setPointParameters(GLfloat* attenuation, float minSize, float maxSize);

        void setViewport(GLint x, GLint y, GLsizei width, GLsizei height);

        void getViewport(int* array);
    };
}

#endif