Crazy Eddie's GUI System  0.8.7
RendererModules/Irrlicht/TextureTarget.h
1 /***********************************************************************
2  created: Tue Mar 3 2009
3  author: Paul D Turner (parts based on original code by Thomas Suter)
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 _CEGUIIrrlichtTextureTarget_h_
28 #define _CEGUIIrrlichtTextureTarget_h_
29 
30 #include "CEGUI/RendererModules/Irrlicht/RendererDef.h"
31 #include "../../TextureTarget.h"
32 #include "CEGUI/RendererModules/Irrlicht/RenderTarget.h"
33 #include "../../String.h"
34 
35 #if defined(_MSC_VER)
36 # pragma warning(push)
37 # pragma warning(disable : 4250)
38 #endif
39 
40 // Start of CEGUI namespace section
41 namespace CEGUI
42 {
43 class IrrlichtTexture;
44 
46 class IRR_GUIRENDERER_API IrrlichtTextureTarget : public IrrlichtRenderTarget<TextureTarget>
47 {
48 public:
51  irr::video::IVideoDriver& driver);
54 
55  // overrides from IrrlichtRenderTarget
56  void activate();
57  void deactivate();
58  // implementation of RenderTarget interface
59  bool isImageryCache() const;
60  // implement CEGUI::TextureTarget interface.
61  void clear();
62  Texture& getTexture() const;
63  void declareRenderSize(const Sizef& sz);
64  bool isRenderingInverted() const;
65 
66 protected:
68  static const float DEFAULT_SIZE;
70  static uint s_textureNumber;
73 
76 
78  irr::video::ITexture* d_texture;
81 };
82 
83 #if defined(_MSC_VER)
84 # pragma warning(pop)
85 #endif
86 
87 } // End of CEGUI namespace section
88 
89 #endif // end of guard _CEGUIIrrlichtTextureTarget_h_
CEGUI::IrrlichtTextureTarget::generateTextureName
static String generateTextureName()
helper to generate unique texture names
CEGUI::IrrlichtTextureTarget::isImageryCache
bool isImageryCache() const
Return whether the RenderTarget is an implementation that caches actual rendered imagery.
CEGUI::IrrlichtTextureTarget::DEFAULT_SIZE
static const float DEFAULT_SIZE
default / initial size for the underlying texture.
Definition: RendererModules/Irrlicht/TextureTarget.h:68
CEGUI::IrrlichtTextureTarget::d_CEGUITexture
IrrlichtTexture * d_CEGUITexture
This wraps d_texture so it can be used by the core CEGUI lib.
Definition: RendererModules/Irrlicht/TextureTarget.h:80
CEGUI::IrrlichtTextureTarget::s_textureNumber
static uint s_textureNumber
static data used for creating texture names
Definition: RendererModules/Irrlicht/TextureTarget.h:70
CEGUI
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
CEGUI::IrrlichtTextureTarget::clear
void clear()
Clear the surface of the underlying texture.
CEGUI::IrrlichtTextureTarget
CEGUI::TextureTarget implementation for the Irrlicht engine.
Definition: RendererModules/Irrlicht/TextureTarget.h:47
CEGUI::IrrlichtTextureTarget::d_texture
irr::video::ITexture * d_texture
The irrlicht render target texture we'll be drawing to.
Definition: RendererModules/Irrlicht/TextureTarget.h:78
CEGUI::IrrlichtTextureTarget::activate
void activate()
Activate the render target and put it in a state ready to be drawn to.
CEGUI::Texture
Abstract base class specifying the required interface for Texture objects.
Definition: Texture.h:54
CEGUI::IrrlichtRenderTarget
Intermediate RenderTarget implementing common parts for Irrlicht engine.
Definition: RendererModules/Irrlicht/RenderTarget.h:49
CEGUI::IrrlichtTexture
Implementation of the CEGUI::Texture class for the Irrlicht engine.
Definition: RendererModules/Irrlicht/Texture.h:50
CEGUI::Size< float >
CEGUI::IrrlichtTextureTarget::cleanupTargetTexture
void cleanupTargetTexture()
cleans up the current render target texture used by this object.
CEGUI::String
String class used within the GUI system.
Definition: String.h:64
CEGUI::IrrlichtTextureTarget::~IrrlichtTextureTarget
virtual ~IrrlichtTextureTarget()
Destructor.
CEGUI::IrrlichtTextureTarget::getTexture
Texture & getTexture() const
Return a pointer to the CEGUI::Texture that the TextureTarget is using.
CEGUI::IrrlichtTextureTarget::deactivate
void deactivate()
Deactivate the render target after having completed rendering.
CEGUI::IrrlichtTextureTarget::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::IrrlichtRenderer
CEGUI::Renderer implementation for the Irrlicht engine.
Definition: RendererModules/Irrlicht/Renderer.h:72
CEGUI::IrrlichtTextureTarget::isRenderingInverted
bool isRenderingInverted() const
Return whether rendering done on the target texture is inverted in relation to regular textures.
CEGUI::IrrlichtTextureTarget::IrrlichtTextureTarget
IrrlichtTextureTarget(IrrlichtRenderer &owner, irr::video::IVideoDriver &driver)
Constructor.