Base class for the image decoders. More...

#include <GUIImageDecoder.h>

Inheritance diagram for CGUIImageDecoder:

[legend]

Classes
struct	SupportedImageTypes_t
	Struct which holds the information about the supported image formats of the decoder. More...

Public Member Functions
virtual	~CGUIImageDecoder ()

eC_TListDoubleLinked< eC_String > &	GetSupportedFileExtensions ()

virtual eC_Bool	LoadImg (CGUIImageData &rkImageData, eC_File *pkImageFile)=0

Protected Member Functions
	CGUIImageDecoder ()

void	WriteConvertedColor (const eC_UInt &uiInputColor, const CGUICommonEnums::ImageType_t &eInputFormat, const CGUICommonEnums::ImageType_t &eOutputFormat, eC_UByte *pubData, eC_UInt &uiDataIndex, const eC_UByte &ubAdvance, const eC_UInt &uiCount=1)

Protected Attributes
eC_TListDoubleLinked< eC_String >	m_kSupportedFileExtensions
	list of supported file-extensions

SupportedImageTypes_t	m_kSupportedImageTypes [cuiNumOfImageTypes]
	Array of supported image types.

Detailed Description

Base class for the image decoders.

All decoder classes must be derived from this class.

Constructor & Destructor Documentation

◆ ~CGUIImageDecoder()

virtual CGUIImageDecoder::~CGUIImageDecoder ( )

virtual

Virtual destructor.

◆ CGUIImageDecoder()

CGUIImageDecoder::CGUIImageDecoder ( )

protected

Constructor of CGUIImageDecoder, which sets all supported image types to False.

Member Function Documentation

◆ GetSupportedFileExtensions()

eC_TListDoubleLinked< eC_String > & CGUIImageDecoder::GetSupportedFileExtensions ( )

Get list of supported file-extensions

Returns: list of extensions

◆ LoadImg()

virtual eC_Bool CGUIImageDecoder::LoadImg	(	CGUIImageData &	rkImageData,
		eC_File *	pkImageFile
	)

pure virtual

Must be implemented in each derived class to decode an image.

Parameters

rkImageData	The decoded image has to be stored here by each derived implementation.
pkImageFile	Pointer to image file to load.

Returns: Implementations must return True if the image was decoded successfully, False if anything went wrong and the contents of kImageData are invalid.

Implemented in CGUIImageDecoderBLU, CGUIImageDecoderBMP, CGUIImageDecoderJPG, CGUIImageDecoderPNG, CGUIImageDecoderRAW, CGUIImageDecoderRLE, CGUIImageDecoderSVG, and CGUIImageDecoderWEBP.

◆ WriteConvertedColor()

void CGUIImageDecoder::WriteConvertedColor	(	const eC_UInt &	uiInputColor,
		const CGUICommonEnums::ImageType_t &	eInputFormat,
		const CGUICommonEnums::ImageType_t &	eOutputFormat,
		eC_UByte *	pubData,
		eC_UInt &	uiDataIndex,
		const eC_UByte &	ubAdvance,
		const eC_UInt &	uiCount = `1`
	)

protected

Convert a color from input-format to output-format and write the result to a given memory location

Parameters

uiInputColor	input-color
eInputFormat	input-format
eOutputFormat	output-format
pubData	pointer to data
uiDataIndex	index of destination location
ubAdvance	number of bytes to advance if there was a conversion error
uiCount	count of data to write (e.g. for RLE)

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

GUIImageDecoder.h

Classes

Public Member Functions

Protected Member Functions

Protected Attributes