CImageProcessor Class Reference

#include <icl/imageprocessor.h>

class CImageProcessor : public CBase

Inherits from

CImageProcessor

Public Member Functions
pure virtual TBool	FlushPixels()
pure virtual void	PrepareL(CFbsBitmap &, const TRect &)
pure virtual void	PrepareL(CFbsBitmap &, const TRect &, const TSize &)
pure virtual void	SetLineRepeat(TInt)
pure virtual TBool	SetMonoPixel(TInt)
pure virtual TBool	SetMonoPixelBlock(TUint32 *)
pure virtual TBool	SetMonoPixelRun(TInt, TInt)
pure virtual TBool	SetMonoPixels(TUint32 *, TInt)
pure virtual TBool	SetPixel(TRgb)
pure virtual TBool	SetPixelBlock(TRgb *)
pure virtual void	SetPixelPadding(TInt)
pure virtual TBool	SetPixelRun(TRgb, TInt)
pure virtual TBool	SetPixels(TRgb *, TInt)
pure virtual TBool	SetPos(const TPoint &)
pure virtual void	SetYPosIncrement(TInt)

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

Interface to image processing classes used by CImageDecoder plugins. This is not a application client API.

Member Function Documentation

FlushPixels ( )

TBool

FlushPixels

(

)

[pure virtual]

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.

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

PrepareL ( CFbsBitmap &, const TRect & )

void	PrepareL	(	CFbsBitmap &	aBitmap,
			const TRect &	aImageRect
		)	[pure virtual]

Initialises internal data structures prior to conversion.

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

Parameter	Description
aBitmap	A reference to a fully constucted bitmap with the required display mode and size.
aImageRect	The region of the image to convert.

PrepareL ( CFbsBitmap &, const TRect &, const TSize & )

void	PrepareL	(	CFbsBitmap &	aBitmap,
			const TRect &	aImageRect,
			const TSize &	aRgbBlockSize
		)	[pure virtual]

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.

Parameter	Description
aBitmap	A reference to a fully constucted bitmap with the required display mode and size.
aImageRect	The region of the image to convert.
aRgbBlockSize	The size of the block to use.

SetLineRepeat ( TInt )

void

SetLineRepeat

(

TInt

aLineRepeat

)

[pure virtual]

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.

Parameter	Description
aLineRepeat	The number of times the current line should be repeated

SetMonoPixel ( TInt )

TBool

SetMonoPixel

(

TInt

aGray256

)

[pure virtual]

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.

Parameter	Description
aGray256	The greyscale value to set the current pixel to.

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

SetMonoPixelBlock ( TUint32 * )

TBool

SetMonoPixelBlock

(

TUint32 *

aGray256Buffer

)

[pure virtual]

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.

Parameter	Description
aGray256Buffer	A pointer to a buffer representing a block of pixel color values.

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

SetMonoPixelRun ( TInt, TInt )

TBool	SetMonoPixelRun	(	TInt	aGray256,
			TInt	aCount
		)	[pure virtual]

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.

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

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

SetMonoPixels ( TUint32 *, TInt )

TBool	SetMonoPixels	(	TUint32 *	aGray256Buffer,
			TInt	aBufferLength
		)	[pure virtual]

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.

Parameter	Description
aGray256Buffer	A pointer to the first element in the array of greyscale values.
aBufferLength	The number of elements in the array.

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

SetPixel ( TRgb )

TBool

SetPixel

(

TRgb

aColor

)

[pure virtual]

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.

Parameter	Description
aColor	The RGB value to set the current pixel to.

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

SetPixelBlock ( TRgb * )

TBool

SetPixelBlock

(

TRgb *

aColorBuffer

)

[pure virtual]

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.

Parameter	Description
aColorBuffer	A pointer to a buffer representing a block of pixel color values.

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

SetPixelPadding ( TInt )

void

SetPixelPadding

(

TInt

aNumberOfPixels

)

[pure virtual]

Sets the pixel padding to the value specified by aNumberOfPixels.

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

Parameter	Description
aNumberOfPixels	The number of pixels to use for padding.

SetPixelRun ( TRgb, TInt )

TBool	SetPixelRun	(	TRgb	aColor,
			TInt	aCount
		)	[pure virtual]

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.

Parameter	Description
aColor	The RGB value to set the pixels to.
aCount	The number of pixels to set.

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

SetPixels ( TRgb *, TInt )

TBool	SetPixels	(	TRgb *	aColorBuffer,
			TInt	aBufferLength
		)	[pure virtual]

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.

Parameter	Description
aColorBuffer	A pointer to the first element in the array.
aBufferLength	The number of elements in the array.

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

SetPos ( const TPoint & )

TBool

SetPos

(

const TPoint &

aPosition

)

[pure virtual]

Sets the current position in the bitmap to aPosition.

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

Parameter	Description
aPosition	A reference to TPoint object defining the position to move to.

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

SetYPosIncrement ( TInt )

void

SetYPosIncrement

(

TInt

aYInc

)

[pure virtual]

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.

Parameter	Description
aYInc	The number of pixels.