RendererModules/OpenGL/Texture.h

/***********************************************************************
    created:    Sun Jan 11 2009
    author:     Paul D Turner
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIOpenGLTexture_h_
#define _CEGUIOpenGLTexture_h_

#include "../../Base.h"
#include "../../Renderer.h"
#include "../../Texture.h"
#include "CEGUI/RendererModules/OpenGL/RendererBase.h"

#if defined(_MSC_VER)
#       pragma warning(push)
#       pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{
class OPENGL_GUIRENDERER_API OpenGLTexture : public Texture
{
public:
    void setOpenGLTexture(GLuint tex, const Sizef& size);

    GLuint getOpenGLTexture() const;

    void setTextureSize(const Sizef& sz);

    void grabTexture();

    void restoreTexture();

    // implement abstract members from base class.
    const String& getName() const;
    const Sizef& getSize() const;
    const Sizef& getOriginalDataSize() const;
    const Vector2f& getTexelScaling() const;
    void loadFromFile(const String& filename, const String& resourceGroup);
    void loadFromMemory(const void* buffer, const Sizef& buffer_size,
                        PixelFormat pixel_format);
    void blitFromMemory(const void* sourceData, const Rectf& area);
    void blitToMemory(void* targetData);
    bool isPixelFormatSupported(const PixelFormat fmt) const;

protected:
    // Friends (to allow construction and destruction)
    friend Texture& OpenGLRendererBase::createTexture(const String&);
    friend Texture& OpenGLRendererBase::createTexture(const String&, const String&, const String&);
    friend Texture& OpenGLRendererBase::createTexture(const String&, const Sizef&);
    friend Texture& OpenGLRendererBase::createTexture(const String&, GLuint, const Sizef&);
    friend void OpenGLRendererBase::destroyTexture(Texture&);
    friend void OpenGLRendererBase::destroyTexture(const String&);

    OpenGLTexture(OpenGLRendererBase& owner, const String& name);
    OpenGLTexture(OpenGLRendererBase& owner, const String& name,
                  const String& filename, const String& resourceGroup);
    OpenGLTexture(OpenGLRendererBase& owner, const String& name,
                  const Sizef& size);
    OpenGLTexture(OpenGLRendererBase& owner, const String& name,
                  GLuint tex, const Sizef& size);
    virtual ~OpenGLTexture();

    void generateOpenGLTexture();

    void updateCachedScaleValues();

    void cleanupOpenGLTexture();

    void initInternalPixelFormatFields(const PixelFormat fmt);

    void setTextureSize_impl(const Sizef& sz);

    void loadUncompressedTextureBuffer(const Rectf& dest_area,
                                       const GLvoid* buffer) const;

    void loadCompressedTextureBuffer(const Rectf& dest_area,
                                     const GLvoid* buffer) const;

    GLsizei getCompressedTextureSize(const Sizef& pixel_size) const;

    GLuint d_ogltexture;
    Sizef d_size;
    uint8* d_grabBuffer;
    Sizef d_dataSize;
    Vector2f d_texelScaling;
    OpenGLRendererBase& d_owner;
    const String d_name;
    GLenum d_format;
    GLenum d_subpixelFormat;
    bool d_isCompressed;
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#       pragma warning(pop)
#endif

#endif // end of guard _CEGUIOpenGLTexture_h_