ImageProcessor::TOverlay Class Reference

#include <imageprocessor/imageprocessoroverlay.h>

Link against: imageprocessor.lib

class ImageProcessor::TOverlay

Public Member Functions
IMPORT_C TReal32	AngleL()
IMPORT_C void	BeginL()
IMPORT_C void	EndL()
IMPORT_C void	GetScaleL(TReal32 &, TReal32 &)
IMPORT_C TPoint	PositionL()
IMPORT_C void	ResetL()
IMPORT_C void	SetInputL(const TDesC &, const TUid &, const TUid &)
IMPORT_C void	SetInputL(RFile &, const TUid &, const TUid &)
IMPORT_C void	SetInputL(TMMSource &, const TUid &, const TUid &)
IMPORT_C void	SetInputL(const TDesC8 &, const TUid &, const TUid &)
IMPORT_C void	SetInputL(const CFbsBitmap &, const CFbsBitmap *)
IMPORT_C void	SetInputL(const CImageFrame &)
IMPORT_C void	SetL(const TSize &, const TPoint &, TReal32)
IMPORT_C void	SetL(TReal32, TReal32, const TPoint &, TReal32)
IMPORT_C TSize	SizeL()
IMPORT_C void	SupportedInputDisplayModesL(RArray< TDisplayMode > &)
IMPORT_C void	SupportedInputFormatsL(RArray< TUid > &)
IMPORT_C void	SupportedInputImageFrameFormatsL(RArray< TUid > &)
IMPORT_C void	SupportedInputSubFormatsL(TUid, RArray< TUid > &)

Detailed Description

This class provides image overlay functionality.

Before overlay effects are applied, SetInputL should be called to specify the input overlay image.

The overlay effect can be applied by:

Begin overlay by calling BeginL().
Adjust overlay parameters (optional) by calling SetL(aSize, aPosition, aAngle), possibly several times.
Signal final placement of overlay by calling EndL(). Between step 1 and 3, no other effects or operations may be carried out i.e. the overlay has to be concluded/ended before proceeding to apply other effects.

Member Function Documentation

AngleL ( )

IMPORT_C TReal32

AngleL

(

)

const

Gets the angle of the overlay image.

Return Value: The angle of the overlay image.

Leave Codes
Other	A range of system wide error codes.

BeginL ( )

IMPORT_C void

BeginL

(

)

First step of the three stages overlay BeginL()/SetL()/EndL(). The state of the ImageProcessor is set to EEffectActive.

Leave Codes
KErrNotReady	The state of the ImageProcessor is not EInitialized or overlay is already begun.
Other	A range of system wide error codes.

EndL ( )

IMPORT_C void

EndL

(

)

Last step of the three stages overlay BeginL()/SetL()/EndL(). The state of the ImageProcessor is set to EInitialized.

Leave Codes
KErrNotReady
Other	A range of system wide error codes.

GetScaleL ( TReal32 &, TReal32 & )

IMPORT_C void	GetScaleL	(	TReal32 &	aScaleX,
			TReal32 &	aScaleY
		)	const

Gets the scale of the overlay image.

Parameters
aScaleX	The scale of the overlay image width.
aScaleY	The scale of the overlay image height.

Leave Codes
Other	A range of system wide error codes.

PositionL ( )

IMPORT_C TPoint

PositionL

(

)

const

Gets the geometric centre position of the overlay image.

Return Value: The position of the overlay image geometric centre.

Leave Codes
Other	A range of system wide error codes.

ResetL ( )

IMPORT_C void

ResetL

(

)

Resets the overlay parameters and state.

Leave Codes
Other	A range of system wide error codes.

SetInputL ( const TDesC &, const TUid &, const TUid & )

IMPORT_C void	SetInputL	(	const TDesC &	aFilename,
			const TUid &	aFormat = KNullUid,
			const TUid &	aSubFormat = KNullUid
		)

Specifies the file name and format of the overlay image. The input must be set only once and after the BeginL() is done. So, the SetInputL() must be called only once between BeginL() and EndL().

Parameters
aFilename	The file name of the overlay image.
aFormat	The format of the overlay image.
aSubFormat	The sub format of the overlay image. Currently is not supported, shoud set to KNullUid.

Leave Codes
KErrNotReady
KErrNotSupported	The aSubFormat is not NULL.
KErrArgument	The file name length is longer than KMaxFileName.
Other	A range of system wide error codes.

SetInputL ( RFile &, const TUid &, const TUid & )

IMPORT_C void	SetInputL	(	RFile &	aFile,
			const TUid &	aFormat = KNullUid,
			const TUid &	aSubFormat = KNullUid
		)

Specifies the file pointer and format of the overlay image. The input must be set only once and after the BeginL() is done. So, the SetInputL() must be called only once between BeginL() and EndL().

Parameters
aFile	The pointer to the file of the overlay image.
aFormat	The format of the overlay image.
aSubFormat	The sub format of the overlay image. Currently is not supported, shoud set to KNullUid.

Leave Codes
KErrNotSupported	Always. Current this function is not supported.

SetInputL ( TMMSource &, const TUid &, const TUid & )

IMPORT_C void	SetInputL	(	TMMSource &	aDrmFile,
			const TUid &	aFormat = KNullUid,
			const TUid &	aSubFormat = KNullUid
		)

Specifies the file pointer and format of the overlay image which is a DRM protected content source. The input must be set only once and after the BeginL() is done. So, the SetInputL() must be called only once between BeginL() and EndL().

