Abstract ImageLoader class. An image loader encapsulate the loading of a texture. More...

Inherits CEGUI::AllocatedObject< ImageCodec >, and CEGUI::AllocatedObject< ImageCodec >.

Inherited by CEGUI::CoronaImageCodec, CEGUI::DevILImageCodec, CEGUI::DevILImageCodec, CEGUI::FreeImageImageCodec, CEGUI::FreeImageImageCodec, CEGUI::IrrlichtImageCodec, CEGUI::IrrlichtImageCodec, CEGUI::OgreImageCodec, CEGUI::OgreImageCodec, CEGUI::PVRImageCodec, CEGUI::SDL2ImageCodec, CEGUI::SILLYImageCodec, CEGUI::SILLYImageCodec, CEGUI::STBImageCodec, CEGUI::TGAImageCodec, and ImageCodec_wrapper.

Collaboration diagram for CEGUI::ImageCodec:

Public Member Functions
virtual	~ImageCodec ()
	Destructor.

const String &	getIdentifierString () const
	Return the name of the image codec object. More...

const String &	getSupportedFormat () const
	Return the list of image file format supported. More...

virtual Texture *	load (const RawDataContainer &data, Texture *result)=0
	Load an image from a memory buffer. More...

virtual	~ImageCodec ()
	Destructor.

const String &	getIdentifierString () const
	Return the name of the image codec object. More...

const String &	getSupportedFormat () const
	Return the list of image file format supported. More...

virtual Texture *	load (const RawDataContainer &data, Texture *result)=0
	Load an image from a memory buffer. More...

Protected Member Functions
	ImageCodec (const String &name)

	ImageCodec (const String &name)

Protected Attributes
String	d_supportedFormat
	list all image file format supported

Detailed Description

Abstract ImageLoader class. An image loader encapsulate the loading of a texture.

This class define the loading of an abstract

Member Function Documentation

◆ getIdentifierString() [1/2]

const String & CEGUI::ImageCodec::getIdentifierString ( ) const

Return the name of the image codec object.

Return the name of the image codec

Returns: a string containing image codec name

Referenced by CEGUI::DirectFBTexture::loadFromFile(), CEGUI::NullTexture::loadFromFile(), CEGUI::OgreTexture::loadFromFile(), CEGUI::IrrlichtTexture::loadFromFile(), CEGUI::Direct3D9Texture::loadFromFile(), CEGUI::Direct3D10Texture::loadFromFile(), CEGUI::Direct3D11Texture::loadFromFile(), CEGUI::OpenGLESTexture::loadFromFile(), CEGUI::OpenGLTexture::loadFromFile(), and CEGUI::System::outputLogHeader().

◆ getIdentifierString() [2/2]

const String& CEGUI::ImageCodec::getIdentifierString ( ) const

Return the name of the image codec object.

Return the name of the image codec

Returns: a string containing image codec name

◆ getSupportedFormat() [1/2]

const String& CEGUI::ImageCodec::getSupportedFormat ( ) const

Return the list of image file format supported.

Return a list of space separated image format supported by this codec

Returns: list of supported image file format separated with space

◆ getSupportedFormat() [2/2]

const String & CEGUI::ImageCodec::getSupportedFormat ( ) const

Return the list of image file format supported.

Return a list of space separated image format supported by this codec

Returns: list of supported image file format separated with space

◆ load() [1/2]

virtual Texture* CEGUI::ImageCodec::load	(	const RawDataContainer &	data,
		Texture *	result
	)

pure virtual

Load an image from a memory buffer.

Parameters

data	the image data
result	the texture to use for storing the image data

Returns: result on success or 0 if the load failed

Implemented in CEGUI::TGAImageCodec, CEGUI::OgreImageCodec, CEGUI::OgreImageCodec, CEGUI::DevILImageCodec, CEGUI::DevILImageCodec, CEGUI::SDL2ImageCodec, CEGUI::SILLYImageCodec, CEGUI::STBImageCodec, CEGUI::SILLYImageCodec, CEGUI::FreeImageImageCodec, CEGUI::FreeImageImageCodec, CEGUI::CoronaImageCodec, CEGUI::IrrlichtImageCodec, CEGUI::IrrlichtImageCodec, and CEGUI::PVRImageCodec.

Referenced by CEGUI::DirectFBTexture::loadFromFile(), CEGUI::NullTexture::loadFromFile(), CEGUI::OgreTexture::loadFromFile(), CEGUI::IrrlichtTexture::loadFromFile(), CEGUI::Direct3D9Texture::loadFromFile(), CEGUI::Direct3D11Texture::loadFromFile(), CEGUI::Direct3D10Texture::loadFromFile(), CEGUI::OpenGLESTexture::loadFromFile(), and CEGUI::OpenGLTexture::loadFromFile().

◆ load() [2/2]

virtual Texture* CEGUI::ImageCodec::load	(	const RawDataContainer &	data,
		Texture *	result
	)