texture.h

/* Copyright (c) 2009-2015, Stefan Eilemann <eile@equalizergraphics.com>
 *                          Cedric Stalder <cedric.stalder@gmail.com>
 *                          Daniel Nachbaur <danielnachbaur@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/frame.h>        // Frame::Buffer enum
#include <lunchbox/thread.h> // thread debug macro

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

class Texture
{
public:
    EQ_API Texture(const unsigned target,
                   const GLEWContext* const glewContext = 0);

    EQ_API virtual ~Texture();

    EQ_API unsigned getTarget() const;

    uint32_t getCompressorTarget() const;

    EQ_API unsigned getInternalFormat() const;

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

    EQ_API unsigned getFormat() const;

    EQ_API unsigned getType() const;

    EQ_API unsigned getName() const;

    EQ_API int32_t getWidth() const;

    EQ_API int32_t getHeight() const;

    EQ_API bool isValid() const;

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

    EQ_API void flush();

    EQ_API void applyZoomFilter(const ZoomFilter filter) const;

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

    EQ_API void copyFromFrameBuffer(const unsigned 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 unsigned target, const int32_t width,
                          const int32_t height, const int32_t samples = 1);

    EQ_API void resize(const int32_t width, const int32_t height);

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

    EQ_API const GLEWContext* glewGetContext() const;
    EQ_API void setGLEWContext(const GLEWContext* context);

    EQ_API void flushNoDelete();

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

private:
    Texture(const Texture&) = delete;
    Texture& operator=(const Texture&) = delete;
    detail::Texture* const _impl;

    void _setInternalFormat(const unsigned internalFormat);

    void _generate();

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

    LB_TS_VAR(_thread);
};
EQ_API std::ostream& operator<<(std::ostream&, const Texture&);
}
}

#endif // EQUTIL_TEXTURE_H