pixelBufferObject.h

/* Copyright (c) 2012, Maxim Makhinya <maxmah@gmail.com>
 *               2012, Stefan Eilemann <eile@eyescale.ch>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *  
 * This library 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 library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQUTIL_PIXELBUFFEROBJECT_H
#define EQUTIL_PIXELBUFFEROBJECT_H

#include <lunchbox/lock.h>

#include <eq/client/api.h>
#include <eq/client/types.h>
#include <eq/fabric/error.h> // enum

namespace eq
{
namespace util
{
namespace detail { class PixelBufferObject; }

    class PixelBufferObject 
    {
    public:
        EQ_API PixelBufferObject( const GLEWContext* glewContext,
                                  const bool threadSafe );

        EQ_API virtual ~PixelBufferObject();

        EQ_API virtual bool setup( const size_t size, const unsigned type );

        EQ_API virtual void destroy();

        EQ_API virtual const void* mapRead() const;

        EQ_API virtual void* mapWrite();

        EQ_API virtual void unmap() const;

        EQ_API virtual bool bind() const;

        EQ_API virtual void unbind() const;

        EQ_API size_t getSize() const;

        EQ_API const eq::fabric::Error& getError() const;

        EQ_API bool isInitialized() const;

        EQ_API bool isThreadSafe() const;

        unsigned getID() const;

    private:
        detail::PixelBufferObject* const _impl;
    };
}
}

#endif // EQUTIL_PIXELBUFFEROBJECT_H