Class CImageProcessor

class CImageProcessor : public CBase;

Description

Interface to image processing classes.

Derivation

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

• CImageProcessor - Interface to image processing classes

Members

Defined in CImageProcessor:
FlushPixels(), PrepareL(), PrepareL(), ReservedVirtual1(), ReservedVirtual2(), ReservedVirtual3(), ReservedVirtual4(), SetLineRepeat(), SetMonoPixel(), SetMonoPixelBlock(), SetMonoPixelRun(), SetMonoPixels(), SetPixel(), SetPixelBlock(), SetPixelPadding(), SetPixelRun(), SetPixels(), SetPos(), SetYPosIncrement()

Inherited from CBase:
Delete(), Extension_(), operator new()

virtual void PrepareL(CFbsBitmap &aBitmap, const TRect &aImageRect)=0;

Description

Initialises internal data structures prior to conversion.

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

Parameters

CFbsBitmap &aBitmap A reference to a fully constucted bitmap with the required display mode and size. const TRect &aImageRect The region of the image to convert.

virtual void PrepareL(CFbsBitmap &aBitmap, const TRect &aImageRect, const TSize &aRgbBlockSize)=0;

Description

Initialises internal data structures prior to the manipulation of the specified pixel block.

This overloaded version allows specification of a block size for those formats which support blocked pixel data eg. JPEG

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

Parameters

CFbsBitmap &aBitmap A reference to a fully constucted bitmap with the required display mode and size. const TRect &aImageRect The region of the image to convert. const TSize &aRgbBlockSize The size of the block to use.

virtual void SetYPosIncrement(TInt aYInc)=0;

Description

Sets the number of pixels by which to increment the current position in the Y-axis. This is used when rendering images supporting interlacing. eg GIF

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

Parameters

TInt aYInc The number of pixels.

virtual void SetLineRepeat(TInt aLineRepeat)=0;

Description

Sets the number times the current line should be repeated. The lines are repeated in the same direction as set by SetYPosIncrement(). This is used to fill blank lines when rendering interlaced images. eg GIF.

Parameters

TInt aLineRepeat The number of times the current line should be repeated

virtual void SetPixelPadding(TInt aNumberOfPixels)=0;

Description

Sets the pixel padding to the value specified by aNumberOfPixels.

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

Parameters

TInt aNumberOfPixels The number of pixels to use for padding.

virtual TBool SetPixel(TRgb aColor)=0;

Description

Sets the pixel at the current position to aColor.

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

Post-Condition

The current position is updated.

Parameters

TRgb aColor The RGB value to set the current pixel to.

Return value

TBool A boolean indicating if the operation was successful. ETrue if the operation succeeded, otherwise EFalse.

virtual TBool SetPixelRun(TRgb aColor, TInt aCount)=0;

Description

Sets aCount number of pixels to the value given by aColor, starting at the current position.

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

Post-Condition

On success, the current position is updated.

Parameters

TRgb aColor The RGB value to set the pixels to. TInt aCount The number of pixels to set.

Return value

TBool A boolean indicating if the operation was successful. ETrue if the operation succeeded, otherwise EFalse.

virtual TBool SetPixels(TRgb *aColorBuffer, TInt aBufferLength)=0;

Description

Updates the bitmap with colour information from the array of colour values.

Uses the array of colour values supplied by aColorBuffer, whose length is specified by aBufferLength, to update successive pixels with values in the buffer, starting at the current position.

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

Post-Condition

The current position is updated.

Parameters

TRgb *aColorBuffer A pointer to the first element in the array. TInt aBufferLength The number of elements in the array.

Return value

TBool A boolean indicating if the operation was successful. ETrue if the operation succeeded, otherwise EFalse.

virtual TBool SetPixelBlock(TRgb *aColorBuffer)=0;

Description

Sets the current pixel block using the data supplied in aColorBuffer.

Note: For use with image types that support blocking of pixels eg JPEG.

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

Parameters

TRgb *aColorBuffer A pointer to a buffer representing a block of pixel color values.

Return value

TBool A boolean indicating if the operation was successful. ETrue if the operation succeeded, otherwise EFalse.

virtual TBool SetMonoPixel(TInt aGray256)=0;

Description

Sets the pixel at the current position to aGray256.

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

Post-Condition

The current position is updated.

Parameters

TInt aGray256 The greyscale value to set the current pixel to.

Return value

TBool A boolean indicating if the operation was successful. ETrue if the operation succeeded, otherwise EFalse.

virtual TBool SetMonoPixelRun(TInt aGray256, TInt aCount)=0;

Description

Sets the number of pixels specified by aCount to the value given by aGray256, starting at the current position.

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

Post-Condition

The current position is updated.

Parameters

TInt aGray256 The greyscale value to set the pixels to. TInt aCount The number of pixels to set.

Return value

TBool A boolean indicating if the operation was successful. ETrue if the operation succeeded, otherwise EFalse.

virtual TBool SetMonoPixels(TUint32 *aGray256Buffer, TInt aBufferLength)=0;

Description

Updates the bitmap with greyscale information from the array of greyscale values.

The array of values supplied by aGray256Buffer, whose length is specified in aBufferLength, is used to update successive pixels with the greyscales values.

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

Post-Condition

The current position is updated.

Parameters

TUint32 *aGray256Buffer A pointer to the first element in the array of greyscale values. TInt aBufferLength The number of elements in the array.

Return value

TBool A boolean indicating if the operation was successful. ETrue if the operation succeeded, otherwise EFalse.

virtual TBool SetMonoPixelBlock(TUint32 *aGray256Buffer)=0;

Description

Sets a specified number of pixels to the specified greyscale value.

For image types which support blocking of pixels eg JPEG, the current pixel block is set using the data supplied in aGray256Buffer.

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

Parameters

TUint32 *aGray256Buffer A pointer to a buffer representing a block of pixel color values.

Return value

TBool A boolean indicating if the operation was successful. ETrue if the operation succeeded, otherwise EFalse.

virtual TBool SetPos(const TPoint &aPosition)=0;

Description

Sets the current position in the bitmap to aPosition.

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

Parameters

const TPoint &aPosition A reference to TPoint object defining the position to move to.

Return value

TBool A boolean indicating if the operation was successful. ETrue if the operation succeeded, otherwise EFalse.

virtual TBool FlushPixels()=0;

Description

Commits the changes made to the current bitmap by flushing the buffer.

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

Post-Condition

The current position is updated.

Return value

TBool A boolean indicating if the operation was successful. ETrue if the operation succeeded, otherwise EFalse.

private: virtual IMPORT_C void ReservedVirtual1();

Description

Intended for future proofing - will panic if called

Panic codes

EReservedCall

private: virtual IMPORT_C void ReservedVirtual2();

Description

Intended for future proofing - will panic if called

Panic codes

EReservedCall

private: virtual IMPORT_C void ReservedVirtual3();

Description

Intended for future proofing - will panic if called

Panic codes

EReservedCall

private: virtual IMPORT_C void ReservedVirtual4();

Description

Intended for future proofing - will panic if called

Panic codes

EReservedCall