Crazy Eddie's GUI System 0.8.7
Loading...
Searching...
No Matches
RendererModules/Ogre/Texture.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 _CEGUIOgreTexture_h_
28#define _CEGUIOgreTexture_h_
29
30#include "../../Texture.h"
31#include "CEGUI/RendererModules/Ogre/Renderer.h"
32#include <OgreTexture.h>
33
34// Start of CEGUI namespace section
35namespace CEGUI
36{
38class OGRE_GUIRENDERER_API OgreTexture : public Texture
39{
40public:
42 void setOgreTexture(Ogre::TexturePtr texture, bool take_ownership = false);
44 Ogre::TexturePtr getOgreTexture() const;
45
47 static Ogre::String getUniqueName();
48
49 // implement CEGUI::Texture interface
50 const String& getName() const;
51 const Sizef& getSize() const;
52 const Sizef& getOriginalDataSize() const;
53 const Vector2f& getTexelScaling() const;
54 void loadFromFile(const String& filename, const String& resourceGroup);
55 void loadFromMemory(const void* buffer, const Sizef& buffer_size,
56 PixelFormat pixel_format);
57 void blitFromMemory(const void* sourceData, const Rectf& area);
58 void blitToMemory(void* targetData);
59 bool isPixelFormatSupported(const PixelFormat fmt) const;
60
62 static Texture::PixelFormat fromOgrePixelFormat(const Ogre::PixelFormat fmt);
64 static Ogre::PixelFormat toOgrePixelFormat(const Texture::PixelFormat fmt);
65
66protected:
67 // we all need a little help from out friends ;)
68 friend Texture& OgreRenderer::createTexture(const String&);
69 friend Texture& OgreRenderer::createTexture(const String&, const String&,
70 const String&);
71 friend Texture& OgreRenderer::createTexture(const String&, const Sizef&);
72 friend Texture& OgreRenderer::createTexture(const String&, Ogre::TexturePtr&,
73 bool);
74 friend void OgreRenderer::destroyTexture(Texture&);
75 friend void OgreRenderer::destroyTexture(const String&);
76
78 OgreTexture(const String& name);
80 OgreTexture(const String& name, const String& filename,
81 const String& resourceGroup);
83 OgreTexture(const String& name, const Sizef& sz);
85 OgreTexture(const String& name, Ogre::TexturePtr& tex, bool take_ownership);
86
87
89 virtual ~OgreTexture();
96
98 static uint32 d_textureNumber;
100 Ogre::TexturePtr d_texture;
111};
112
113} // End of CEGUI namespace section
114
115#endif // end of guard _CEGUIOgreTexture_h_
Implementation of the CEGUI::Texture class for the Ogre engine.
Definition RendererModules/Ogre/Texture.h:39
const Vector2f & getTexelScaling() const
Returns pixel to texel scale values that should be used for converting pixel values to texture co-ord...
static Ogre::String getUniqueName()
return a Ogre::string containing a unique name.
const String d_name
Name this texture was created with.
Definition RendererModules/Ogre/Texture.h:110
Sizef d_dataSize
original pixel of size data loaded into texture
Definition RendererModules/Ogre/Texture.h:106
OgreTexture(const String &name, const String &filename, const String &resourceGroup)
construct texture via an image file.
virtual ~OgreTexture()
destructor.
const Sizef & getOriginalDataSize() const
Returns the original pixel size of the data loaded into the texture.
static Texture::PixelFormat fromOgrePixelFormat(const Ogre::PixelFormat fmt)
convert Ogre::PixelFormat to equivalent CEGUI::Texture::PixelFormat
void freeOgreTexture()
release the underlying Ogre texture.
void loadFromMemory(const void *buffer, const Sizef &buffer_size, PixelFormat pixel_format)
Loads (copies) an image in memory into the texture. The texture is resized as required to hold the im...
void blitToMemory(void *targetData)
Performs a complete blit from the texture surface to memory.
Ogre::TexturePtr getOgreTexture() const
Return Ogre::TexturePtr for the underlying Ogre texture.
static Ogre::PixelFormat toOgrePixelFormat(const Texture::PixelFormat fmt)
convert CEGUI::Texture::PixelFormat to equivalent Ogre::PixelFormat
bool d_isLinked
specifies whether d_texture was created externally (not owned by us).
Definition RendererModules/Ogre/Texture.h:102
OgreTexture(const String &name, const Sizef &sz)
construct texture with a specified initial size.
void blitFromMemory(const void *sourceData, const Rectf &area)
Performs an area memory blit to the texture.
const Sizef & getSize() const
Returns the current pixel size of the texture.
const String & getName() const
Returns the name given to the texture when it was created.
Sizef d_size
Size of the texture.
Definition RendererModules/Ogre/Texture.h:104
OgreTexture(const String &name, Ogre::TexturePtr &tex, bool take_ownership)
construct texture from existing Ogre texture.
void createEmptyOgreTexture(PixelFormat pixel_format)
construct an empty texture
void setOgreTexture(Ogre::TexturePtr texture, bool take_ownership=false)
Set the underlying Ogre texture.
void updateCachedScaleValues()
updates cached scale value used to map pixels to texture co-ords.
void loadFromFile(const String &filename, const String &resourceGroup)
Loads the specified image file into the texture. The texture is resized as required to hold the image...
Vector2f d_texelScaling
cached pixel to texel mapping scale values.
Definition RendererModules/Ogre/Texture.h:108
OgreTexture(const String &name)
standard constructor
static uint32 d_textureNumber
Counter used to provide unique texture names.
Definition RendererModules/Ogre/Texture.h:98
bool isPixelFormatSupported(const PixelFormat fmt) const
Return whether the specified pixel format is supported by the system for the CEGUI::Texture implement...
String class used within the GUI system.
Definition String.h:64
Abstract base class specifying the required interface for Texture objects.
Definition Texture.h:54
PixelFormat
Enumerated type containing the supported pixel formats that can be passed to loadFromMemory.
Definition Texture.h:62
Main namespace for Crazy Eddie's GUI Library.
Definition arch_overview.dox:1