Texture class that is created by OgreCEGUIRenderer objects. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/external/ogreceguirenderer/OgreCEGUITexture.h>

Inheritance diagram for CEGUI::OgreCEGUITexture:

Public Member Functions
virtual ushort	getHeight (void) const
	Returns the current pixel height of the texture. More...

Ogre::TexturePtr	getOgreTexture (void) const
	Return a pointer to the internal Ogre::Texture object. More...

virtual ushort	getWidth (void) const
	Returns the current pixel width of the texture. More...

virtual 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...

virtual void	loadFromMemory (const void *buffPtr, uint buffWidth, uint buffHeight, PixelFormat pixelFormat)
	Loads (copies) an image in memory into the texture. The texture is resized as required to hold the image. More...

void	setOgreTexture (Ogre::TexturePtr &texture)
	Set the internal Ogre::TexturePtr object. More...

void	setOgreTextureSize (uint size)
	set the size of the internal Ogre texture. Previous Ogre texture is lost. More...

Private Member Functions
	OgreCEGUITexture (Renderer *owner)

virtual	~OgreCEGUITexture (void)

void	freeOgreTexture (void)

Ogre::String	getUniqueName (void)

Private Attributes
ushort	d_height
	cached height of the texture More...

bool	d_isLinked
	True if we are linked to a texture we did not actually create. More...

Ogre::TexturePtr	d_ogre_texture
	The 'real' texture. More...

ushort	d_width
	cached width of the texture More...

Static Private Attributes
static uint32	d_texturenumber = 0
	Counter used to provide unique texture names. More...

Friends
Texture *	OgreCEGUIRenderer::createTexture (void)

Texture *	OgreCEGUIRenderer::createTexture (const String &filename, const String &resourceGroup)

Texture *	OgreCEGUIRenderer::createTexture (float size)

void	OgreCEGUIRenderer::destroyTexture (Texture *texture)

Detailed Description

Texture class that is created by OgreCEGUIRenderer objects.

Constructor & Destructor Documentation

CEGUI::OgreCEGUITexture::OgreCEGUITexture ( Renderer * owner )

private

CEGUI::OgreCEGUITexture::~OgreCEGUITexture ( void )

privatevirtual

Member Function Documentation

void CEGUI::OgreCEGUITexture::freeOgreTexture ( void )

private

virtual ushort CEGUI::OgreCEGUITexture::getHeight ( void ) const

inlinevirtual

Returns the current pixel height of the texture.

Returns: ushort value that is the current height of the texture in pixels

Ogre::TexturePtr CEGUI::OgreCEGUITexture::getOgreTexture ( void ) const

inline

Return a pointer to the internal Ogre::Texture object.

Returns: Pointer to the Ogre::Texture object currently being used by this Texture object

Ogre::String CEGUI::OgreCEGUITexture::getUniqueName ( void )

private

virtual ushort CEGUI::OgreCEGUITexture::getWidth ( void ) const

inlinevirtual

Returns the current pixel width of the texture.

Returns: ushort value that is the current width of the texture in pixels

void CEGUI::OgreCEGUITexture::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

Returns: Nothing.

void CEGUI::OgreCEGUITexture::loadFromMemory	(	const void *	buffPtr,
		uint	buffWidth,
		uint	buffHeight,
		PixelFormat	pixelFormat
	)

virtual

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

Parameters

buffPtr	Pointer to the buffer containing the image data
buffWidth	Width of the buffer (in pixels as specified by pixelFormat )
buffHeight	Height of the buffer (in pixels as specified by pixelFormat )
pixelFormat	PixelFormat value describing the format contained in buffPtr

Returns: Nothing.

void CEGUI::OgreCEGUITexture::setOgreTexture ( Ogre::TexturePtr & texture )

Set the internal Ogre::TexturePtr object.

Parameters

texture Reference to an Ogre::TexturePtr object that is to be used by this Texture object.

Returns: Nothing.

void CEGUI::OgreCEGUITexture::setOgreTextureSize ( uint size )

set the size of the internal Ogre texture. Previous Ogre texture is lost.

Parameters

size	pixel size of the new internal texture. This will be rounded up to a power of 2.

Returns: Nothing.

Friends And Related Function Documentation

Texture* OgreCEGUIRenderer::createTexture ( void )

friend

Texture* OgreCEGUIRenderer::createTexture	(	const String &	filename,
		const String &	resourceGroup
	)

friend

Texture* OgreCEGUIRenderer::createTexture ( float size )

friend

void OgreCEGUIRenderer::destroyTexture ( Texture * texture )

friend

Member Data Documentation

ushort CEGUI::OgreCEGUITexture::d_height

private

cached height of the texture

bool CEGUI::OgreCEGUITexture::d_isLinked

private

True if we are linked to a texture we did not actually create.

Ogre::TexturePtr CEGUI::OgreCEGUITexture::d_ogre_texture

private

The 'real' texture.

uint32 CEGUI::OgreCEGUITexture::d_texturenumber = 0

staticprivate

Counter used to provide unique texture names.

ushort CEGUI::OgreCEGUITexture::d_width

private

cached width of the texture

The documentation for this class was generated from the following files:

external/ogreceguirenderer/OgreCEGUITexture.h
external/ogreceguirenderer/OgreCEGUITexture.cpp

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation