objectManager.h

/* Copyright (c) 2007-2014, Stefan Eilemann <eile@equalizergraphics.com>
 *
 * 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_OBJECTMANAGER_H
#define EQUTIL_OBJECTMANAGER_H

#include <eq/util/types.h>
#include <eq/client/api.h>

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

class ObjectManager
{
public:
    enum
    {
        INVALID = 0 //<! return value for failed operations.
    };

    EQ_API ObjectManager( const GLEWContext* const glewContext );

    EQ_API ObjectManager( const ObjectManager& shared );

    EQ_API virtual ~ObjectManager();

    ObjectManager& operator = ( const ObjectManager& rhs ); 

    EQ_API bool isShared() const;

    EQ_API void clear();

    EQ_API void deleteAll();

    EQ_API unsigned getList( const void* key ) const;
    EQ_API unsigned newList( const void* key, const int num = 1 );
    EQ_API unsigned obtainList( const void* key, const int num = 1 );
    EQ_API void   deleteList( const void* key );

    EQ_API unsigned getTexture( const void* key ) const;
    EQ_API unsigned newTexture( const void* key );
    EQ_API unsigned obtainTexture( const void* key );
    EQ_API void   deleteTexture( const void* key );

    EQ_API bool   supportsBuffers() const;
    EQ_API unsigned getBuffer( const void* key ) const;
    EQ_API unsigned newBuffer( const void* key );
    EQ_API unsigned obtainBuffer( const void* key );
    EQ_API void   deleteBuffer( const void* key );

    EQ_API bool   supportsPrograms() const;
    EQ_API unsigned getProgram( const void* key ) const;
    EQ_API unsigned newProgram( const void* key );
    EQ_API unsigned obtainProgram( const void* key );
    EQ_API void   deleteProgram( const void* key );

    EQ_API bool   supportsShaders() const;
    EQ_API unsigned getShader( const void* key ) const;
    EQ_API unsigned newShader( const void* key, const unsigned type );
    EQ_API unsigned obtainShader( const void* key, const unsigned type );
    EQ_API void   deleteShader( const void* key );

    EQ_API Accum* getEqAccum( const void* key ) const;
    EQ_API Accum* newEqAccum( const void* key );
    EQ_API Accum* obtainEqAccum( const void* key );
    EQ_API void   deleteEqAccum( const void* key );

    EQ_API lunchbox::Uploader* getEqUploader( const void* key ) const;
    EQ_API lunchbox::Uploader* newEqUploader( const void* key );
    EQ_API lunchbox::Uploader* obtainEqUploader( const void* key );
    EQ_API void   deleteEqUploader( const void* key );

    EQ_API bool     supportsEqTexture() const;
    EQ_API Texture* getEqTexture( const void* key ) const;
    EQ_API Texture* newEqTexture( const void* key, const unsigned target );
    EQ_API Texture* obtainEqTexture( const void* key, const unsigned target );
    EQ_API void     deleteEqTexture( const void* key );

    EQ_API bool               supportsEqFrameBufferObject() const;
    EQ_API FrameBufferObject* getEqFrameBufferObject(const void* key) const;
    EQ_API FrameBufferObject* newEqFrameBufferObject( const void* key );
    EQ_API FrameBufferObject* obtainEqFrameBufferObject( const void* key );
    EQ_API void               deleteEqFrameBufferObject( const void* key );

    EQ_API bool               supportsEqPixelBufferObject() const;
    EQ_API PixelBufferObject* getEqPixelBufferObject(const void* key) const;
    EQ_API PixelBufferObject* newEqPixelBufferObject( const void* key,
                                                      const bool threadSafe );
    EQ_API PixelBufferObject* obtainEqPixelBufferObject( const void* key,
                                                         const bool threadSafe );
    EQ_API void               deleteEqPixelBufferObject( const void* key );

    EQ_API util::BitmapFont* getEqBitmapFont( const void* key ) const;
    EQ_API util::BitmapFont* newEqBitmapFont( const void* key );
    EQ_API util::BitmapFont* obtainEqBitmapFont( const void* key );
    EQ_API void                   deleteEqBitmapFont( const void* key );

    EQ_API const GLEWContext* glewGetContext() const;

private:
    typedef lunchbox::RefPtr< detail::ObjectManager > SharedDataPtr;
    SharedDataPtr _impl;
};
}
}

#endif // EQUTIL_OBJECTMANAGER_H