Crazy Eddie's GUI System  0.8.7
RendererModules/Ogre/TextureTarget.h
1 /***********************************************************************
2  created: Tue Feb 17 2009
3  author: Paul D Turner
4 *************************************************************************/
5 /***************************************************************************
6  * Copyright (C) 2004 - 2011 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 _CEGUIOgreTextureTarget_h_
28 #define _CEGUIOgreTextureTarget_h_
29 
30 #include "../../TextureTarget.h"
31 #include "CEGUI/RendererModules/Ogre/RenderTarget.h"
32 
33 #if defined(_MSC_VER)
34 # pragma warning(push)
35 # pragma warning(disable : 4250)
36 #endif
37 
38 // Start of CEGUI namespace section
39 namespace CEGUI
40 {
42 class OGRE_GUIRENDERER_API OgreTextureTarget : public OgreRenderTarget<TextureTarget>
43 {
44 public:
46  OgreTextureTarget(OgreRenderer& owner, Ogre::RenderSystem& rs);
48  virtual ~OgreTextureTarget();
49 
50  // implementation of RenderTarget interface
51  bool isImageryCache() const;
52  // implement CEGUI::TextureTarget interface.
53  void clear();
54  Texture& getTexture() const;
55  void declareRenderSize(const Sizef& sz);
56  bool isRenderingInverted() const;
57 
58 protected:
60  static const float DEFAULT_SIZE;
62  static uint s_textureNumber;
67 };
68 
69 } // End of CEGUI namespace section
70 
71 #if defined(_MSC_VER)
72 # pragma warning(pop)
73 #endif
74 
75 #endif // end of guard _CEGUIOgreTextureTarget_h_
CEGUI::OgreTextureTarget::DEFAULT_SIZE
static const float DEFAULT_SIZE
default / initial size for the underlying texture.
Definition: RendererModules/Ogre/TextureTarget.h:60
CEGUI::OgreRenderer
CEGUI::Renderer implementation for the Ogre engine.
Definition: RendererModules/Ogre/Renderer.h:92
CEGUI::OgreTextureTarget::clear
void clear()
Clear the surface of the underlying texture.
CEGUI::OgreTextureTarget::d_CEGUITexture
OgreTexture * d_CEGUITexture
This wraps d_texture so it can be used by the core CEGUI lib.
Definition: RendererModules/Ogre/TextureTarget.h:66
CEGUI::OgreTextureTarget::getTexture
Texture & getTexture() const
Return a pointer to the CEGUI::Texture that the TextureTarget is using.
CEGUI::OgreTextureTarget
CEGUI::TextureTarget implementation for the Ogre engine.
Definition: RendererModules/Ogre/TextureTarget.h:43
CEGUI
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
CEGUI::OgreTextureTarget::isRenderingInverted
bool isRenderingInverted() const
Return whether rendering done on the target texture is inverted in relation to regular textures.
CEGUI::OgreTextureTarget::OgreTextureTarget
OgreTextureTarget(OgreRenderer &owner, Ogre::RenderSystem &rs)
Constructor.
CEGUI::OgreTextureTarget::~OgreTextureTarget
virtual ~OgreTextureTarget()
Destructor.
CEGUI::Texture
Abstract base class specifying the required interface for Texture objects.
Definition: Texture.h:54
CEGUI::OgreTextureTarget::generateTextureName
static String generateTextureName()
helper to generate unique texture names
CEGUI::OgreTextureTarget::s_textureNumber
static uint s_textureNumber
static data used for creating texture names
Definition: RendererModules/Ogre/TextureTarget.h:62
CEGUI::OgreRenderTarget
Intermediate RenderTarget implementing common parts for Ogre engine.
Definition: RendererModules/Ogre/RenderTarget.h:41
CEGUI::Size< float >
CEGUI::String
String class used within the GUI system.
Definition: String.h:64
CEGUI::OgreTextureTarget::isImageryCache
bool isImageryCache() const
Return whether the RenderTarget is an implementation that caches actual rendered imagery.
CEGUI::OgreTextureTarget::declareRenderSize
void declareRenderSize(const Sizef &sz)
Used to declare to the TextureTarget the largest size, in pixels, of the next set of incoming renderi...
CEGUI::OgreTexture
Implementation of the CEGUI::Texture class for the Ogre engine.
Definition: RendererModules/Ogre/Texture.h:39