ImageProcessor::TEffectBorder Class Reference

#include <imageprocessor/imageprocessoreffect.h>

Link against: imageprocessor.lib

class ImageProcessor::TEffectBorder : public ImageProcessor::TEffect

Inherits from

Detailed Description

The class provides functions to insert a border to an image. The border file can be input as File, Buffer or Bitmap.

Member Function Documentation

SetInputL ( const TDesC & )

IMPORT_C voidSetInputL(const TDesC &aFilename)

Specifies the input file for the current Border effect.

Parameters
aFilenameThe file name of the border image.
Leave Codes
KErrNotReadyThe effect is not active.
KErrArgumentThe file name is not correct.

SetInputL ( const TDesC8 & )

IMPORT_C voidSetInputL(const TDesC8 &aBuffer)

Specifies the input buffer for the current Border effect.

Parameters
aBufferThe pointer to the buffer of the border image.
Leave Codes
KErrNotReadyThe effect is not active.
KErrArgumentThe buffer is empty.

SetInputL ( const CFbsBitmap & )

IMPORT_C voidSetInputL(const CFbsBitmap &aBitmap)

Specifies the input bitmap for the current Border effect.

Parameters
aBitmapThe pointer to the bitmap of the border image. The bitmap must have a display mode of EColor16MA.
Leave Codes
KErrNotReadyThe effect is not active.
KErrArgumentThe bitmap is empty, or the bitmap has an unsupported display mode.