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()Commits the changes made to the current bitmap by flushing the buffer.
• PrepareL(CFbsBitmap &,const TRect &)Initialises internal data structures prior to conversion.
• PrepareL(CFbsBitmap &,const TRect &,const TSize &)Initialises internal data structures prior to the manipulation of the specified ...
• 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
• SetLineRepeat(TInt)Sets the number times the current line should be repeated. The lines are repeate...
• SetMonoPixel(TInt)Sets the pixel at the current position to aGray256.
• SetMonoPixelBlock(TUint32 *)Sets a specified number of pixels to the specified greyscale value.
• SetMonoPixelRun(TInt,TInt)Sets the number of pixels specified by aCount to the value given by aGray256, st...
• SetMonoPixels(TUint32 *,TInt)Updates the bitmap with greyscale information from the array of greyscale values...
• SetPixel(TRgb)Sets the pixel at the current position to aColor.
• SetPixelBlock(TRgb *)Sets the current pixel block using the data supplied in aColorBuffer.
• SetPixelPadding(TInt)Sets the pixel padding to the value specified by aNumberOfPixels.
• SetPixelRun(TRgb,TInt)Sets aCount number of pixels to the value given by aColor, starting at the curre...
• SetPixels(TRgb *,TInt)Updates the bitmap with colour information from the array of colour values.
• SetPos(const TPoint &)Sets the current position in the bitmap to aPosition.
• SetYPosIncrement(TInt)Sets the number of pixels by which to increment the current position in the Y-ax...

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...

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

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

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

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 CImageProcessor::SetYPosIncrement(TInt). This is used to fill blank lines when rendering interlaced images. eg GIF.

Parameters

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

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

Return value

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

Return value

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

Return value

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

Return value

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

Return value

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

Return value

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

Return value

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

Return value

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

Return value

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

private: IMPORT_C virtual void ReservedVirtual1();

Description

Intended for future proofing - will panic if called

Panic codes

private: IMPORT_C virtual void ReservedVirtual2();

Description

Intended for future proofing - will panic if called

Panic codes

private: IMPORT_C virtual void ReservedVirtual3();

Description

Intended for future proofing - will panic if called

Panic codes

private: IMPORT_C virtual void ReservedVirtual4();

Description

Intended for future proofing - will panic if called

Panic codes