E:/Programming/MyProject/K_Game_hg/GameEngine/include/resource/Buffer.h

Go to the documentation of this file.

// Copyright 2006-2011 by Kat'Oun

#ifndef _BUFFER_H_
#define _BUFFER_H_

#include <EngineConfig.h>
#include <core/Types.h>

namespace resource
{

enum BufferLocking
{
        BL_NORMAL,              
        BL_DISCARD,             
        BL_READ_ONLY,   
        BL_NO_OVERWRITE 
};

enum BufferUsage
{
        BU_STATIC = 1,                                                  
        BU_DYNAMIC = 2,                                                 
        BU_WRITE_ONLY = 4,                                              
        BU_STATIC_WRITE_ONLY = 5,                               
        BU_DYNAMIC_WRITE_ONLY = 6,                              
        BU_DISCARDABLE = 8,                                             
        BU_DYNAMIC_WRITE_ONLY_DISCARDABLE = 14  
};

class ENGINE_PUBLIC_EXPORT Buffer
{
public:

        Buffer(BufferUsage usage, bool systemMemory, bool useShadowBuffer);

        virtual ~Buffer();
        virtual void* lock(u32 offset, u32 length, BufferLocking options);

        void* lock(BufferLocking options);

        virtual void unlock();

        virtual void readData(u32 offset, u32 length, void* pDest) = 0;
        virtual void writeData(u32 offset, u32 length, const void* pSource, bool discardWholeBuffer = false) = 0;

        virtual void copyData(Buffer& srcBuffer, u32 srcOffset, u32 dstOffset, u32 length, bool discardWholeBuffer = false);

        virtual void updateFromShadow();

        u32 getSizeInBytes() const;
        BufferUsage getUsage() const;
        bool isSystemMemory() const;
        bool isLocked() const;

protected:

        u32 mSizeInBytes;
        BufferUsage mUsage;
        bool mIsLocked;
        u32 mLockStart;
        u32 mLockSize;
        bool mSystemMemory;
        bool mUseShadowBuffer;
        Buffer* mShadowBuffer;
        bool mShadowUpdated;

        virtual void* lockImpl(u32 offset, u32 length, BufferLocking options) = 0;
        virtual void unlockImpl() = 0;
};

}// end namespace resource

#endif// _BUFFER_H_