GLRenderer.h

/***********************************************************************
    filename:   CEGUIOpenGLRenderer.h
    created:    Sun Jan 11 2009
    authors:    Paul D Turner <paul@cegui.org.uk>
                Lukas E Meindl
*************************************************************************/
/***************************************************************************
 *   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 "RendererBase.h"

namespace CEGUI
{
class OPENGL_GUIRENDERER_API OpenGLRenderer : public OpenGLRendererBase
{
public:
    enum TextureTargetType
    {
        TTT_AUTO,
        TTT_FBO,
        TTT_PBUFFER,
        TTT_NONE
    };

    static OpenGLRenderer& bootstrapSystem(
                                    const TextureTargetType tt_type = TTT_AUTO,
                                    const int abi = CEGUI_VERSION_ABI);

    static OpenGLRenderer& bootstrapSystem(const Sizef& display_size,
                                           const TextureTargetType tt_type = TTT_AUTO,
                                           const int abi = CEGUI_VERSION_ABI);

    static void destroySystem();

    static OpenGLRenderer& create(const TextureTargetType tt_type = TTT_AUTO,
                                  const int abi = CEGUI_VERSION_ABI);

    static OpenGLRenderer& create(const Sizef& display_size,
                                  const TextureTargetType tt_type = TTT_AUTO,
                                  const int abi = CEGUI_VERSION_ABI);

    static void destroy(OpenGLRenderer& renderer);

    // base class overrides / abstract function implementations
    void beginRendering();
    void endRendering();
    bool isS3TCSupported() const;
    void setupRenderingBlendMode(const BlendMode mode,
                                 const bool force = false);
    void setViewProjectionMatrix(const mat4Pimpl* viewProjectionMatrix);

protected:
    OpenGLGeometryBufferBase* createGeometryBuffer_impl();
    TextureTarget* createTextureTarget_impl();

    void initialiseRendererIDString();

    OpenGLRenderer(const TextureTargetType tt_type);

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

    virtual ~OpenGLRenderer();

    void setupExtraStates();

    void cleanupExtraStates();

    void initialiseTextureTargetFactory(const TextureTargetType tt_type);

    void initialiseGLExtensions();

    OGLTextureTargetFactory* d_textureTargetFactory;
};

}

#endif