OgreGLHardwareBufferManager.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 __GLHARWAREBUFFERMANAGER_H__
#define __GLHARWAREBUFFERMANAGER_H__

#include "OgreGLPrerequisites.h"
#include "OgreHardwareBufferManager.h"

namespace Ogre {

    class GLStateCacheManager;

// Default threshold at which glMapBuffer becomes more efficient than glBufferSubData (32k?)
#   define OGRE_GL_DEFAULT_MAP_BUFFER_THRESHOLD (1024 * 32)

    class _OgreGLExport GLHardwareBufferManagerBase : public HardwareBufferManagerBase
    {
    protected:
        GLStateCacheManager* mStateCacheManager;
        char* mScratchBufferPool;
        OGRE_MUTEX(mScratchMutex);
        size_t mMapBufferThreshold;

    public:
        GLHardwareBufferManagerBase();
        ~GLHardwareBufferManagerBase();
        HardwareVertexBufferSharedPtr createVertexBuffer(size_t vertexSize, 
            size_t numVerts, HardwareBuffer::Usage usage, bool useShadowBuffer = false);
        HardwareIndexBufferSharedPtr createIndexBuffer(
            HardwareIndexBuffer::IndexType itype, size_t numIndexes, 
            HardwareBuffer::Usage usage, bool useShadowBuffer = false);
        RenderToVertexBufferSharedPtr createRenderToVertexBuffer();
        HardwareUniformBufferSharedPtr createUniformBuffer(size_t sizeBytes, HardwareBuffer::Usage usage,bool useShadowBuffer, const String& name = "");
        HardwareCounterBufferSharedPtr createCounterBuffer(size_t sizeBytes,
                                                           HardwareBuffer::Usage usage = HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE,
                                                           bool useShadowBuffer = false, const String& name = "");
        static GLenum getGLUsage(unsigned int usage);

        static GLenum getGLType(unsigned int type);

        GLStateCacheManager * getStateCacheManager() { return mStateCacheManager; }

        void* allocateScratch(uint32 size);

        void deallocateScratch(void* ptr);

        size_t getGLMapBufferThreshold() const;
        void setGLMapBufferThreshold( const size_t value );
    };

    class _OgreGLExport GLHardwareBufferManager : public HardwareBufferManager
    {
    public:
        GLHardwareBufferManager()
            : HardwareBufferManager(OGRE_NEW GLHardwareBufferManagerBase()) 
        {

        }
        ~GLHardwareBufferManager()
        {
            OGRE_DELETE mImpl;
        }



        static GLenum getGLUsage(unsigned int usage) 
        { return GLHardwareBufferManagerBase::getGLUsage(usage); }

        static GLenum getGLType(unsigned int type)
        { return GLHardwareBufferManagerBase::getGLType(type); }

        void* allocateScratch(uint32 size)
        {
            return static_cast<GLHardwareBufferManagerBase*>(mImpl)->allocateScratch(size);
        }

        void deallocateScratch(void* ptr)
        {
            static_cast<GLHardwareBufferManagerBase*>(mImpl)->deallocateScratch(ptr);
        }

        size_t getGLMapBufferThreshold() const
        {
            return static_cast<GLHardwareBufferManagerBase*>(mImpl)->getGLMapBufferThreshold();
        }
        void setGLMapBufferThreshold( const size_t value )
        {
            static_cast<GLHardwareBufferManagerBase*>(mImpl)->setGLMapBufferThreshold(value);
        }

    };

}

#endif // __GLHARWAREBUFFERMANAGER_H__