Crazy Eddies GUI System  0.7.2
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
CEGUI::OgreTexture Class Reference

Implementation of the CEGUI::Texture class for the Ogre engine. More...

+ Inheritance diagram for CEGUI::OgreTexture:
+ Collaboration diagram for CEGUI::OgreTexture:

Public Member Functions

void setOgreTexture (Ogre::TexturePtr texture, bool take_ownership=false)
 Set the underlying Ogre texture.
 
Ogre::TexturePtr getOgreTexture () const
 Return Ogre::TexturePtr for the underlying Ogre texture.
 
const SizegetSize () const
 Returns the current pixel size of the texture. More...
 
const SizegetOriginalDataSize () const
 Returns the original pixel size of the data loaded into the texture. More...
 
const Vector2getTexelScaling () const
 Returns pixel to texel scale values that should be used for converting pixel values to texture co-ords. More...
 
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. More...
 
void loadFromMemory (const void *buffer, const Size &buffer_size, PixelFormat pixel_format)
 Loads (copies) an image in memory into the texture. The texture is resized as required to hold the image. More...
 
void saveToMemory (void *buffer)
 Save / dump the content of the texture to a memory buffer. The dumped pixel format is always RGBA (4 bytes per pixel). More...
 
- Public Member Functions inherited from CEGUI::Texture
virtual ~Texture ()
 Destructor for Texture base class.
 

Static Public Member Functions

static Ogre::String getUniqueName ()
 return a Ogre::string containing a unique name.
 

Protected Member Functions

 OgreTexture ()
 standard constructor
 
 OgreTexture (const String &filename, const String &resourceGroup)
 construct texture via an image file.
 
 OgreTexture (const Size &sz)
 construct texture with a specified initial size.
 
 OgreTexture (Ogre::TexturePtr &tex, bool take_ownership)
 construct texture from existing Ogre texture.
 
virtual ~OgreTexture ()
 destructor.
 
void freeOgreTexture ()
 release the underlying Ogre texture.
 
void updateCachedScaleValues ()
 updates cached scale value used to map pixels to texture co-ords.
 

Protected Attributes

Ogre::TexturePtr d_texture
 
bool d_isLinked
 specifies whether d_texture was created externally (not owned by us).
 
Size d_size
 Size of the texture.
 
Size d_dataSize
 original pixel of size data loaded into texture
 
Vector2 d_texelScaling
 cached pixel to texel mapping scale values.
 

Static Protected Attributes

static uint32 d_textureNumber
 Counter used to provide unique texture names. More...
 

Friends

TextureOgreRenderer::createTexture ()
 
TextureOgreRenderer::createTexture (const String &, const String &)
 
TextureOgreRenderer::createTexture (const Size &)
 
TextureOgreRenderer::createTexture (Ogre::TexturePtr &, bool)
 
void OgreRenderer::destroyTexture (Texture &)
 

Additional Inherited Members

- Public Types inherited from CEGUI::Texture
enum  PixelFormat { PF_RGB, PF_RGBA }
 Enumerated type containing the supported pixel formats that can be passed to loadFromMemory. More...
 

Detailed Description

Implementation of the CEGUI::Texture class for the Ogre engine.

Member Function Documentation

const Size& CEGUI::OgreTexture::getOriginalDataSize ( ) const
virtual

Returns the original pixel size of the data loaded into the texture.

Returns
reference to a Size object that describes the original size, in pixels, of the data loaded into the texture.

Implements CEGUI::Texture.

const Size& CEGUI::OgreTexture::getSize ( ) const
virtual

Returns the current pixel size of the texture.

Returns
Reference to a Size object that describes the size of the texture in pixels.

Implements CEGUI::Texture.

const Vector2& CEGUI::OgreTexture::getTexelScaling ( ) const
virtual

Returns pixel to texel scale values that should be used for converting pixel values to texture co-ords.

Returns
Reference to a Vector2 object that describes the scaling values required to accurately map pixel positions to texture co-ordinates.

Implements CEGUI::Texture.

void CEGUI::OgreTexture::loadFromFile ( const String filename,
const String resourceGroup 
)
virtual

Loads the specified image file into the texture. The texture is resized as required to hold the image.

Parameters
filenameThe filename of the image file that is to be loaded into the texture
resourceGroupResource group identifier to be passed to the resource provider when loading the image file.
Returns
Nothing.

Implements CEGUI::Texture.

void CEGUI::OgreTexture::loadFromMemory ( const void *  buffer,
const Size buffer_size,
PixelFormat  pixel_format 
)
virtual

Loads (copies) an image in memory into the texture. The texture is resized as required to hold the image.

Parameters
bufferPointer to the buffer containing the image data.
buffer_sizeSize of the buffer (in pixels as specified by pixelFormat)
pixel_formatPixelFormat value describing the format contained in buffPtr.
Returns
Nothing.

Implements CEGUI::Texture.

void CEGUI::OgreTexture::saveToMemory ( void *  buffer)
virtual

Save / dump the content of the texture to a memory buffer. The dumped pixel format is always RGBA (4 bytes per pixel).

Parameters
bufferPointer to the buffer that is to receive the image data. You must make sure that this buffer is large enough to hold the dumped texture data, the required pixel dimensions can be established by calling getSize.

Implements CEGUI::Texture.

Member Data Documentation

uint32 CEGUI::OgreTexture::d_textureNumber
staticprotected

Counter used to provide unique texture names.

The underlying Ogre texture.