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 String &	getName () const
	Returns the name given to the texture when it was created. More...
const Sizef &	getSize () const
	Returns the current pixel size of the texture. More...
const Sizef &	getOriginalDataSize () const
	Returns the original pixel size of the data loaded into the texture. More...
const Vector2f &	getTexelScaling () 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 Sizef &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	blitFromMemory (const void *sourceData, const Rectf &area)
	Performs an area memory blit to the texture. More...
void	blitToMemory (void *targetData)
	Performs a complete blit from the texture surface to memory. More...
bool	isPixelFormatSupported (const PixelFormat fmt) const
	Return whether the specified pixel format is supported by the system for the CEGUI::Texture implementation. 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.
static Texture::PixelFormat	fromOgrePixelFormat (const Ogre::PixelFormat fmt)
	convert Ogre::PixelFormat to equivalent CEGUI::Texture::PixelFormat
static Ogre::PixelFormat	toOgrePixelFormat (const Texture::PixelFormat fmt)
	convert CEGUI::Texture::PixelFormat to equivalent Ogre::PixelFormat

Protected Member Functions
	OgreTexture (const String &name)
	standard constructor
	OgreTexture (const String &name, const String &filename, const String &resourceGroup)
	construct texture via an image file.
	OgreTexture (const String &name, const Sizef &sz)
	construct texture with a specified initial size.
	OgreTexture (const String &name, 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).
Sizef	d_size
	Size of the texture.
Sizef	d_dataSize
	original pixel of size data loaded into texture
Vector2f	d_texelScaling
	cached pixel to texel mapping scale values.
const String	d_name
	Name this texture was created with.

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

Friends
Texture &	OgreRenderer::createTexture (const String &)
Texture &	OgreRenderer::createTexture (const String &, const String &, const String &)
Texture &	OgreRenderer::createTexture (const String &, const Sizef &)
Texture &	OgreRenderer::createTexture (const String &, Ogre::TexturePtr &, bool)
void	OgreRenderer::destroyTexture (Texture &)
void	OgreRenderer::destroyTexture (const String &)

Additional Inherited Members
Public Types inherited from CEGUI::Texture
enum	PixelFormat {   PF_RGB, PF_RGBA, PF_RGBA_4444, PF_RGB_565,   PF_PVRTC2, PF_PVRTC4, PF_RGB_DXT1, PF_RGBA_DXT1,   PF_RGBA_DXT3, PF_RGBA_DXT5 }
	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

void CEGUI::OgreTexture::blitFromMemory ( const void *  sourceData, const Rectf &  area  )

virtual

Performs an area memory blit to the texture.

Parameters

sourceData	input data, the size must match area described by the given Rect
area	area where the blit will happen

Note

The pixel format must match current Texture's pixel format!

Implements CEGUI::Texture.

void CEGUI::OgreTexture::blitToMemory ( void *  targetData )

virtual

Performs a complete blit from the texture surface to memory.

Parameters

targetData

the buffer where the target is stored

Note

You have to (correctly) preallocate the target buffer!

Implements CEGUI::Texture.

const String& CEGUI::OgreTexture::getName ( ) const

virtual

Returns the name given to the texture when it was created.

Returns

Reference to a String object that holds the name of the texture.

Implements CEGUI::Texture.

const Sizef& 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 Sizef& 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 Vector2f& 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.

bool CEGUI::OgreTexture::isPixelFormatSupported ( const PixelFormat  fmt ) const

virtual

Return whether the specified pixel format is supported by the system for the CEGUI::Texture implementation.

The result of this call will vary according to the implementaion API
and the capabilities of the hardware.

Note

Whether the CEGUI system as a whole will make use of support for any given pixel format will depend upon that format being recognised and supported by both the renderer module implementation and the ImageCodec module that is used to load texture data.

Parameters

fmt	One of the PixelFormat enumerated values specifying the pixel format that is to be tested.

Returns

• true if the specified PixelFormat is supported.
• false if the specified PixelFormat is not supported.

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

filename	The filename of the image file that is to be loaded into the texture
resourceGroup	Resource 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 Sizef &  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

buffer	Pointer to the buffer containing the image data.
buffer_size	Size of the buffer (in pixels as specified by pixelFormat)
pixel_format	PixelFormat value describing the format contained in buffPtr.

Returns

Nothing.

Implements CEGUI::Texture.

Member Data Documentation

uint32 CEGUI::OgreTexture::d_textureNumber

staticprotected

Counter used to provide unique texture names.

The underlying Ogre texture.