CEGUIOpenGLRenderer.h

/***********************************************************************
    filename:   CEGUIOpenGLRenderer.h
    created:    Sun Jan 11 2009
    author:     Paul D Turner
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2010 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 _CEGUIOpenGLRenderer_h_
#define _CEGUIOpenGLRenderer_h_

#include "../../CEGUIBase.h"
#include "../../CEGUIRenderer.h"
#include "../../CEGUISize.h"
#include "../../CEGUIVector.h"
#include "CEGUIOpenGL.h"
#include <vector>

#if (defined( __WIN32__ ) || defined( _WIN32 )) && !defined(CEGUI_STATIC)
#   ifdef OPENGL_GUIRENDERER_EXPORTS
#       define OPENGL_GUIRENDERER_API __declspec(dllexport)
#   else
#       define OPENGL_GUIRENDERER_API __declspec(dllimport)
#   endif
#else
#   define OPENGL_GUIRENDERER_API
#endif

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


// Start of CEGUI namespace section
namespace CEGUI
{
class OpenGLTexture;
class OpenGLTextureTarget;
class OpenGLGeometryBuffer;
class OGLTextureTargetFactory;

class OPENGL_GUIRENDERER_API OpenGLRenderer : public Renderer
{
public:
    enum TextureTargetType
    {
        TTT_AUTO,
        TTT_FBO,
        TTT_PBUFFER,
        TTT_NONE
    };

    static OpenGLRenderer& bootstrapSystem(
                                    const TextureTargetType tt_type = TTT_AUTO);

    static OpenGLRenderer& bootstrapSystem(const Size& display_size,
                                  const TextureTargetType tt_type = TTT_AUTO);

    static void destroySystem();

    static OpenGLRenderer& create(const TextureTargetType tt_type = TTT_AUTO);

    static OpenGLRenderer& create(const Size& display_size,
                                  const TextureTargetType tt_type = TTT_AUTO);

    static void destroy(OpenGLRenderer& renderer);

    // implement Renderer interface
    RenderingRoot& getDefaultRenderingRoot();
    GeometryBuffer& createGeometryBuffer();
    void destroyGeometryBuffer(const GeometryBuffer& buffer);
    void destroyAllGeometryBuffers();
    TextureTarget* createTextureTarget();
    void destroyTextureTarget(TextureTarget* target);
    void destroyAllTextureTargets();
    Texture& createTexture();
    Texture& createTexture(const String& filename, const String& resourceGroup);
    Texture& createTexture(const Size& size);
    void destroyTexture(Texture& texture);
    void destroyAllTextures();
    void beginRendering();
    void endRendering();
    void setDisplaySize(const Size& sz);
    const Size& getDisplaySize() const;
    const Vector2& getDisplayDPI() const;
    uint getMaxTextureSize() const;
    const String& getIdentifierString() const;

    Texture& createTexture(GLuint tex, const Size& sz);

    void enableExtraStateSettings(bool setting);

    void grabTextures();

    void restoreTextures();

    Size getAdjustedTextureSize(const Size& sz) const;

    static float getNextPOTSize(const float f);

    void setupRenderingBlendMode(const BlendMode mode, const bool force = false);

private:
    OpenGLRenderer(const TextureTargetType tt_type);

    OpenGLRenderer(const Size& display_size, const TextureTargetType tt_type);

    virtual ~OpenGLRenderer();

    void setupExtraStates();

    void cleanupExtraStates();

    void initialiseTextureTargetFactory(const TextureTargetType tt_type);

    static String d_rendererID;
    Size d_displaySize;
    Vector2 d_displayDPI;
    RenderingRoot* d_defaultRoot;
    RenderTarget* d_defaultTarget;
    typedef std::vector<TextureTarget*> TextureTargetList;
    TextureTargetList d_textureTargets;
    typedef std::vector<OpenGLGeometryBuffer*> GeometryBufferList;
    GeometryBufferList d_geometryBuffers;
    typedef std::vector<OpenGLTexture*> TextureList;
    TextureList d_textures;
    uint d_maxTextureSize;
    bool d_initExtraStates;
    OGLTextureTargetFactory* d_textureTargetFactory;
    BlendMode d_activeBlendMode;
  };

} // End of  CEGUI namespace section

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

#endif // end of guard _CEGUIOpenGLRenderer_h_