RendererBase.h

/***********************************************************************
    filename:   RendererBase.h
    created:    Tue Apr 30 2013
    authors:    Paul D Turner <paul@cegui.org.uk>
                Lukas E Meindl
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2013 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 _CEGUIRendererBase_h_
#define _CEGUIRendererBase_h_

#include "../../Base.h"
#include "../../Renderer.h"
#include "../../Size.h"
#include "../../Vector.h"
#include "../../Rect.h"
#include "../../TextureTarget.h"
#include "CEGUI/RendererModules/OpenGL/GL.h"
#include <vector>
#include <map>

#if (defined( __WIN32__ ) || defined( _WIN32 )) && !defined(CEGUI_STATIC)
#   ifdef CEGUIOPENGLRENDERER_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

namespace CEGUI
{
class OpenGLTexture;
class OpenGLGeometryBufferBase;
struct mat4Pimpl;

class OPENGL_GUIRENDERER_API OpenGLRendererBase : public Renderer
{
public:
    // implement Renderer interface
    RenderTarget& getDefaultRenderTarget();
    GeometryBuffer& createGeometryBuffer();
    void destroyGeometryBuffer(const GeometryBuffer& buffer);
    void destroyAllGeometryBuffers();
    TextureTarget* createTextureTarget();
    void destroyTextureTarget(TextureTarget* target);
    void destroyAllTextureTargets();
    Texture& createTexture(const String& name);
    Texture& createTexture(const String& name,
                           const String& filename,
                           const String& resourceGroup);
    Texture& createTexture(const String& name, const Sizef& size);
    void destroyTexture(Texture& texture);
    void destroyTexture(const String& name);
    void destroyAllTextures();
    Texture& getTexture(const String& name) const;
    bool isTextureDefined(const String& name) const;
    void setDisplaySize(const Sizef& sz);
    const Sizef& getDisplaySize() const;
    const Vector2f& getDisplayDPI() const;
    uint getMaxTextureSize() const;
    const String& getIdentifierString() const;

    Texture& createTexture(const String& name, GLuint tex, const Sizef& sz);

    void enableExtraStateSettings(bool setting);

    void grabTextures();

    void restoreTextures();

    virtual Sizef getAdjustedTextureSize(const Sizef& sz) const;

    static float getNextPOTSize(const float f);

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

    virtual bool isS3TCSupported() const = 0;

    virtual const mat4Pimpl* getViewProjectionMatrix();

    virtual void setViewProjectionMatrix(const mat4Pimpl* viewProjectionMatrix);

    const CEGUI::Rectf& getActiveViewPort();

    void setActiveRenderTarget(RenderTarget* renderTarget);
        
    RenderTarget* getActiveRenderTarget();

protected:
    OpenGLRendererBase();

    OpenGLRendererBase(const Sizef& display_size);

    virtual ~OpenGLRendererBase();

    static void logTextureCreation(const String& name);
    static void logTextureDestruction(const String& name);

    void initialiseMaxTextureSize();

    void initialiseDisplaySizeWithViewportSize();

    virtual OpenGLGeometryBufferBase* createGeometryBuffer_impl() = 0;

    virtual TextureTarget* createTextureTarget_impl() = 0;

    static String d_rendererID;
    Sizef d_displaySize;
    Vector2f d_displayDPI;
    RenderTarget* d_defaultTarget;
    typedef std::vector<TextureTarget*> TextureTargetList;
    TextureTargetList d_textureTargets;
    typedef std::vector<OpenGLGeometryBufferBase*> GeometryBufferList;
    GeometryBufferList d_geometryBuffers;
    typedef std::map<String, OpenGLTexture*, StringFastLessCompare
                     CEGUI_MAP_ALLOC(String, OpenGLTexture*)> TextureMap;
    TextureMap d_textures;
    uint d_maxTextureSize;
    bool d_initExtraStates;
    BlendMode d_activeBlendMode;
    mat4Pimpl* d_viewProjectionMatrix;
    RenderTarget* d_activeRenderTarget;
};

class OGLTextureTargetFactory :
    public AllocatedObject<OGLTextureTargetFactory>
{
public:
    OGLTextureTargetFactory() {}
    virtual ~OGLTextureTargetFactory() {}
    virtual TextureTarget* create(OpenGLRendererBase&) const
        { return 0; }
};

}

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

#endif