CImageWriteCodec Class Reference

#include <icl/imagecodec.h>

Link against: imageconversion.lib

class CImageWriteCodec : public CBase

Inherits from

CImageWriteCodec
- CBase

Public Member Functions
	~CImageWriteCodec()
virtual IMPORT_C void	InitFrameL(TBufPtr8 &, const CFbsBitmap &)
pure virtual TFrameState	ProcessFrameL(TBufPtr8 &)
IMPORT_C void	SetSource(const CFbsBitmap *)
IMPORT_C const CFbsBitmap *	Source()

Protected Member Functions
	CImageWriteCodec()
IMPORT_C void	ConstructL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Provides read related processing functions for bitmaps.

Note: For use by plugin writers only.

Constructor & Destructor Documentation

CImageWriteCodec ( )

IMPORT_C

CImageWriteCodec

(

)

[protected]

Default constructor.

~CImageWriteCodec ( )

IMPORT_C

~CImageWriteCodec

(

)

Destructor.

Member Function Documentation

ConstructL ( )

IMPORT_C void

ConstructL

(

)

[protected]

Second phase constructor.

InitFrameL ( TBufPtr8 &, const CFbsBitmap & )

IMPORT_C void	InitFrameL	(	TBufPtr8 &	aDst,
			const CFbsBitmap &	aSource
		)	[virtual]

Performs initial processing of image data from an internally held buffer.

Used to initialise the frame header. The default version of this function does nothing. It should be implemented by the codec, if required.

Parameters
aDst	The destination buffer.
aSource	The source internally held buffer.

ProcessFrameL ( TBufPtr8 & )

TFrameState

ProcessFrameL

(

TBufPtr8 &

aDst

)

[pure virtual]

Processes the frame data contained in aDst.

The internally held buffer must have been previously set, either by InitFrameL() or by a SetSource().

This is a pure virtual function that each derived class must implement.

Parameters
aDst	A reference to the buffer containing the frame data.

Return Value: The current frame state after processing.

SetSource ( const CFbsBitmap * )

IMPORT_C void

SetSource

(

const CFbsBitmap *

aSource

)

Sets the codec's source bitmap.

Use this function if you need to process more than one internally held buffer. This will be necessary if, for example, you need to add a bitmap mask to the destination buffer.

Parameters
aSource	A pointer to the codec's source bitmap.

Source ( )

IMPORT_C const CFbsBitmap *

Source

(

)

const

Returns the codec's source bitmap.

Return Value: A pointer to the codec's source bitmap.