Crazy Eddies GUI System: CEGUIRenderer.h Source File

Crazy Eddies GUI System 0.7.6

- Main Page
- Related Pages
- Namespaces
- Classes
- Files

- File List

CEGUIRenderer.h

    00001 /***********************************************************************
    00002     filename: CEGUIRenderer.h
    00003     created:  20/2/2004
    00004     author:   Paul D Turner
    00005
    00006     purpose: Defines interface for abstract Renderer class
    00007 *************************************************************************/
    00008 /***************************************************************************
    00009  *   Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
    00010  *
    00011  *   Permission is hereby granted, free of charge, to any person obtaining
    00012  *   a copy of this software and associated documentation files (the
    00013  *   "Software"), to deal in the Software without restriction, including
    00014  *   without limitation the rights to use, copy, modify, merge, publish,
    00015  *   distribute, sublicense, and/or sell copies of the Software, and to
    00016  *   permit persons to whom the Software is furnished to do so, subject to
    00017  *   the following conditions:
    00018  *
    00019  *   The above copyright notice and this permission notice shall be
    00020  *   included in all copies or substantial portions of the Software.
    00021  *
    00022  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    00023  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
    00024  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
    00025  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
    00026  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
    00027  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
    00028  *   OTHER DEALINGS IN THE SOFTWARE.
    00029  ***************************************************************************/
    00030 #ifndef _CEGUIRenderer_h_
    00031 #define _CEGUIRenderer_h_
    00032
    00033 #include "CEGUIBase.h"
    00034
    00035 // Start of CEGUI namespace section
    00036 namespace CEGUI
    00037 {
    00038 //----------------------------------------------------------------------------//
    00044 enum QuadSplitMode
    00045 {
    00047     TopLeftToBottomRight,
    00049     BottomLeftToTopRight
    00050 };
    00051
    00052 //----------------------------------------------------------------------------//
    00053
    00059 enum BlendMode
    00060 {
    00062     BM_INVALID,
    00064     BM_NORMAL,
    00066     BM_RTT_PREMULTIPLIED
    00067 };
    00068
    00069 //----------------------------------------------------------------------------//
    00070
    00080 class CEGUIEXPORT Renderer
    00081 {
    00082 public:
    00093     virtual RenderingRoot& getDefaultRenderingRoot() = 0;
    00094
    00104     virtual GeometryBuffer& createGeometryBuffer() = 0;
    00105
    00116     virtual void destroyGeometryBuffer(const GeometryBuffer& buffer) = 0;
    00117
    00122     virtual void destroyAllGeometryBuffers() = 0;
    00123
    00135     virtual TextureTarget* createTextureTarget() = 0;
    00136
    00146     virtual void destroyTextureTarget(TextureTarget* target) = 0;
    00147
    00152     virtual void destroyAllTextureTargets() = 0;
    00153
    00162     virtual Texture& createTexture() = 0;
    00163
    00186     virtual Texture& createTexture(const String& filename,
    00187                                    const String& resourceGroup) = 0;
    00188
    00206     virtual Texture& createTexture(const Size& size) = 0;
    00207
    00216     virtual void destroyTexture(Texture& texture) = 0;
    00217
    00222     virtual void destroyAllTextures() = 0;
    00223
    00229     virtual void beginRendering() = 0;
    00230
    00235     virtual void endRendering() = 0;
    00236
    00254     virtual void setDisplaySize(const Size& size) = 0;
    00255
    00264     virtual const Size& getDisplaySize() const = 0;
    00265
    00274     virtual const Vector2& getDisplayDPI() const = 0;
    00275
    00283     virtual uint getMaxTextureSize() const = 0;
    00284
    00292     virtual const String& getIdentifierString() const = 0;
    00293
    00295     virtual ~Renderer() {}
    00296 };
    00297
    00298 } // End of  CEGUI namespace section
    00299
    00300
    00301 #endif // end of guard _CEGUIRenderer_h_