Crazy Eddie's GUI System  0.8.7
RendererModules/OpenGLES/Renderer.h
1 /***********************************************************************
2  created: Sun Jan 11 2009
3  author: Paul D Turner
4 *************************************************************************/
5 /***************************************************************************
6  * Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining
9  * a copy of this software and associated documentation files (the
10  * "Software"), to deal in the Software without restriction, including
11  * without limitation the rights to use, copy, modify, merge, publish,
12  * distribute, sublicense, and/or sell copies of the Software, and to
13  * permit persons to whom the Software is furnished to do so, subject to
14  * the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be
17  * included in all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25  * OTHER DEALINGS IN THE SOFTWARE.
26  ***************************************************************************/
27 #ifndef _CEGUIOpenGLESRenderer_h_
28 #define _CEGUIOpenGLESRenderer_h_
29 
30 #include "CEGUI/Base.h"
31 #include "CEGUI/Renderer.h"
32 #include "CEGUI/Size.h"
33 #include "CEGUI/Vector.h"
34 #include "CEGUI/RendererModules/OpenGLES/GLES.h"
35 #include <vector>
36 #include <map>
37 
38 #if (defined( __WIN32__ ) || defined( _WIN32 )) && !defined(CEGUI_STATIC)
39 # ifdef CEGUIOPENGLESRENDERER_EXPORTS
40 # define OPENGLES_GUIRENDERER_API __declspec(dllexport)
41 # else
42 # define OPENGLES_GUIRENDERER_API __declspec(dllimport)
43 # endif
44 #else
45 # define OPENGLES_GUIRENDERER_API
46 #endif
47 
48 #if defined(_MSC_VER)
49 # pragma warning(push)
50 # pragma warning(disable : 4251)
51 #endif
52 
53 
54 // Start of CEGUI namespace section
55 namespace CEGUI
56 {
57 class OpenGLESTexture;
58 class OpenGLESTextureTarget;
59 class OpenGLESGeometryBuffer;
60 class OGLTextureTargetFactory;
61 
66 class OPENGLES_GUIRENDERER_API OpenGLESRenderer : public Renderer
67 {
68 public:
71  {
79  TTT_NONE
80  };
81 
105  static OpenGLESRenderer& bootstrapSystem(
106  const TextureTargetType tt_type = TTT_AUTO,
107  const int abi = CEGUI_VERSION_ABI);
108 
135  static OpenGLESRenderer& bootstrapSystem(
136  const Sizef& display_size,
137  const TextureTargetType tt_type = TTT_AUTO,
138  const int abi = CEGUI_VERSION_ABI);
139 
155  static void destroySystem();
156 
168  static OpenGLESRenderer& create(const TextureTargetType tt_type = TTT_AUTO,
169  const int abi = CEGUI_VERSION_ABI);
170 
185  static OpenGLESRenderer& create(const Sizef& display_size,
186  const TextureTargetType tt_type = TTT_AUTO,
187  const int abi = CEGUI_VERSION_ABI);
188 
196  static void destroy(OpenGLESRenderer& renderer);
197 
206  static bool isGLExtensionSupported( const char* extension );
207 
208  // implement Renderer interface
209  RenderTarget& getDefaultRenderTarget();
210  GeometryBuffer& createGeometryBuffer();
211  void destroyGeometryBuffer(const GeometryBuffer& buffer);
212  void destroyAllGeometryBuffers();
213  TextureTarget* createTextureTarget();
214  void destroyTextureTarget(TextureTarget* target);
215  void destroyAllTextureTargets();
216  Texture& createTexture(const String& name);
217  Texture& createTexture(const String& name,
218  const String& filename,
219  const String& resourceGroup);
220  Texture& createTexture(const String& name, const Sizef& size);
221  void destroyTexture(Texture& texture);
222  void destroyTexture(const String& name);
223  void destroyAllTextures();
224  Texture& getTexture(const String& name) const;
225  bool isTextureDefined(const String& name) const;
226  void beginRendering();
227  void endRendering();
228  void setDisplaySize(const Sizef& sz);
229  const Sizef& getDisplaySize() const;
230  const Vector2f& getDisplayDPI() const;
231  uint getMaxTextureSize() const;
232  const String& getIdentifierString() const;
233 
248  Texture& createTexture(const String& name, GLuint tex, const Sizef& sz);
249 
261  void enableExtraStateSettings(bool setting);
262 
270  void grabTextures();
271 
277  void restoreTextures();
278 
290  Sizef getAdjustedTextureSize(const Sizef& sz) const;
291 
297  static float getNextPOTSize(const float f);
298 
314  bool isTexCoordSystemFlipped() const { return true; }
315 
316 private:
325  OpenGLESRenderer(const TextureTargetType tt_type);
326 
338  OpenGLESRenderer(const Sizef& display_size, const TextureTargetType tt_type);
339 
344  virtual ~OpenGLESRenderer();
345 
347  void setupExtraStates();
348 
350  void cleanupExtraStates();
351 
353  void initialiseTextureTargetFactory(const TextureTargetType tt_type);
354 
356  void logTextureDestruction(const String& name);
357 
359  struct RenderStates
360  {
361  GLboolean glScissorTest;
362  GLboolean texturing;
363  GLboolean blend;
364  GLint arrayBuffer;
365  GLint texture;
366  GLint texEnvParam;
367  } glPreRenderStates;
368 
370  static String d_rendererID;
372  Sizef d_displaySize;
374  Vector2f d_displayDPI;
376  RenderTarget* d_defaultTarget;
378  typedef std::vector<TextureTarget*> TextureTargetList;
380  TextureTargetList d_textureTargets;
382  typedef std::vector<OpenGLESGeometryBuffer*> GeometryBufferList;
384  GeometryBufferList d_geometryBuffers;
386  typedef std::map<String, OpenGLESTexture*, StringFastLessCompare
387  CEGUI_MAP_ALLOC(String, OpenGLESTexture*)> TextureMap;
389  TextureMap d_textures;
391  uint d_maxTextureSize;
393  bool d_initExtraStates;
395  OGLTextureTargetFactory* d_textureTargetFactory;
396  };
397 
398 } // End of CEGUI namespace section
399 
400 #if defined(_MSC_VER)
401 # pragma warning(pop)
402 #endif
403 
404 #endif // end of guard _CEGUIOpenGLESRenderer_h_
405 
Use targets based on frame buffer objects if available, else none.
Definition: RendererModules/OpenGLES/Renderer.h:75
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
Renderer class to interface with OpenGLES.
Definition: RendererModules/OpenGLES/Renderer.h:66
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: GeometryBuffer.h:42
Automatically choose the best type available.
Definition: RendererModules/OpenGLES/Renderer.h:73
TextureTargetType
Enumeration of valid texture target types.
Definition: RendererModules/OpenGLES/Renderer.h:70
Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...
Definition: TextureTarget.h:40
Abstract base class specifying the required interface for Texture objects.
Definition: Texture.h:52
Use targets based on pbuffer support if available, else none.
Definition: RendererModules/OpenGLES/Renderer.h:77
Abstract class defining the basic required interface for Renderer objects.
Definition: Renderer.h:82
Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...
Definition: RenderTarget.h:57
bool isTexCoordSystemFlipped() const
Returns if the texture coordinate system is vertically flipped or not. The original of a texture coor...
Definition: RendererModules/OpenGLES/Renderer.h:314
String class used within the GUI system.
Definition: String.h:62