Crazy Eddies GUI System  0.7.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
CEGUIDirectFBRenderer.h
1 /***********************************************************************
2  filename: CEGUIDirectFBRenderer.h
3  created: Tue Mar 10 2009
4  author: Paul D Turner (parts based on code by Keith Mok)
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining
10  * a copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  *
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  *
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
23  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26  * OTHER DEALINGS IN THE SOFTWARE.
27  ***************************************************************************/
28 #ifndef _CEGUIDirectFBRenderer_h_
29 #define _CEGUIDirectFBRenderer_h_
30 
31 #include "../../CEGUIRenderer.h"
32 #include "../../CEGUISize.h"
33 #include "../../CEGUIVector.h"
34 #include <directfb.h>
35 #include <vector>
36 
37 // Start of CEGUI namespace section
38 namespace CEGUI
39 {
40 class DirectFBTexture;
41 class DirectFBGeometryBuffer;
42 
44 class DirectFBRenderer : public Renderer
45 {
46 public:
48  static DirectFBRenderer& create(IDirectFB& directfb,
49  IDirectFBSurface& surface);
51  static void destroy(DirectFBRenderer& renderer);
52 
54  IDirectFBSurface& getTargetSurface() const;
55 
57  void setTargetSurface(IDirectFBSurface& surface);
58 
59  // Implementation of Renderer interface.
62  void destroyGeometryBuffer(const GeometryBuffer& buffer);
65  void destroyTextureTarget(TextureTarget* target);
68  Texture& createTexture(const String& filename, const String& resourceGroup);
69  Texture& createTexture(const Size& size);
70  void destroyTexture(Texture& texture);
71  void destroyAllTextures();
72  void beginRendering();
73  void endRendering();
74  void setDisplaySize(const Size& sz);
75  const Size& getDisplaySize() const;
76  const Vector2& getDisplayDPI() const;
77  uint getMaxTextureSize() const;
78  const String& getIdentifierString() const;
79 
80 protected:
82  DirectFBRenderer(IDirectFB& directfb, IDirectFBSurface& surface);
85 
89  IDirectFB& d_directfb;
91  IDirectFBSurface& d_rootSurface;
93  IDirectFBSurface* d_targetSurface;
103  typedef std::vector<TextureTarget*> TextureTargetList;
107  typedef std::vector<DirectFBGeometryBuffer*> GeometryBufferList;
111  typedef std::vector<DirectFBTexture*> TextureList;
114 };
115 
116 } // End of CEGUI namespace section
117 
118 #endif // end of guard _CEGUIDirectFBRenderer_h_
IDirectFBSurface & getTargetSurface() const
Return the current target DirectFB surface.
TextureTarget * createTextureTarget()
Create a TextureTarget that can be used to cache imagery; this is a RenderTarget that does not lose i...
void beginRendering()
Perform any operations required to put the system into a state ready for rendering operations to begi...
TextureList d_textures
Container used to track textures.
Definition: CEGUIDirectFBRenderer.h:113
IDirectFBSurface * d_targetSurface
The current target DirectFB surface.
Definition: CEGUIDirectFBRenderer.h:93
Class used as a two dimensional vector (aka a Point)
Definition: CEGUIVector.h:45
static void destroy(DirectFBRenderer &renderer)
destroy a DirectFBRenderer object created by the create call.
std::vector< DirectFBGeometryBuffer * > GeometryBufferList
container type used to hold GeometryBuffers we create.
Definition: CEGUIDirectFBRenderer.h:107
RenderTarget * d_defaultTarget
The default RenderTarget (used by d_defaultRoot)
Definition: CEGUIDirectFBRenderer.h:99
void setDisplaySize(const Size &sz)
Set the size of the display or host window in pixels for this Renderer object.
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: CEGUIGeometryBuffer.h:42
void destroyAllTextures()
Destroy all Texture objects created by this Renderer.
Class that holds the size (width &amp; height) of something.
Definition: CEGUISize.h:43
Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...
Definition: CEGUITextureTarget.h:41
IDirectFBSurface & d_rootSurface
The DirectFB surface to be used as the default root target.
Definition: CEGUIDirectFBRenderer.h:91
const Size & getDisplaySize() const
Return the size of the display or host window in pixels.
void destroyGeometryBuffer(const GeometryBuffer &buffer)
Destroy a GeometryBuffer that was returned when calling the createGeometryBuffer function. Before destroying any GeometryBuffer you should ensure that it has been removed from any RenderQueue that was using it.
static DirectFBRenderer & create(IDirectFB &directfb, IDirectFBSurface &surface)
create a DirectFBRenderer object.
Texture & createTexture()
Create a &#39;null&#39; Texture object.
Abstract base class specifying the required interface for Texture objects.
Definition: CEGUITexture.h:50
Abstract class defining the basic required interface for Renderer objects.
Definition: CEGUIRenderer.h:80
DirectFBRenderer(IDirectFB &directfb, IDirectFBSurface &surface)
Constructor.
void destroyTexture(Texture &texture)
Destroy a Texture object that was previously created by calling the createTexture functions...
Vector2 d_displayDPI
What the renderer considers to be the current display DPI resolution.
Definition: CEGUIDirectFBRenderer.h:97
Definition: CEGUIRenderingRoot.h:36
void destroyAllGeometryBuffers()
Destroy all GeometryBuffer objects created by this Renderer.
const String & getIdentifierString() const
Return identification string for the renderer module.
IDirectFB & d_directfb
DirectFB interface we were given when constructed.
Definition: CEGUIDirectFBRenderer.h:89
Implementation of CEGUI::Renderer interface using DirectFB.
Definition: CEGUIDirectFBRenderer.h:44
GeometryBuffer & createGeometryBuffer()
Create a new GeometryBuffer and return a reference to it. You should remove the GeometryBuffer from a...
void destroyTextureTarget(TextureTarget *target)
Function that cleans up TextureTarget objects created with the createTextureTarget function...
Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...
Definition: CEGUIRenderTarget.h:42
Size d_displaySize
What the renderer considers to be the current display size.
Definition: CEGUIDirectFBRenderer.h:95
TextureTargetList d_textureTargets
Container used to track texture targets.
Definition: CEGUIDirectFBRenderer.h:105
void setTargetSurface(IDirectFBSurface &surface)
Set the target DirectFB surface.
~DirectFBRenderer()
Destructor.
static String d_rendererID
String holding the renderer identification text.
Definition: CEGUIDirectFBRenderer.h:87
uint getMaxTextureSize() const
Return the pixel size of the maximum supported texture.
std::vector< TextureTarget * > TextureTargetList
container type used to hold TextureTargets we create.
Definition: CEGUIDirectFBRenderer.h:103
void endRendering()
Perform any operations required to finalise rendering.
void destroyAllTextureTargets()
Destory all TextureTarget objects created by this Renderer.
GeometryBufferList d_geometryBuffers
Container used to track geometry buffers.
Definition: CEGUIDirectFBRenderer.h:109
RenderingRoot & getDefaultRenderingRoot()
Return the default rendering root for the renderer. The default rendering root is typically a Renderi...
RenderingRoot * d_defaultRoot
The default rendering root object.
Definition: CEGUIDirectFBRenderer.h:101
String class used within the GUI system.
Definition: CEGUIString.h:57
std::vector< DirectFBTexture * > TextureList
container type used to hold Textures we create.
Definition: CEGUIDirectFBRenderer.h:111
const Vector2 & getDisplayDPI() const
Return the resolution of the display or host window in dots per inch.