texture.h

/* Copyright (c) 2009-2011, Stefan Eilemann <eile@equalizergraphics.com>
 *                    2010, Cedric Stalder <cedric.stalder@gmail.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_TEXTURE_H
#define EQUTIL_TEXTURE_H

#include <eq/gl.h>           // GLEW
#include <eq/frame.h>        // Frame::Buffer enum

#include <co/base/thread.h>         // thread debug macro
#include <co/base/nonCopyable.h>    // base class

namespace eq
{
    class Image;

namespace util
{
    class Texture : public co::base::NonCopyable
    {
    public:
        EQ_API Texture( const GLenum target,
                           const GLEWContext* const glewContext = 0 );

        EQ_API virtual ~Texture();

        GLenum getTarget() const { return _target; }

        uint32_t getCompressorTarget() const;

        GLuint getInternalFormat() const { return _internalFormat; }

        EQ_API void setExternalFormat( const uint32_t format,
                                       const uint32_t type );

        GLuint getFormat() const { return _format; }

        GLuint getType() const { return _type; }

        GLuint getName() const { return _name; }

        int32_t getWidth() const { return _width; }

        int32_t getHeight() const { return _height; }

        EQ_API bool isValid() const;

        EQ_API void init( const GLuint internalFormat, const int32_t width,
                          const int32_t height );

        EQ_API void flush();

        void applyZoomFilter( const ZoomFilter filter ) const;

        void applyWrap() const; //<! @internal

        EQ_API void copyFromFrameBuffer( const GLuint internalFormat,
                                            const fabric::PixelViewport& pvp );

        EQ_API void upload( const int32_t width, const int32_t height,
                            const void* ptr );

        EQ_API void download( void* buffer ) const;

        EQ_API void bind() const;

        EQ_API void bindToFBO( const GLenum target, const int32_t width,
                                  const int32_t height );
        
        EQ_API void resize( const int32_t width, const int32_t height );

        EQ_API void writeRGB( const std::string& filename ) const;

        const GLEWContext* glewGetContext() const { return _glewContext; }
        void setGLEWContext( const GLEWContext* context )
            { _glewContext = context; }

        EQ_API void flushNoDelete();

        EQ_API void setGLData( const GLuint id, const GLuint internalFormat,
                               const int32_t width, const int32_t height );

    private:
        GLuint _name;

        const GLenum _target;

        GLuint _internalFormat;

        GLuint _format;

        GLuint _type;
        
        int32_t _width;

        int32_t _height;

        bool _defined;

        const GLEWContext* _glewContext;

        struct Private;
        Private* _private; // placeholder for binary-compatible changes

        void _setInternalFormat( const GLuint internalFormat );

        void _generate();
        
        void _grow( const int32_t width, const int32_t height );

        EQ_TS_VAR( _thread );
    };
}
}

#endif // EQUTIL_TEXTURE_H