OgreDefaultHardwareBufferManager.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 __DefaultHardwareBufferManager_H__
#define __DefaultHardwareBufferManager_H__

#include "OgrePrerequisites.h"
#include "OgreHardwareBufferManager.h"
#include "OgreHardwareCounterBuffer.h"
#include "OgreHardwareIndexBuffer.h"
#include "OgreHardwareUniformBuffer.h"
#include "OgreHardwareVertexBuffer.h"

namespace Ogre {

    class _OgreExport DefaultHardwareVertexBuffer : public HardwareVertexBuffer 
    {
    protected:
        unsigned char* mData;
        void* lockImpl(size_t offset, size_t length, LockOptions options);
        void unlockImpl(void);
    public:
        DefaultHardwareVertexBuffer(size_t vertexSize, size_t numVertices, HardwareBuffer::Usage usage);
        DefaultHardwareVertexBuffer(HardwareBufferManagerBase* mgr, size_t vertexSize, size_t numVertices, 
            HardwareBuffer::Usage usage);
        ~DefaultHardwareVertexBuffer();
        void readData(size_t offset, size_t length, void* pDest);
        void writeData(size_t offset, size_t length, const void* pSource,
                bool discardWholeBuffer = false);
        void* lock(size_t offset, size_t length, LockOptions options);
        void unlock(void);


    };

    class _OgreExport DefaultHardwareIndexBuffer : public HardwareIndexBuffer
    {
    protected:
        unsigned char* mData;
        void* lockImpl(size_t offset, size_t length, LockOptions options);
        void unlockImpl(void);
    public:
        DefaultHardwareIndexBuffer(IndexType idxType, size_t numIndexes, HardwareBuffer::Usage usage);
        ~DefaultHardwareIndexBuffer();
        void readData(size_t offset, size_t length, void* pDest);
        void writeData(size_t offset, size_t length, const void* pSource,
                bool discardWholeBuffer = false);
        void* lock(size_t offset, size_t length, LockOptions options);
        void unlock(void);

    };

    class _OgreExport DefaultHardwareUniformBuffer : public HardwareUniformBuffer
    {
    protected:
        unsigned char* mData;
        void* lockImpl(size_t offset, size_t length, LockOptions options);
        void unlockImpl(void);
        //bool updateStructure(const Any& renderSystemInfo);

    public:
        DefaultHardwareUniformBuffer(HardwareBufferManagerBase* mgr, size_t sizeBytes, HardwareBuffer::Usage usage, bool useShadowBuffer = false, const String& name = "");
        ~DefaultHardwareUniformBuffer();
        void readData(size_t offset, size_t length, void* pDest);
        void writeData(size_t offset, size_t length, const void* pSource,
                bool discardWholeBuffer = false);
        void* lock(size_t offset, size_t length, LockOptions options);
        void unlock(void);
    };

    class _OgreExport DefaultHardwareCounterBuffer : public HardwareCounterBuffer
    {
    protected:
        unsigned char* mData;
        void* lockImpl(size_t offset, size_t length, LockOptions options);
        void unlockImpl(void);
        //bool updateStructure(const Any& renderSystemInfo);

    public:
        DefaultHardwareCounterBuffer(HardwareBufferManagerBase* mgr, size_t sizeBytes, HardwareBuffer::Usage usage, bool useShadowBuffer = false, const String& name = "");
        ~DefaultHardwareCounterBuffer();
        void readData(size_t offset, size_t length, void* pDest);
        void writeData(size_t offset, size_t length, const void* pSource,
                       bool discardWholeBuffer = false);
        void* lock(size_t offset, size_t length, LockOptions options);
        void unlock(void);
    };

    class _OgreExport DefaultHardwareBufferManagerBase : public HardwareBufferManagerBase
    {
    public:
        DefaultHardwareBufferManagerBase();
        ~DefaultHardwareBufferManagerBase();
        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 = HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE, 
                                    bool useShadowBuffer = false, const String& name = "");
        HardwareCounterBufferSharedPtr createCounterBuffer(size_t sizeBytes,
                                                           HardwareBuffer::Usage usage = HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE,
                                                           bool useShadowBuffer = false, const String& name = "");
    };

    class _OgreExport DefaultHardwareBufferManager : public HardwareBufferManager
    {
    public:
        DefaultHardwareBufferManager()
            : HardwareBufferManager(OGRE_NEW DefaultHardwareBufferManagerBase()) 
        {

        }
        ~DefaultHardwareBufferManager()
        {
            OGRE_DELETE mImpl;
        }
    };

}

#endif