Renderer.h

/***********************************************************************
    filename: CEGUIRenderer.h
    created:  20/2/2004
    author:   Paul D Turner

    purpose: Defines interface for abstract Renderer class
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2011 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 _CEGUIRenderer_h_
#define _CEGUIRenderer_h_

#include "CEGUI/Base.h"
#include "CEGUI/String.h"
#include "CEGUI/Size.h"
#include "CEGUI/Vector.h"

// Start of CEGUI namespace section
namespace CEGUI
{
//----------------------------------------------------------------------------//
enum QuadSplitMode
{
    TopLeftToBottomRight,
    BottomLeftToTopRight
};

//----------------------------------------------------------------------------//

enum BlendMode
{
    BM_INVALID,
    BM_NORMAL,
    BM_RTT_PREMULTIPLIED
};

//----------------------------------------------------------------------------//

class CEGUIEXPORT Renderer :
    public AllocatedObject<Renderer>
{
public:
    virtual RenderTarget& getDefaultRenderTarget() = 0;

    virtual GeometryBuffer& createGeometryBuffer() = 0;

    virtual void destroyGeometryBuffer(const GeometryBuffer& buffer) = 0;

    virtual void destroyAllGeometryBuffers() = 0;

    virtual TextureTarget* createTextureTarget() = 0;

    virtual void destroyTextureTarget(TextureTarget* target) = 0;

    virtual void destroyAllTextureTargets() = 0;

    virtual Texture& createTexture(const String& name) = 0;

    virtual Texture& createTexture(const String& name,
                                   const String& filename,
                                   const String& resourceGroup) = 0;

    virtual Texture& createTexture(const String& name, const Sizef& size) = 0;

    virtual void destroyTexture(Texture& texture) = 0;

    virtual void destroyTexture(const String& name) = 0;

    virtual void destroyAllTextures() = 0;

    virtual Texture& getTexture(const String& name) const = 0;

    virtual bool isTextureDefined(const String& name) const = 0;

    virtual void beginRendering() = 0;

    virtual void endRendering() = 0;

    virtual void setDisplaySize(const Sizef& size) = 0;

    virtual const Sizef& getDisplaySize() const = 0;

    virtual const Vector2f& getDisplayDPI() const = 0;

    virtual uint getMaxTextureSize() const = 0;

    virtual const String& getIdentifierString() const = 0;

    virtual ~Renderer() {}
};

} // End of  CEGUI namespace section


#endif // end of guard _CEGUIRenderer_h_