Parameters
aDrmFile	The pointer to the DRM file of the overlay image.
aFormat	The format of the overlay image.
aSubFormat	The sub format of the overlay image. Currently is not supported, shoud set to KNullUid.

Leave Codes
KErrNotSupported	Always. Current this function is not supported.

SetInputL ( const TDesC8 &, const TUid &, const TUid & )

IMPORT_C void	SetInputL	(	const TDesC8 &	aBuffer,
			const TUid &	aFormat = KNullUid,
			const TUid &	aSubFormat = KNullUid
		)

Specifies the buffer pointer and format of the overlay image. The input must be set only once and after the BeginL() is done. So, the SetInputL() must be called only once between BeginL() and EndL().

Parameters
aBuffer	The pointer to the buffer of the overlay image.
aFormat	The format of the overlay image.
aSubFormat	The sub format of the overlay image. Currently is not supported, shoud set to KNullUid.

Leave Codes
KErrNotReady
KErrNotSupported	The aSubFormat is not NULL.
Other	A range of system wide error codes.

SetInputL ( const CFbsBitmap &, const CFbsBitmap * )

IMPORT_C void	SetInputL	(	const CFbsBitmap &	aBitmap,
			const CFbsBitmap *	aMask = NULL
		)

Specifies the bitmap and mask of the overlay image. Source bitmap must not be deleted or changed during lifetime of TOverlay instance. The input must be set only once and after the BeginL() is done. So, the SetInputL() must be called only once between BeginL() and EndL().

Parameters
aBitmap	The pointer to the bitmap of the overlay image.
aMask	The mask of the overlay image. Currently not supported, mush be NULL.

Leave Codes
KErrNotReady
KErrNotSupported	The aMask is not NULL.
Other	A range of system wide error codes.

SetInputL ( const CImageFrame & )

IMPORT_C void

SetInputL

(

const CImageFrame &

aPixelBuffer

)

Specifies the binary image data of the overlay image. Source image frame buffer must not be deleted or changed during lifetime of TOverlay instance. The input must be set only once and after the BeginL() is done. So, the SetInputL() must be called only once between BeginL() and EndL().

Parameters
aPixelBuffer	The CImageFrame type pointer of the overlay image.

Leave Codes
KErrNotReady
Other	A range of system wide error codes.

SetL ( const TSize &, const TPoint &, TReal32 )

IMPORT_C void	SetL	(	const TSize &	aSize,
			const TPoint &	aPosition = TPoint(0, 0),
			TReal32	aAngle = 0
		)

Second step of the three stages overlay BeginL()/SetL()/EndL(). Specifies the size, geometric centre position and angle of the overlay image.

Parameters
aSize	The size of the overlay image.
aPosition	The position of the overlay image geometric centre.
aAngle	The angle of the overlay image.

Leave Codes
KErrNotReady
KErrArgument	Width or height of aSize is less than 0.
KErrArgument	aSize does not preserve aspect ratio and the plugin implementation supports scaling with aspect ratio preserved only.
Other	A range of system wide error codes.

SetL ( TReal32, TReal32, const TPoint &, TReal32 )

IMPORT_C void	SetL	(	TReal32	aScaleX = 1.0,
			TReal32	aScaleY = 1.0,
			const TPoint &	aPosition = TPoint(0, 0),
			TReal32	aAngle = 0
		)

Second step of the three stages overlay BeginL()/SetL()/EndL(). Specifies the scale, geometric centre position and angle of the overlay image.

Parameters
aScaleX	The scale of the overlay image width.
aScaleY	The scale of the overlay image height.
aPosition	The position of the overlay image geometric centre.
aAngle	The angle of the overlay image.

Leave Codes
KErrArgument	Scale is less than 0 or equal to 0
KErrArgument	aScaleX and aScaleY are not equal and the plugin implementation supports scaling with aspect ratio preserved only.
KErrNotReady
Other	A range of system wide error codes.

SizeL ( )

IMPORT_C TSize

SizeL

(

)

const

Gets the size of the overlay image.

Return Value: The size of the overlay image.

Leave Codes
Other	A range of system wide error codes.

SupportedInputDisplayModesL ( RArray< TDisplayMode > & )

IMPORT_C void

SupportedInputDisplayModesL

(

RArray< TDisplayMode > &

aDisplayModes

)

const

Gets the supported overlay image display modes.

Parameters
aDisplayModes	The supported display modes of overlay image of ImageProcessor.

SupportedInputFormatsL ( RArray< TUid > & )

IMPORT_C void

SupportedInputFormatsL

(

RArray< TUid > &

aFormats

)

const

Gets the supported overlay image formats.

Parameters
aFormats	The supported formats of ImageProcessor of the overlay image.

SupportedInputImageFrameFormatsL ( RArray< TUid > & )

IMPORT_C void

SupportedInputImageFrameFormatsL

(

RArray< TUid > &

aFormats

)

const

Gets the supported overlay image frame formats.

Parameters
aFormats	The supported formats of overlay image of ImageProcessor.

SupportedInputSubFormatsL ( TUid, RArray< TUid > & )

IMPORT_C void	SupportedInputSubFormatsL	(	TUid	aFormat,
			RArray< TUid > &	aSubFormats
		)	const

Gets the supported overlay image sub formats.

Parameters
aFormat	The supported format of ImageProcessor of the overlay image.
aSubFormats	The supported sub formats of ImageProcessor of the overlay image.