Crazy Eddies GUI System  0.7.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
CEGUIOpenGLTexture.h
1 /***********************************************************************
2  filename: CEGUIOpenGLTexture.h
3  created: Sun Jan 11 2009
4  author: Paul D Turner
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 _CEGUIOpenGLTexture_h_
29 #define _CEGUIOpenGLTexture_h_
30 
31 #include "../../CEGUIBase.h"
32 #include "../../CEGUIRenderer.h"
33 #include "../../CEGUITexture.h"
34 #include "CEGUIOpenGLRenderer.h"
35 
36 // Start of CEGUI namespace section
37 namespace CEGUI
38 {
40 class OPENGL_GUIRENDERER_API OpenGLTexture : public Texture
41 {
42 public:
48  void setOpenGLTexture(GLuint tex, const Size& size);
49 
57  GLuint getOpenGLTexture() const;
58 
79  void setTextureSize(const Size& sz);
80 
88  void grabTexture();
89 
95  void restoreTexture();
96 
97  // implement abstract members from base class.
98  const Size& getSize() const;
99  const Size& getOriginalDataSize() const;
100  const Vector2& getTexelScaling() const;
101  void loadFromFile(const String& filename, const String& resourceGroup);
102  void loadFromMemory(const void* buffer, const Size& buffer_size,
103  PixelFormat pixel_format);
104  void saveToMemory(void* buffer);
105 
106 protected:
107  // Friends (to allow construction and destruction)
109  friend Texture& OpenGLRenderer::createTexture(const String&, const String&);
111  friend Texture& OpenGLRenderer::createTexture(GLuint, const Size&);
113 
118  const String& filename, const String& resourceGroup);
120  OpenGLTexture(OpenGLRenderer& owner, const Size& size);
122  OpenGLTexture(OpenGLRenderer& owner, GLuint tex, const Size& size);
124  virtual ~OpenGLTexture();
125 
127  void generateOpenGLTexture();
128 
130  void updateCachedScaleValues();
131 
133  void cleanupOpenGLTexture();
134 
136  GLuint d_ogltexture;
140  uint8* d_grabBuffer;
147 };
148 
149 } // End of CEGUI namespace section
150 
151 
152 #endif // end of guard _CEGUIOpenGLTexture_h_
Class used as a two dimensional vector (aka a Point)
Definition: CEGUIVector.h:45
PixelFormat
Enumerated type containing the supported pixel formats that can be passed to loadFromMemory.
Definition: CEGUITexture.h:58
uint8 * d_grabBuffer
cached image data for restoring the texture.
Definition: CEGUIOpenGLTexture.h:140
Size d_dataSize
original pixel of size data loaded into texture
Definition: CEGUIOpenGLTexture.h:142
Class that holds the size (width & height) of something.
Definition: CEGUISize.h:43
GLuint d_ogltexture
The OpenGL texture we're wrapping.
Definition: CEGUIOpenGLTexture.h:136
Texture & createTexture()
Create a 'null' Texture object.
Vector2 d_texelScaling
cached pixel to texel mapping scale values.
Definition: CEGUIOpenGLTexture.h:144
Abstract base class specifying the required interface for Texture objects.
Definition: CEGUITexture.h:50
Size d_size
Size of the texture.
Definition: CEGUIOpenGLTexture.h:138
void destroyTexture(Texture &texture)
Destroy a Texture object that was previously created by calling the createTexture functions...
Renderer class to interface with OpenGL.
Definition: CEGUIOpenGLRenderer.h:66
OpenGLRenderer & d_owner
OpenGLRenderer that created and owns this OpenGLTexture.
Definition: CEGUIOpenGLTexture.h:146
Texture implementation for the OpenGLRenderer.
Definition: CEGUIOpenGLTexture.h:40
String class used within the GUI system.
Definition: CEGUIString.h:57