OgreGLES2StateCacheManagerImp.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 __GLES2StateCacheManagerImp_H__
#define __GLES2StateCacheManagerImp_H__

#include "OgreGLES2Prerequisites.h"

typedef Ogre::GeneralAllocatedObject StateCacheAlloc;

namespace Ogre
{
    class _OgreGLES2Export GLES2StateCacheManagerImp : public StateCacheAlloc
    {
    private:
        typedef HashMap<GLenum, GLuint> BindBufferMap;
        typedef HashMap<GLenum, GLint> TexParameteriMap;
        typedef HashMap<GLenum, GLfloat> TexParameterfMap;

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

            TexParameteriMap mTexParameteriMap;
            TexParameterfMap mTexParameterfMap;
        };

        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.
         */

        BindBufferMap mActiveBufferMap;
        TexUnitsMap mTexUnitsMap;
        vector<GLenum>::type mEnableVector;
        vector<GLclampf>::type mClearColour;
        vector<GLboolean>::type mColourMask;
        vector<GLuint>::type mEnabledVertexAttribs;
        GLboolean mDepthMask;
        GLenum mPolygonMode;
        GLenum mBlendEquation;
        GLenum mBlendFuncSource;
        GLenum mBlendFuncDest;
        GLenum mCullFace;
        GLenum mDepthFunc;
        GLuint mStencilMask;
        GLuint mLastBoundTexID;
        GLenum mActiveTextureUnit;
        unsigned int mDiscardBuffers;
        GLclampf mClearDepth;
        
    public:
        GLES2StateCacheManagerImp(void);
        ~GLES2StateCacheManagerImp(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 setTexParameterf(GLenum target, GLenum pname, GLfloat params);

        void getTexParameterfv(GLenum target, GLenum pname, GLfloat *params);

        void invalidateStateForTexture(GLuint texture);

        bool activateGLTextureUnit(size_t unit);
        
        GLenum getBlendEquation(void) const { return mBlendEquation; }
        
        void setBlendEquation(GLenum eq);
        
        void setBlendFunc(GLenum source, GLenum dest);
        
        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);
        
        void setDisabled(GLenum flag);

        void setVertexAttribEnabled(GLuint attrib);

        void setVertexAttribDisabled(GLuint attrib);

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

#endif