Class TImageBitmapUtil

class TImageBitmapUtil;

Description

Bitmap utility class.

Members

Defined in TImageBitmapUtil:
Begin(), Begin(), End(), SetBitmapL(), SetPixel(), SetPixels(), SetPos(), TImageBitmapUtil()

IMPORT_C TImageBitmapUtil();

Description

Default constructor for this class.

IMPORT_C void Begin();

Description

Requests a lock for the current bitmap from the font & bitmap server and sets the current position in the bitmap to the first pixel.

IMPORT_C TBool Begin(const TPoint &aPosition);

Description

Requests a lock for the current bitmap from the font & bitmap server and sets the current position in the bitmap to aPosition.

Parameters

const TPoint &aPosition The position to move to.

Return value

TBool A boolean indicating if the position was out of bounds. EFalse if the position was out of bounds, otherwise ETrue.

IMPORT_C void End();

Description

Releases a lock previously acquired using TImageBitmapUtil::Begin().

IMPORT_C void SetBitmapL(CFbsBitmap *aBitmap);

Description

Sets the current bitmap to aBitmap.

Parameters

CFbsBitmap *aBitmap A pointer to the bitmap.

Leave codes

KErrNotFound The bitmap or its handle is NULL or its display mode is not recognised.

IMPORT_C void SetPixel(TUint32 aPixelIndex);

Description

Sets the pixel value at the current bitmap position using aPixelIndex.

Post-Condition

The current position is updated.

Parameters

TUint32 aPixelIndex The pixel index.

IMPORT_C void SetPixels(TUint32 *aPixelIndex, TInt aNumberOfPixels);

Description

Sets an array of pixel values, starting at the current bitmap position using the values supplied in aPixelIndex.

Post-Condition

The current position is updated.

Parameters

TUint32 *aPixelIndex A pointer to the first element in the array. TInt aNumberOfPixels The number of elements in the array.

IMPORT_C TBool SetPos(const TPoint &aPosition);

Description

Sets the current position in the bitmap to aPosition.

Parameters

const TPoint &aPosition The position to move to.

Return value

TBool A boolean indicating if the position was out of bounds. EFalse if the position was out of bounds, otherwise ETrue.