Crazy Eddie's GUI System  0.8.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
RendererModules/Ogre/Texture.h
1 /***********************************************************************
2  filename: CEGUIOgreTexture.h
3  created: Tue Feb 17 2009
4  author: Paul D Turner
5 *************************************************************************/
6 /***************************************************************************
7  * Copyright (C) 2004 - 2011 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 _CEGUIOgreTexture_h_
29 #define _CEGUIOgreTexture_h_
30 
31 #include "../../Texture.h"
32 #include "CEGUI/RendererModules/Ogre/Renderer.h"
33 #include <OgreTexture.h>
34 
35 // Start of CEGUI namespace section
36 namespace CEGUI
37 {
39 class OGRE_GUIRENDERER_API OgreTexture : public Texture
40 {
41 public:
43  void setOgreTexture(Ogre::TexturePtr texture, bool take_ownership = false);
45  Ogre::TexturePtr getOgreTexture() const;
46 
48  static Ogre::String getUniqueName();
49 
50  // implement CEGUI::Texture interface
51  const String& getName() const;
52  const Sizef& getSize() const;
53  const Sizef& getOriginalDataSize() const;
54  const Vector2f& getTexelScaling() const;
55  void loadFromFile(const String& filename, const String& resourceGroup);
56  void loadFromMemory(const void* buffer, const Sizef& buffer_size,
57  PixelFormat pixel_format);
58  void blitFromMemory(const void* sourceData, const Rectf& area);
59  void blitToMemory(void* targetData);
60  bool isPixelFormatSupported(const PixelFormat fmt) const;
61 
63  static Texture::PixelFormat fromOgrePixelFormat(const Ogre::PixelFormat fmt);
65  static Ogre::PixelFormat toOgrePixelFormat(const Texture::PixelFormat fmt);
66 
67 protected:
68  // we all need a little help from out friends ;)
70  friend Texture& OgreRenderer::createTexture(const String&, const String&,
71  const String&);
72  friend Texture& OgreRenderer::createTexture(const String&, const Sizef&);
73  friend Texture& OgreRenderer::createTexture(const String&, Ogre::TexturePtr&,
74  bool);
76  friend void OgreRenderer::destroyTexture(const String&);
77 
79  OgreTexture(const String& name);
81  OgreTexture(const String& name, const String& filename,
82  const String& resourceGroup);
84  OgreTexture(const String& name, const Sizef& sz);
86  OgreTexture(const String& name, Ogre::TexturePtr& tex, bool take_ownership);
87 
89  virtual ~OgreTexture();
91  void freeOgreTexture();
93  void updateCachedScaleValues();
94 
96  static uint32 d_textureNumber;
98  Ogre::TexturePtr d_texture;
108  const String d_name;
109 };
110 
111 } // End of CEGUI namespace section
112 
113 #endif // end of guard _CEGUIOgreTexture_h_