/*
 * This source file is part of KEOS (Free 3D Engine)
 * For the latest info, see http://www.keosengine.org/
 * E-mails : thierry.vouriot@keosengine.org, yeri@keosengine.org
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place - Suite 330, Boston, MA 02111-1307, USA, or go to
 * http://www.gnu.org/copyleft/lesser.txt.
 *
 */

#ifndef KEOS_BUFFERBASE_H
#define KEOS_BUFFERBASE_H

#include "KeosPrerequisites.h"

namespace Keos
{
    //-----------------------------------------------------------------------
    /** Abstract class for all types of buffers.
     */
    class KEOS_EXPORT IBufferBase
    {
    public :

        /** Destructor.
         */
        virtual ~IBufferBase();

    protected :

        /** Default constructor.
         *  @param nCount Number of elements.
         */
        IBufferBase(ulong nCount);

        // Friend class
        template <class T> friend class CBuffer;

        /** Lock the buffer.
         *  @param nOffset Lock position.
         *  @param nSize Number of elements to be locked.
         *  @param nFlags Lock options.
         *  @return Pointer on the data locked.
         */
        virtual void* Lock(ulong nOffset, ulong nSize, ulong nFlags) = 0;

        /** Unlock the buffer.
         */
        virtual void Unlock() = 0;

        //! Number of elements in the buffer
        ulong m_nCount;
    };

} // namespace Keos

#endif // KEOS_BUFFERBASE_H
