1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
/***********************************************************************
filename: CEGUIIrrlichtRenderer.h
created: Tue Mar 3 2009
author: Paul D Turner (parts based on original code by Thomas Suter)
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUIIrrlichtRenderer_h_
#define _CEGUIIrrlichtRenderer_h_
#include "CEGUIIrrlichtRendererDef.h"
#include "../../CEGUIRenderer.h"
#include "../../CEGUISize.h"
#include "../../CEGUIVector.h"
#include <vector>
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// forward reference irrlicht classes
namespace irr
{
class IrrlichtDevice;
struct SEvent;
namespace video
{
class IVideoDriver;
}
namespace io
{
class IFileSystem;
}
}
// Start of CEGUI namespace section
namespace CEGUI
{
class IrrlichtTexture;
class IrrlichtGeometryBuffer;
class IrrlichtResourceProvider;
class IrrlichtEventPusher;
class IrrlichtImageCodec;
//! CEGUI::Renderer implementation for the Irrlicht engine.
class IRR_GUIRENDERER_API IrrlichtRenderer : public Renderer
{
public:
/*!
\brief
Convenience function that creates all the Irrlicht specific objects and
then initialises the CEGUI system with them.
This will create and initialise the following objects for you:
- CEGUI::IrrlichtRenderer
- CEGUI::IrrlichtResourceProvider
- CEGUI::IrrlichtImageCodec
- CEGUI::System
\param device
Reference to the irr::IrrlichtDevice to be used when creating the
CEGUI::IrrlichtRenderer object.
\return
A reference to the CEGUI::IrrlichtRenderer object that was created.
*/
static IrrlichtRenderer& bootstrapSystem(irr::IrrlichtDevice& device);
/*!
\brief
Convenience function to cleanup the CEGUI system and related objects
that were created by calling the bootstrapSystem function.
This function will destroy the following objects for you:
- CEGUI::System
- CEGUI::IrrlichtImageCodec
- CEGUI::IrrlichtResourceProvider
- CEGUI::IrrlichtRenderer
\note
If you did not initialise CEGUI by calling the bootstrapSystem function,
you should \e not call this, but rather delete any objects you created
manually.
*/
static void destroySystem();
//! Function to create and return IrrlichtRenderer objects
static IrrlichtRenderer& create(irr::IrrlichtDevice& device);
//! Function to destroy IrrlichtRenderer objects.
static void destroy(IrrlichtRenderer& renderer);
//! Create a IrrlichtResourceProvider object.
static IrrlichtResourceProvider&
createIrrlichtResourceProvider(irr::io::IFileSystem& fs);
//! Destroy a IrrlichtResourceProvider object.
static void destroyIrrlichtResourceProvider(IrrlichtResourceProvider& rp);
//! function to create a CEGUI::IrrlichtImageCodec object.
static IrrlichtImageCodec& createIrrlichtImageCodec(
irr::video::IVideoDriver& driver);
//! function to destroy a CEGUI::IrrlichtImageCodec object.
static void destroyIrrlichtImageCodec(IrrlichtImageCodec& ic);
//! inject irrlicht event to CEGUI system
bool injectEvent(const irr::SEvent& event);
/*!
\brief
Helper to return a valid texture size according to device capabilities.
\param sz
Size object containing input size.
\return
Size object containing - possibly different - output size.
*/
Size getAdjustedTextureSize(const Size& sz) const;
/*!
\brief
Utility function that will return \a f if it's a power of two, or the
next power of two up from \a f if it's not.
*/
static float getNextPOTSize(const float f);
// implement Renderer interface
RenderingRoot& getDefaultRenderingRoot();
GeometryBuffer& createGeometryBuffer();
void destroyGeometryBuffer(const GeometryBuffer& buffer);
void destroyAllGeometryBuffers();
TextureTarget* createTextureTarget();
void destroyTextureTarget(TextureTarget* target);
void destroyAllTextureTargets();
Texture& createTexture();
Texture& createTexture(const String& filename, const String& resourceGroup);
Texture& createTexture(const Size& size);
void destroyTexture(Texture& texture);
void destroyAllTextures();
void beginRendering();
void endRendering();
void setDisplaySize(const Size& sz);
const Size& getDisplaySize() const;
const Vector2& getDisplayDPI() const;
uint getMaxTextureSize() const;
const String& getIdentifierString() const;
protected:
//! Constructor
IrrlichtRenderer(irr::IrrlichtDevice& device);
//! Destructor
~IrrlichtRenderer();
//! String holding the renderer identification text.
static String d_rendererID;
//! The IrrlichtDevide that we'll be using.
irr::IrrlichtDevice& d_device;
//! Irrlicht video driver (as obtained from the device)
irr::video::IVideoDriver* d_driver;
//! What the renderer considers to be the current display size.
Size d_displaySize;
//! What the renderer considers to be the current display DPI resolution.
Vector2 d_displayDPI;
//! The default RenderTarget (used by d_defaultRoot)
RenderTarget* d_defaultTarget;
//! The default rendering root object
RenderingRoot* d_defaultRoot;
//! container type used to hold TextureTargets we create.
typedef std::vector<TextureTarget*> TextureTargetList;
//! Container used to track texture targets.
TextureTargetList d_textureTargets;
//! container type used to hold GeometryBuffers we create.
typedef std::vector<IrrlichtGeometryBuffer*> GeometryBufferList;
//! Container used to track geometry buffers.
GeometryBufferList d_geometryBuffers;
//! container type used to hold Textures we create.
typedef std::vector<IrrlichtTexture*> TextureList;
//! Container used to track textures.
TextureList d_textures;
//! What the renderer thinks the max texture size is.
uint d_maxTextureSize;
//! ptr to helper object that aids in injection of events from Irrlicht.
IrrlichtEventPusher* d_eventPusher;
//! true if driver supports non square textures
bool d_supportsNSquareTextures;
//! true if driver supports non power of two textures
bool d_supportsNPOTTextures;
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIIrrlichtRenderer_h_
|
