Class CImageWriteCodec

class CImageWriteCodec : public CBase;

Description

Provides read related processing functions for bitmaps.

Note: For use by plugin writers only.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CImageWriteCodec - Provides read related processing functions for bitmaps.

Members

Defined in CImageWriteCodec:

• CImageWriteCodec()Default constructor.
• ConstructL()Second phase constructor.
• InitFrameL(TBufPtr8 &,const CFbsBitmap &)Performs initial processing of image data from an internally held buffer.
• ProcessFrameL(TBufPtr8 &)Processes the frame data contained in aDst.
• ReservedVirtual1()Intended for future proofing - will panic if called
• ReservedVirtual2()Intended for future proofing - will panic if called
• ReservedVirtual3()Intended for future proofing - will panic if called
• ReservedVirtual4()Intended for future proofing - will panic if called
• SetSource(const CFbsBitmap *)Sets the codec's source bitmap.
• Source()constReturns the codec's source bitmap.
• ~CImageWriteCodec()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C ~CImageWriteCodec();

Description

Destructor.

protected: IMPORT_C void ConstructL();

Description

Second phase constructor.

protected: IMPORT_C CImageWriteCodec();

Description

Default constructor.

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

Description

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

TBufPtr8 &aDst The destination buffer. const CFbsBitmap &aSource The source internally held buffer.

virtual TFrameState ProcessFrameL(TBufPtr8 &aDst)=0;

Description

Processes the frame data contained in aDst.

The internally held buffer must have been previously set, either by CImageWriteCodec::InitFrameL(TBufPtr8 &,const CFbsBitmap &) or by a CImageWriteCodec::SetSource(const CFbsBitmap *).

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

Parameters

TBufPtr8 &aDst A reference to the buffer containing the frame data.

Return value

TFrameState The current frame state after processing.

IMPORT_C const CFbsBitmap* Source() const;

Description

Returns the codec's source bitmap.

Return value

const CFbsBitmap * A pointer to the codec's source bitmap.

IMPORT_C void SetSource(const CFbsBitmap *aSource);

Description

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

const CFbsBitmap *aSource A pointer to the codec's source bitmap.

private: IMPORT_C virtual void ReservedVirtual1();

Description

Intended for future proofing - will panic if called

Panic codes

EReservedCall

private: IMPORT_C virtual void ReservedVirtual2();

Description

Intended for future proofing - will panic if called

Panic codes

EReservedCall

private: IMPORT_C virtual void ReservedVirtual3();

Description

Intended for future proofing - will panic if called

Panic codes

EReservedCall

private: IMPORT_C virtual void ReservedVirtual4();

Description

Intended for future proofing - will panic if called

Panic codes

EReservedCall