Collapse all Symbian^3 Application Developer Library

CImageProcessor Class Reference

class CImageProcessor : public CBase

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

Inherits from

CImageProcessor
- CBase

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

Private Member Functions
IMPORT_C void	ReservedVirtual1 ()
IMPORT_C void	ReservedVirtual2 ()
IMPORT_C void	ReservedVirtual3 ()
IMPORT_C void	ReservedVirtual4 ()

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()

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

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.

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.

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.

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.

ReservedVirtual1()

IMPORT_C void

ReservedVirtual1

(

)

[private, virtual]

Intended for future proofing - will panic if called

panic: EReservedCall

ReservedVirtual2()

IMPORT_C void

ReservedVirtual2

(

)

[private, virtual]

Intended for future proofing - will panic if called

panic: EReservedCall

ReservedVirtual3()

IMPORT_C void

ReservedVirtual3

(

)

[private, virtual]

Intended for future proofing - will panic if called

panic: EReservedCall

ReservedVirtual4()

IMPORT_C void

ReservedVirtual4

(

)

[private, virtual]

Intended for future proofing - will panic if called

panic: EReservedCall

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.

Parameters

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

Parameters

TInt aGray256

The greyscale value to set the current pixel to.

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.

Parameters

TUint32 * aGray256Buffer

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

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.

Parameters

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

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.

Parameters

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

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.

Parameters

TRgb aColor

The RGB value to set the current pixel to.

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.

Parameters

TRgb * aColorBuffer

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

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.

Parameters

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

Parameters

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

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.

Parameters

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

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.

Parameters

const TPoint & aPosition

A reference to TPoint object defining the position to move to.

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.

Parameters

TInt aYInc

The number of pixels.